Databricks SDK for JavaScript
    Preparing search index...

    Interface SyncedTableStatus

    Status of a synced table.

    interface SyncedTableStatus {
        detailedState?: SyncedTableState;
        detailedStatus?:
            | {
                $case: "provisioningStatus";
                provisioningStatus: SyncedTableProvisioningStatus;
            }
            | {
                $case: "continuousUpdateStatus";
                continuousUpdateStatus: SyncedTableContinuousUpdateStatus;
            }
            | {
                $case: "triggeredUpdateStatus";
                triggeredUpdateStatus: SyncedTableTriggeredUpdateStatus;
            }
            | { $case: "failedStatus"; failedStatus: SyncedTableFailedStatus };
        lastSync?: SyncedTablePosition;
        message?: string;
        pipelineId?: string;
    }
    Index

    Properties

    detailedState? detailedStatus? lastSync? message? pipelineId?

    Properties

    detailedState?: SyncedTableState

    The state of the synced table.

    detailedStatus?:
        | {
            $case: "provisioningStatus";
            provisioningStatus: SyncedTableProvisioningStatus;
        }
        | {
            $case: "continuousUpdateStatus";
            continuousUpdateStatus: SyncedTableContinuousUpdateStatus;
        }
        | {
            $case: "triggeredUpdateStatus";
            triggeredUpdateStatus: SyncedTableTriggeredUpdateStatus;
        }
        | { $case: "failedStatus"; failedStatus: SyncedTableFailedStatus }

    The detailed status based on the synced table state.

    lastSync?: SyncedTablePosition

    Summary of the last successful synchronization from source to destination.

    Will always be present if there has been a successful sync. Even if the most recent syncs have failed.

    Limitation: The only exception is if the synced table is doing a FULL REFRESH, then the last sync information will not be available until the full refresh is complete. This limitation will be addressed in a future version.

    This top-level field is a convenience for consumers who want easy access to last sync information without having to traverse detailed_status.

    message?: string

    A text description of the current state of the synced table.

    pipelineId?: string

    ID of the associated pipeline. The pipeline ID may have been provided by the client (in the case of bin packing), or generated by the server (when creating a new pipeline).

    Settings

    Member Visibility

    On This Page

    Properties