Databricks SDK for JavaScript
    Preparing search index...

    Interface StartUpdateRequest

    interface StartUpdateRequest {
        cause?: UpdateCause;
        fullRefresh?: boolean;
        fullRefreshSelection?: string[];
        parameters?: Record<string, string>;
        pipelineId?: string;
        refreshSelection?: string[];
        replaceWhereOverrides?: ReplaceWhereOverride[];
        resetCheckpointSelection?: string[];
        rewindSpec?: RewindSpec;
        validateOnly?: boolean;
    }
    Index

    Properties

    cause? fullRefresh? fullRefreshSelection? parameters? pipelineId? refreshSelection? replaceWhereOverrides? resetCheckpointSelection? rewindSpec? validateOnly?

    Properties

    cause?: UpdateCause
    fullRefresh?: boolean

    If true, this update will reset all tables before running.

    fullRefreshSelection?: string[]

    A list of tables to update with fullRefresh. If both refresh_selection and full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means that the states of the table will be reset before the refresh.

    parameters?: Record<string, string>

    Key/value map of parameters to pass to the pipeline execution

    pipelineId?: string
    refreshSelection?: string[]

    A list of tables to update without fullRefresh. If both refresh_selection and full_refresh_selection are empty, this is a full graph update. Full Refresh on a table means that the states of the table will be reset before the refresh.

    replaceWhereOverrides?: ReplaceWhereOverride[]

    A list of predicate overrides for replace_where flows in this update. Only replace_where flows may be specified. Flows not listed use their original predicate.

    resetCheckpointSelection?: string[]

    A list of flows for which this update should reset the streaming checkpoint. This selection will not clear the data in the flow's target table. Flows in this list may also appear in refresh_selection and full_refresh_selection.

    rewindSpec?: RewindSpec

    The information about the requested rewind operation. If specified this is a rewind mode update.

    validateOnly?: boolean

    If true, this update only validates the correctness of pipeline source code but does not materialize or publish any datasets.

    Settings

    Member Visibility

    On This Page

    Properties