Databricks SDK for JavaScript
    Preparing search index...

    Interface SyncedTableSpec

    Specification of a synced database table.

    interface SyncedTableSpec {
        acceleratedSync?: boolean;
        createDatabaseObjectsIfMissing?: boolean;
        existingPipelineId?: string;
        newPipelineSpec?: NewPipelineSpec;
        primaryKeyColumns?: string[];
        schedulingPolicy?: SyncedTableSchedulingPolicy;
        sourceTableFullName?: string;
        timeseriesKey?: string;
        typeOverrides?: SyncedTableSpec_TypeOverride[];
    }
    Index

    Properties

    acceleratedSync? createDatabaseObjectsIfMissing? existingPipelineId? newPipelineSpec? 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.

    createDatabaseObjectsIfMissing?: boolean

    If true, the synced table's logical database and schema resources in PG will be created if they do not already exist.

    existingPipelineId?: string

    At most one of existing_pipeline_id and new_pipeline_spec should be defined.

    If existing_pipeline_id is defined, the synced table will be bin packed into the existing pipeline referenced. This avoids creating a new pipeline and allows sharing existing compute. In this case, the scheduling_policy of this synced table must match the scheduling policy of the existing pipeline.

    newPipelineSpec?: NewPipelineSpec

    At most one of existing_pipeline_id and new_pipeline_spec should be defined.

    If new_pipeline_spec is defined, a new pipeline is created for this synced table. The location pointed to is used to store intermediate files (checkpoints, event logs etc). The caller must have write permissions to create Delta tables in the specified catalog and schema. Again, note this requires write permissions, whereas the source table only requires read permissions.

    primaryKeyColumns?: string[]

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

    schedulingPolicy?: SyncedTableSchedulingPolicy

    Scheduling policy of the underlying pipeline.

    sourceTableFullName?: string

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

    timeseriesKey?: string

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

    typeOverrides?: 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