Databricks SDK for JavaScript
    Preparing search index...

    Interface SyncedDatabaseTable

    interface SyncedDatabaseTable {
        databaseInstanceName?: string;
        dataSynchronizationStatus?: SyncedTableStatus;
        effectiveDatabaseInstanceName?: string;
        effectiveLogicalDatabaseName?: string;
        logicalDatabaseName?: string;
        name?: string;
        spec?: SyncedTableSpec;
        unityCatalogProvisioningState?: ProvisioningInfo_State;
    }
    Index

    Properties

    databaseInstanceName? dataSynchronizationStatus? effectiveDatabaseInstanceName? effectiveLogicalDatabaseName? logicalDatabaseName? name? spec? unityCatalogProvisioningState?

    Properties

    databaseInstanceName?: string

    Name of the target database instance. This is required when creating synced database tables in standard catalogs. This is optional when creating synced database tables in registered catalogs. If this field is specified when creating synced database tables in registered catalogs, the database instance name MUST match that of the registered catalog (or the request will be rejected).

    dataSynchronizationStatus?: SyncedTableStatus

    Synced Table data synchronization status

    effectiveDatabaseInstanceName?: string

    The name of the database instance that this table is registered to. This field is always returned, and for tables inside database catalogs is inferred database instance associated with the catalog. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    effectiveLogicalDatabaseName?: string

    The name of the logical database that this table is registered to. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value.

    logicalDatabaseName?: string

    Target Postgres database object (logical database) name for this table.

    When creating a synced table in a registered Postgres catalog, the target Postgres database name is inferred to be that of the registered catalog. If this field is specified in this scenario, the Postgres database name MUST match that of the registered catalog (or the request will be rejected).

    When creating a synced table in a standard catalog, this field is required. In this scenario, specifying this field will allow targeting an arbitrary postgres database. Note that this has implications for the create_database_objects_is_missing field in spec.

    name?: string

    Full three-part (catalog, schema, table) name of the table.

    spec?: SyncedTableSpec
    unityCatalogProvisioningState?: ProvisioningInfo_State

    The provisioning state of the synced table entity in Unity Catalog. This is distinct from the state of the data synchronization pipeline (i.e. the table may be in "ACTIVE" but the pipeline may be in "PROVISIONING" as it runs asynchronously).

    Settings

    Member Visibility

    On This Page

    Properties