Databricks SDK for JavaScript
    Preparing search index...

    Interface SyncedTable_SyncedTableSpec

    interface SyncedTable_SyncedTableSpec {
        acceleratedSync?: boolean;
        branch?: string;
        createDatabaseObjectsIfMissing?: boolean;
        existingPipelineId?: string;
        newPipelineSpec?: NewPipelineSpec;
        postgresDatabase?: string;
        primaryKeyColumns?: string[];
        schedulingPolicy?: SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy;
        sourceTableFullName?: string;
        timeseriesKey?: string;
        typeOverrides?: SyncedTable_SyncedTableSpec_TypeOverride[];
    }
    Index

    Properties

    acceleratedSync? branch? createDatabaseObjectsIfMissing? existingPipelineId? newPipelineSpec? postgresDatabase? primaryKeyColumns? schedulingPolicy? sourceTableFullName? timeseriesKey? typeOverrides?

    Properties

    acceleratedSync?: boolean

    When true, enables accelerated sync mode for the initial data load. This significantly improves performance for large tables. Requires workspace-level enablement through Lakebase Accelerated Sync preview.

    branch?: string

    The full resource name the branch associated with the table.

    Format: "projects/{project_id}/branches/{branch_id}".

    createDatabaseObjectsIfMissing?: boolean

    If true, the synced table's logical database and schema resources in PG will be created if they do not already exist. The request will fail if this is false and the database/schema do not exist.

    Defaults to true if omitted.

    existingPipelineId?: string

    ID of an existing pipeline to bin-pack this synced table into. At most one of existing_pipeline_id and new_pipeline_spec should be defined.

    The pipeline used for the synced table is returned via the top level pipeline_id attribute.

    newPipelineSpec?: NewPipelineSpec

    Specification for creating a new pipeline. At most one of existing_pipeline_id and new_pipeline_spec should be defined.

    The pipeline used for the synced table is returned via the top level pipeline_id attribute.

    postgresDatabase?: string

    The Postgres database name where the synced table will be created in.

    If this synced table is created inside a Lakebase Catalog, this attribute can be omitted on creation and is inferred from the postgres_database associated with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the value must match.

    A value must be specified when creating a synced table inside a Standard Catalog.

    primaryKeyColumns?: string[]

    Primary Key columns to be used for data insert/update in the destination.

    schedulingPolicy?: SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy

    Scheduling policy of the underlying pipeline.

    sourceTableFullName?: string

    Three-part (catalog, schema, table) name of the source Delta table.

    For the corresponding destination table, use any of the two:

    • synced_table_id used at the creation of the SyncedTable
    • "name" consisting of "synced_tables/" prefix and the full name of the destination table.
    timeseriesKey?: string

    Time series key to deduplicate (tie-break) rows with the same primary key.

    typeOverrides?: SyncedTable_SyncedTableSpec_TypeOverride[]

    Override the default Delta->PG type mapping for specific columns. A TypeOverride with PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid pg_type must be set.

    Settings

    Member Visibility

    On This Page

    Properties