Databricks SDK for JavaScript
    Preparing search index...

    Interface OnlineTableSpec

    Specification of an online table.

    interface OnlineTableSpec {
        performFullCopy?: boolean;
        pipelineId?: string;
        primaryKeyColumns?: string[];
        schedulingPolicy?:
            | {
                $case: "runContinuously";
                runContinuously: OnlineTableSpec_ContinuousSchedulingPolicy;
            }
            | {
                $case: "runTriggered";
                runTriggered: OnlineTableSpec_TriggeredSchedulingPolicy;
            };
        sourceTableFullName?: string;
        timeseriesKey?: string;
    }
    Index

    Properties

    performFullCopy? pipelineId? primaryKeyColumns? schedulingPolicy? sourceTableFullName? timeseriesKey?

    Properties

    performFullCopy?: boolean

    Whether to create a full-copy pipeline -- a pipeline that stops after creates a full copy of the source table upon initialization and does not process any change data feeds (CDFs) afterwards. The pipeline can still be manually triggered afterwards, but it always perform a full copy of the source table and there are no incremental updates. This mode is useful for syncing views or tables without CDFs to online tables. Note that the full-copy pipeline only supports "triggered" scheduling policy.

    pipelineId?: string

    ID of the associated pipeline. Generated by the server - cannot be set by the caller.

    primaryKeyColumns?: string[]

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

    schedulingPolicy?:
        | {
            $case: "runContinuously";
            runContinuously: OnlineTableSpec_ContinuousSchedulingPolicy;
        }
        | {
            $case: "runTriggered";
            runTriggered: OnlineTableSpec_TriggeredSchedulingPolicy;
        }

    Exactly one type of scheduling policy should be applied.

    Type Declaration

    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.

    Settings

    Member Visibility

    On This Page

    Properties