Databricks v1.74.0, Aug 14 25

Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi

databricks.DatabaseSyncedDatabaseTable

Explore with Pulumi AI

Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi

pulumi/pulumi-databricks

Example Usage

Creating a Synced Database Table inside a Database Catalog

This example creates a Synced Database Table inside a Database Catalog.

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  this:
    type: databricks:DatabaseSyncedDatabaseTable
    properties:
      name: my_database_catalog.public.synced_table
      logicalDatabaseName: databricks_postgres
      spec:
        scheduling_policy: SNAPSHOT
        source_table_full_name: source_delta.tpch.customer
        primary_key_columns:
          - c_custkey
        create_database_objects_if_missing: true
        new_pipeline_spec:
          storageCatalog: source_delta
          storageSchema: tpch

Creating a Synced Database Table inside a Standard Catalog

This example creates a Synced Database Table inside a Standard Catalog.

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  this:
    type: databricks:DatabaseSyncedDatabaseTable
    properties:
      name: my_standard_catalog.public.synced_table
      logicalDatabaseName: databricks_postgres
      databaseInstanceName: my-database-instance
      spec:
        scheduling_policy: SNAPSHOT
        source_table_full_name: source_delta.tpch.customer
        primary_key_columns:
          - c_custkey
        create_database_objects_if_missing: true
        new_pipeline_spec:
          storageCatalog: source_delta
          storageSchema: tpch

Creating multiple Synced Database Tables and bin packing them into a single pipeline

This example creates two Synced Database Tables. The first one specifies a new pipeline spec, which generates a new pipeline. The second one utilizes the pipeline ID of the first table.

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  instance:
    type: databricks:DatabaseInstance
    properties:
      name: my-database-instance
      capacity: CU_1
  syncedTable1:
    type: databricks:DatabaseSyncedDatabaseTable
    name: synced_table_1
    properties:
      name: my_standard_catalog.public.synced_table1
      logicalDatabaseName: databricks_postgres
      databaseInstanceName: ${instance.name}
      spec:
        scheduling_policy: SNAPSHOT
        source_table_full_name: source_delta.tpch.customer
        primary_key_columns:
          - c_custkey
        create_database_objects_if_missing: true
        new_pipeline_spec:
          storageCatalog: source_delta
          storageSchema: tpch
  syncedTable2:
    type: databricks:DatabaseSyncedDatabaseTable
    name: synced_table_2
    properties:
      name: my_standard_catalog.public.synced_table2
      logicalDatabaseName: databricks_postgres
      databaseInstanceName: ${instance.name}
      spec:
        scheduling_policy: SNAPSHOT
        source_table_full_name: source_delta.tpch.customer
        primary_key_columns:
          - c_custkey
        create_database_objects_if_missing: true
        existing_pipeline_id: ${syncedTable1.dataSynchronizationStatus.pipelineId}

Create DatabaseSyncedDatabaseTable Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DatabaseSyncedDatabaseTable(name: string, args?: DatabaseSyncedDatabaseTableArgs, opts?: CustomResourceOptions);

@overload
def DatabaseSyncedDatabaseTable(resource_name: str,
                                args: Optional[DatabaseSyncedDatabaseTableArgs] = None,
                                opts: Optional[ResourceOptions] = None)

@overload
def DatabaseSyncedDatabaseTable(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                database_instance_name: Optional[str] = None,
                                logical_database_name: Optional[str] = None,
                                name: Optional[str] = None,
                                spec: Optional[DatabaseSyncedDatabaseTableSpecArgs] = None)

func NewDatabaseSyncedDatabaseTable(ctx *Context, name string, args *DatabaseSyncedDatabaseTableArgs, opts ...ResourceOption) (*DatabaseSyncedDatabaseTable, error)

public DatabaseSyncedDatabaseTable(string name, DatabaseSyncedDatabaseTableArgs? args = null, CustomResourceOptions? opts = null)

public DatabaseSyncedDatabaseTable(String name, DatabaseSyncedDatabaseTableArgs args)
public DatabaseSyncedDatabaseTable(String name, DatabaseSyncedDatabaseTableArgs args, CustomResourceOptions options)

type: databricks:DatabaseSyncedDatabaseTable
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args DatabaseSyncedDatabaseTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DatabaseSyncedDatabaseTableArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DatabaseSyncedDatabaseTableArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DatabaseSyncedDatabaseTableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DatabaseSyncedDatabaseTableArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var databaseSyncedDatabaseTableResource = new Databricks.DatabaseSyncedDatabaseTable("databaseSyncedDatabaseTableResource", new()
{
    DatabaseInstanceName = "string",
    LogicalDatabaseName = "string",
    Name = "string",
    Spec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecArgs
    {
        CreateDatabaseObjectsIfMissing = false,
        ExistingPipelineId = "string",
        NewPipelineSpec = new Databricks.Inputs.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs
        {
            StorageCatalog = "string",
            StorageSchema = "string",
        },
        PrimaryKeyColumns = new[]
        {
            "string",
        },
        SchedulingPolicy = "string",
        SourceTableFullName = "string",
        TimeseriesKey = "string",
    },
});

example, err := databricks.NewDatabaseSyncedDatabaseTable(ctx, "databaseSyncedDatabaseTableResource", &databricks.DatabaseSyncedDatabaseTableArgs{
	DatabaseInstanceName: pulumi.String("string"),
	LogicalDatabaseName:  pulumi.String("string"),
	Name:                 pulumi.String("string"),
	Spec: &databricks.DatabaseSyncedDatabaseTableSpecArgs{
		CreateDatabaseObjectsIfMissing: pulumi.Bool(false),
		ExistingPipelineId:             pulumi.String("string"),
		NewPipelineSpec: &databricks.DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs{
			StorageCatalog: pulumi.String("string"),
			StorageSchema:  pulumi.String("string"),
		},
		PrimaryKeyColumns: pulumi.StringArray{
			pulumi.String("string"),
		},
		SchedulingPolicy:    pulumi.String("string"),
		SourceTableFullName: pulumi.String("string"),
		TimeseriesKey:       pulumi.String("string"),
	},
})

var databaseSyncedDatabaseTableResource = new DatabaseSyncedDatabaseTable("databaseSyncedDatabaseTableResource", DatabaseSyncedDatabaseTableArgs.builder()
    .databaseInstanceName("string")
    .logicalDatabaseName("string")
    .name("string")
    .spec(DatabaseSyncedDatabaseTableSpecArgs.builder()
        .createDatabaseObjectsIfMissing(false)
        .existingPipelineId("string")
        .newPipelineSpec(DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs.builder()
            .storageCatalog("string")
            .storageSchema("string")
            .build())
        .primaryKeyColumns("string")
        .schedulingPolicy("string")
        .sourceTableFullName("string")
        .timeseriesKey("string")
        .build())
    .build());

database_synced_database_table_resource = databricks.DatabaseSyncedDatabaseTable("databaseSyncedDatabaseTableResource",
    database_instance_name="string",
    logical_database_name="string",
    name="string",
    spec={
        "create_database_objects_if_missing": False,
        "existing_pipeline_id": "string",
        "new_pipeline_spec": {
            "storage_catalog": "string",
            "storage_schema": "string",
        },
        "primary_key_columns": ["string"],
        "scheduling_policy": "string",
        "source_table_full_name": "string",
        "timeseries_key": "string",
    })

const databaseSyncedDatabaseTableResource = new databricks.DatabaseSyncedDatabaseTable("databaseSyncedDatabaseTableResource", {
    databaseInstanceName: "string",
    logicalDatabaseName: "string",
    name: "string",
    spec: {
        createDatabaseObjectsIfMissing: false,
        existingPipelineId: "string",
        newPipelineSpec: {
            storageCatalog: "string",
            storageSchema: "string",
        },
        primaryKeyColumns: ["string"],
        schedulingPolicy: "string",
        sourceTableFullName: "string",
        timeseriesKey: "string",
    },
});

type: databricks:DatabaseSyncedDatabaseTable
properties:
    databaseInstanceName: string
    logicalDatabaseName: string
    name: string
    spec:
        createDatabaseObjectsIfMissing: false
        existingPipelineId: string
        newPipelineSpec:
            storageCatalog: string
            storageSchema: string
        primaryKeyColumns:
            - string
        schedulingPolicy: string
        sourceTableFullName: string
        timeseriesKey: string

DatabaseSyncedDatabaseTable Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DatabaseSyncedDatabaseTable resource accepts the following input 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)

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 DatabaseSyncedDatabaseTableSpec

DatabaseInstanceName string

LogicalDatabaseName string

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

Name string

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

Spec DatabaseSyncedDatabaseTableSpecArgs

databaseInstanceName String

logicalDatabaseName String

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

name String

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

spec DatabaseSyncedDatabaseTableSpec

databaseInstanceName string

logicalDatabaseName string

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

name string

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

spec DatabaseSyncedDatabaseTableSpec

database_instance_name str

logical_database_name str

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

name str

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

spec DatabaseSyncedDatabaseTableSpecArgs

databaseInstanceName String

logicalDatabaseName String

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

name String

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

spec Property Map

Outputs

All input properties are implicitly available as output properties. Additionally, the DatabaseSyncedDatabaseTable resource produces the following output properties:

DataSynchronizationStatus DatabaseSyncedDatabaseTableDataSynchronizationStatus: (SyncedTableStatus) - Synced Table data synchronization status
EffectiveDatabaseInstanceName string: (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
EffectiveLogicalDatabaseName string: (string) - The name of the logical database that this table is registered to
Id string: The provider-assigned unique ID for this managed resource.
UnityCatalogProvisioningState string: (string) - 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). Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, UPDATING

DataSynchronizationStatus DatabaseSyncedDatabaseTableDataSynchronizationStatus: (SyncedTableStatus) - Synced Table data synchronization status
EffectiveDatabaseInstanceName string: (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
EffectiveLogicalDatabaseName string: (string) - The name of the logical database that this table is registered to
Id string: The provider-assigned unique ID for this managed resource.
UnityCatalogProvisioningState string: (string) - 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). Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, UPDATING

dataSynchronizationStatus DatabaseSyncedDatabaseTableDataSynchronizationStatus: (SyncedTableStatus) - Synced Table data synchronization status
effectiveDatabaseInstanceName String: (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
effectiveLogicalDatabaseName String: (string) - The name of the logical database that this table is registered to
id String: The provider-assigned unique ID for this managed resource.
unityCatalogProvisioningState String: (string) - 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). Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, UPDATING

dataSynchronizationStatus DatabaseSyncedDatabaseTableDataSynchronizationStatus: (SyncedTableStatus) - Synced Table data synchronization status
effectiveDatabaseInstanceName string: (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
effectiveLogicalDatabaseName string: (string) - The name of the logical database that this table is registered to
id string: The provider-assigned unique ID for this managed resource.
unityCatalogProvisioningState string: (string) - 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). Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, UPDATING

data_synchronization_status DatabaseSyncedDatabaseTableDataSynchronizationStatus: (SyncedTableStatus) - Synced Table data synchronization status
effective_database_instance_name str: (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
effective_logical_database_name str: (string) - The name of the logical database that this table is registered to
id str: The provider-assigned unique ID for this managed resource.
unity_catalog_provisioning_state str: (string) - 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). Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, UPDATING

dataSynchronizationStatus Property Map: (SyncedTableStatus) - Synced Table data synchronization status
effectiveDatabaseInstanceName String: (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
effectiveLogicalDatabaseName String: (string) - The name of the logical database that this table is registered to
id String: The provider-assigned unique ID for this managed resource.
unityCatalogProvisioningState String: (string) - 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). Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, UPDATING

Look up Existing DatabaseSyncedDatabaseTable Resource

Get an existing DatabaseSyncedDatabaseTable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DatabaseSyncedDatabaseTableState, opts?: CustomResourceOptions): DatabaseSyncedDatabaseTable

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_synchronization_status: Optional[DatabaseSyncedDatabaseTableDataSynchronizationStatusArgs] = None,
        database_instance_name: Optional[str] = None,
        effective_database_instance_name: Optional[str] = None,
        effective_logical_database_name: Optional[str] = None,
        logical_database_name: Optional[str] = None,
        name: Optional[str] = None,
        spec: Optional[DatabaseSyncedDatabaseTableSpecArgs] = None,
        unity_catalog_provisioning_state: Optional[str] = None) -> DatabaseSyncedDatabaseTable

func GetDatabaseSyncedDatabaseTable(ctx *Context, name string, id IDInput, state *DatabaseSyncedDatabaseTableState, opts ...ResourceOption) (*DatabaseSyncedDatabaseTable, error)

public static DatabaseSyncedDatabaseTable Get(string name, Input<string> id, DatabaseSyncedDatabaseTableState? state, CustomResourceOptions? opts = null)

public static DatabaseSyncedDatabaseTable get(String name, Output<String> id, DatabaseSyncedDatabaseTableState state, CustomResourceOptions options)

resources:  _:    type: databricks:DatabaseSyncedDatabaseTable    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DataSynchronizationStatus DatabaseSyncedDatabaseTableDataSynchronizationStatus

(SyncedTableStatus) - Synced Table data synchronization status

DatabaseInstanceName string

EffectiveDatabaseInstanceName string

(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

EffectiveLogicalDatabaseName string

(string) - The name of the logical database that this table is registered to

LogicalDatabaseName string

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

Name string

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

Spec DatabaseSyncedDatabaseTableSpec

UnityCatalogProvisioningState string

(string) - 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). Possible values are: ACTIVE, DEGRADED, DELETING, FAILED, PROVISIONING, UPDATING

DataSynchronizationStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusArgs

(SyncedTableStatus) - Synced Table data synchronization status

DatabaseInstanceName string

EffectiveDatabaseInstanceName string

EffectiveLogicalDatabaseName string

(string) - The name of the logical database that this table is registered to

LogicalDatabaseName string

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

Name string

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

Spec DatabaseSyncedDatabaseTableSpecArgs

UnityCatalogProvisioningState string

dataSynchronizationStatus DatabaseSyncedDatabaseTableDataSynchronizationStatus

(SyncedTableStatus) - Synced Table data synchronization status

databaseInstanceName String

effectiveDatabaseInstanceName String

effectiveLogicalDatabaseName String

(string) - The name of the logical database that this table is registered to

logicalDatabaseName String

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

name String

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

spec DatabaseSyncedDatabaseTableSpec

unityCatalogProvisioningState String

dataSynchronizationStatus DatabaseSyncedDatabaseTableDataSynchronizationStatus

(SyncedTableStatus) - Synced Table data synchronization status

databaseInstanceName string

effectiveDatabaseInstanceName string

effectiveLogicalDatabaseName string

(string) - The name of the logical database that this table is registered to

logicalDatabaseName string

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

name string

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

spec DatabaseSyncedDatabaseTableSpec

unityCatalogProvisioningState string

data_synchronization_status DatabaseSyncedDatabaseTableDataSynchronizationStatusArgs

(SyncedTableStatus) - Synced Table data synchronization status

database_instance_name str

effective_database_instance_name str

effective_logical_database_name str

(string) - The name of the logical database that this table is registered to

logical_database_name str

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

name str

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

spec DatabaseSyncedDatabaseTableSpecArgs

unity_catalog_provisioning_state str

dataSynchronizationStatus Property Map

(SyncedTableStatus) - Synced Table data synchronization status

databaseInstanceName String

effectiveDatabaseInstanceName String

effectiveLogicalDatabaseName String

(string) - The name of the logical database that this table is registered to

logicalDatabaseName String

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

name String

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

spec Property Map

unityCatalogProvisioningState String

Supporting Types

DatabaseSyncedDatabaseTableDataSynchronizationStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusArgs

ContinuousUpdateStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus
DetailedState string: (string) - The state of the synced table. Possible values are: SYNCED_TABLED_OFFLINE, SYNCED_TABLE_OFFLINE_FAILED, SYNCED_TABLE_ONLINE, SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE, SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE, SYNCED_TABLE_ONLINE_PIPELINE_FAILED, SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE, SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES, SYNCED_TABLE_PROVISIONING, SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT, SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES
FailedStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus
LastSync DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync: (SyncedTablePosition) - Summary of the last successful synchronization from source to destination.
Message string: (string) - A text description of the current state of the synced table
PipelineId string: (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)
ProvisioningStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus
TriggeredUpdateStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus

ContinuousUpdateStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus
DetailedState string: (string) - The state of the synced table. Possible values are: SYNCED_TABLED_OFFLINE, SYNCED_TABLE_OFFLINE_FAILED, SYNCED_TABLE_ONLINE, SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE, SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE, SYNCED_TABLE_ONLINE_PIPELINE_FAILED, SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE, SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES, SYNCED_TABLE_PROVISIONING, SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT, SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES
FailedStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus
LastSync DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync: (SyncedTablePosition) - Summary of the last successful synchronization from source to destination.
Message string: (string) - A text description of the current state of the synced table
PipelineId string: (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)
ProvisioningStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus
TriggeredUpdateStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus

continuousUpdateStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus
detailedState String: (string) - The state of the synced table. Possible values are: SYNCED_TABLED_OFFLINE, SYNCED_TABLE_OFFLINE_FAILED, SYNCED_TABLE_ONLINE, SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE, SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE, SYNCED_TABLE_ONLINE_PIPELINE_FAILED, SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE, SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES, SYNCED_TABLE_PROVISIONING, SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT, SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES
failedStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus
lastSync DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync: (SyncedTablePosition) - Summary of the last successful synchronization from source to destination.
message String: (string) - A text description of the current state of the synced table
pipelineId String: (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)
provisioningStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus
triggeredUpdateStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus

continuousUpdateStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus
detailedState string: (string) - The state of the synced table. Possible values are: SYNCED_TABLED_OFFLINE, SYNCED_TABLE_OFFLINE_FAILED, SYNCED_TABLE_ONLINE, SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE, SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE, SYNCED_TABLE_ONLINE_PIPELINE_FAILED, SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE, SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES, SYNCED_TABLE_PROVISIONING, SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT, SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES
failedStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus
lastSync DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync: (SyncedTablePosition) - Summary of the last successful synchronization from source to destination.
message string: (string) - A text description of the current state of the synced table
pipelineId string: (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)
provisioningStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus
triggeredUpdateStatus DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus

continuous_update_status DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus
detailed_state str: (string) - The state of the synced table. Possible values are: SYNCED_TABLED_OFFLINE, SYNCED_TABLE_OFFLINE_FAILED, SYNCED_TABLE_ONLINE, SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE, SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE, SYNCED_TABLE_ONLINE_PIPELINE_FAILED, SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE, SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES, SYNCED_TABLE_PROVISIONING, SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT, SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES
failed_status DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus
last_sync DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync: (SyncedTablePosition) - Summary of the last successful synchronization from source to destination.
message str: (string) - A text description of the current state of the synced table
pipeline_id str: (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)
provisioning_status DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus
triggered_update_status DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus

continuousUpdateStatus Property Map
detailedState String: (string) - The state of the synced table. Possible values are: SYNCED_TABLED_OFFLINE, SYNCED_TABLE_OFFLINE_FAILED, SYNCED_TABLE_ONLINE, SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE, SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE, SYNCED_TABLE_ONLINE_PIPELINE_FAILED, SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE, SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES, SYNCED_TABLE_PROVISIONING, SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT, SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES
failedStatus Property Map
lastSync Property Map: (SyncedTablePosition) - Summary of the last successful synchronization from source to destination.
message String: (string) - A text description of the current state of the synced table
pipelineId String: (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)
provisioningStatus Property Map
triggeredUpdateStatus Property Map

DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusArgs

InitialPipelineSyncProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state
LastProcessedCommitVersion int: (integer) - The last source table Delta version that was successfully synced to the synced table
Timestamp string: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

InitialPipelineSyncProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state
LastProcessedCommitVersion int: (integer) - The last source table Delta version that was successfully synced to the synced table
Timestamp string: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

initialPipelineSyncProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state
lastProcessedCommitVersion Integer: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp String: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

initialPipelineSyncProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state
lastProcessedCommitVersion number: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp string: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

initial_pipeline_sync_progress DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state
last_processed_commit_version int: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp str: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

initialPipelineSyncProgress Property Map: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state
lastProcessedCommitVersion Number: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp String: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress, DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgressArgs

EstimatedCompletionTimeSeconds double: (number) - The estimated time remaining to complete this update in seconds
LatestVersionCurrentlyProcessing int: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
ProvisioningPhase string: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
SyncProgressCompletion double: (number) - The completion ratio of this update. This is a number between 0 and 1
SyncedRowCount int: (integer) - The number of rows that have been synced in this update
TotalRowCount int: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

EstimatedCompletionTimeSeconds float64: (number) - The estimated time remaining to complete this update in seconds
LatestVersionCurrentlyProcessing int: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
ProvisioningPhase string: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
SyncProgressCompletion float64: (number) - The completion ratio of this update. This is a number between 0 and 1
SyncedRowCount int: (integer) - The number of rows that have been synced in this update
TotalRowCount int: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimatedCompletionTimeSeconds Double: (number) - The estimated time remaining to complete this update in seconds
latestVersionCurrentlyProcessing Integer: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioningPhase String: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
syncProgressCompletion Double: (number) - The completion ratio of this update. This is a number between 0 and 1
syncedRowCount Integer: (integer) - The number of rows that have been synced in this update
totalRowCount Integer: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimatedCompletionTimeSeconds number: (number) - The estimated time remaining to complete this update in seconds
latestVersionCurrentlyProcessing number: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioningPhase string: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
syncProgressCompletion number: (number) - The completion ratio of this update. This is a number between 0 and 1
syncedRowCount number: (integer) - The number of rows that have been synced in this update
totalRowCount number: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimated_completion_time_seconds float: (number) - The estimated time remaining to complete this update in seconds
latest_version_currently_processing int: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioning_phase str: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
sync_progress_completion float: (number) - The completion ratio of this update. This is a number between 0 and 1
synced_row_count int: (integer) - The number of rows that have been synced in this update
total_row_count int: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimatedCompletionTimeSeconds Number: (number) - The estimated time remaining to complete this update in seconds
latestVersionCurrentlyProcessing Number: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioningPhase String: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
syncProgressCompletion Number: (number) - The completion ratio of this update. This is a number between 0 and 1
syncedRowCount Number: (integer) - The number of rows that have been synced in this update
totalRowCount Number: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatusArgs

LastProcessedCommitVersion int: (integer) - The last source table Delta version that was successfully synced to the synced table
Timestamp string: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

LastProcessedCommitVersion int: (integer) - The last source table Delta version that was successfully synced to the synced table
Timestamp string: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

lastProcessedCommitVersion Integer: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp String: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

lastProcessedCommitVersion number: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp string: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

last_processed_commit_version int: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp str: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

lastProcessedCommitVersion Number: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp String: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table

DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync, DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncArgs

DeltaTableSyncInfo DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo: (DeltaTableSyncInfo)
SyncEndTimestamp string: (string) - The end timestamp of the most recent successful synchronization. This is the time when the data is available in the synced table
SyncStartTimestamp string: (string) - The starting timestamp of the most recent successful synchronization from the source table to the destination (synced) table. Note this is the starting timestamp of the sync operation, not the end time. E.g., for a batch, this is the time when the sync operation started

DeltaTableSyncInfo DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo: (DeltaTableSyncInfo)
SyncEndTimestamp string: (string) - The end timestamp of the most recent successful synchronization. This is the time when the data is available in the synced table
SyncStartTimestamp string: (string) - The starting timestamp of the most recent successful synchronization from the source table to the destination (synced) table. Note this is the starting timestamp of the sync operation, not the end time. E.g., for a batch, this is the time when the sync operation started

deltaTableSyncInfo DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo: (DeltaTableSyncInfo)
syncEndTimestamp String: (string) - The end timestamp of the most recent successful synchronization. This is the time when the data is available in the synced table
syncStartTimestamp String: (string) - The starting timestamp of the most recent successful synchronization from the source table to the destination (synced) table. Note this is the starting timestamp of the sync operation, not the end time. E.g., for a batch, this is the time when the sync operation started

deltaTableSyncInfo DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo: (DeltaTableSyncInfo)
syncEndTimestamp string: (string) - The end timestamp of the most recent successful synchronization. This is the time when the data is available in the synced table
syncStartTimestamp string: (string) - The starting timestamp of the most recent successful synchronization from the source table to the destination (synced) table. Note this is the starting timestamp of the sync operation, not the end time. E.g., for a batch, this is the time when the sync operation started

delta_table_sync_info DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo: (DeltaTableSyncInfo)
sync_end_timestamp str: (string) - The end timestamp of the most recent successful synchronization. This is the time when the data is available in the synced table
sync_start_timestamp str: (string) - The starting timestamp of the most recent successful synchronization from the source table to the destination (synced) table. Note this is the starting timestamp of the sync operation, not the end time. E.g., for a batch, this is the time when the sync operation started

deltaTableSyncInfo Property Map: (DeltaTableSyncInfo)
syncEndTimestamp String: (string) - The end timestamp of the most recent successful synchronization. This is the time when the data is available in the synced table
syncStartTimestamp String: (string) - The starting timestamp of the most recent successful synchronization from the source table to the destination (synced) table. Note this is the starting timestamp of the sync operation, not the end time. E.g., for a batch, this is the time when the sync operation started

DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo, DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfoArgs

DeltaCommitTimestamp string: (string) - The timestamp when the above Delta version was committed in the source Delta table. Note: This is the Delta commit time, not the time the data was written to the synced table
DeltaCommitVersion int: (integer) - The Delta Lake commit version that was last successfully synced

DeltaCommitTimestamp string: (string) - The timestamp when the above Delta version was committed in the source Delta table. Note: This is the Delta commit time, not the time the data was written to the synced table
DeltaCommitVersion int: (integer) - The Delta Lake commit version that was last successfully synced

deltaCommitTimestamp String: (string) - The timestamp when the above Delta version was committed in the source Delta table. Note: This is the Delta commit time, not the time the data was written to the synced table
deltaCommitVersion Integer: (integer) - The Delta Lake commit version that was last successfully synced

deltaCommitTimestamp string: (string) - The timestamp when the above Delta version was committed in the source Delta table. Note: This is the Delta commit time, not the time the data was written to the synced table
deltaCommitVersion number: (integer) - The Delta Lake commit version that was last successfully synced

delta_commit_timestamp str: (string) - The timestamp when the above Delta version was committed in the source Delta table. Note: This is the Delta commit time, not the time the data was written to the synced table
delta_commit_version int: (integer) - The Delta Lake commit version that was last successfully synced

deltaCommitTimestamp String: (string) - The timestamp when the above Delta version was committed in the source Delta table. Note: This is the Delta commit time, not the time the data was written to the synced table
deltaCommitVersion Number: (integer) - The Delta Lake commit version that was last successfully synced

DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusArgs

InitialPipelineSyncProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state

InitialPipelineSyncProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state

initialPipelineSyncProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state

initialPipelineSyncProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state

initial_pipeline_sync_progress DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state

initialPipelineSyncProgress Property Map: (SyncedTablePipelineProgress) - Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state

DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress, DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgressArgs

EstimatedCompletionTimeSeconds double: (number) - The estimated time remaining to complete this update in seconds
LatestVersionCurrentlyProcessing int: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
ProvisioningPhase string: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
SyncProgressCompletion double: (number) - The completion ratio of this update. This is a number between 0 and 1
SyncedRowCount int: (integer) - The number of rows that have been synced in this update
TotalRowCount int: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

EstimatedCompletionTimeSeconds float64: (number) - The estimated time remaining to complete this update in seconds
LatestVersionCurrentlyProcessing int: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
ProvisioningPhase string: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
SyncProgressCompletion float64: (number) - The completion ratio of this update. This is a number between 0 and 1
SyncedRowCount int: (integer) - The number of rows that have been synced in this update
TotalRowCount int: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimatedCompletionTimeSeconds Double: (number) - The estimated time remaining to complete this update in seconds
latestVersionCurrentlyProcessing Integer: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioningPhase String: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
syncProgressCompletion Double: (number) - The completion ratio of this update. This is a number between 0 and 1
syncedRowCount Integer: (integer) - The number of rows that have been synced in this update
totalRowCount Integer: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimatedCompletionTimeSeconds number: (number) - The estimated time remaining to complete this update in seconds
latestVersionCurrentlyProcessing number: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioningPhase string: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
syncProgressCompletion number: (number) - The completion ratio of this update. This is a number between 0 and 1
syncedRowCount number: (integer) - The number of rows that have been synced in this update
totalRowCount number: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimated_completion_time_seconds float: (number) - The estimated time remaining to complete this update in seconds
latest_version_currently_processing int: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioning_phase str: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
sync_progress_completion float: (number) - The completion ratio of this update. This is a number between 0 and 1
synced_row_count int: (integer) - The number of rows that have been synced in this update
total_row_count int: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimatedCompletionTimeSeconds Number: (number) - The estimated time remaining to complete this update in seconds
latestVersionCurrentlyProcessing Number: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioningPhase String: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
syncProgressCompletion Number: (number) - The completion ratio of this update. This is a number between 0 and 1
syncedRowCount Number: (integer) - The number of rows that have been synced in this update
totalRowCount Number: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusArgs

LastProcessedCommitVersion int: (integer) - The last source table Delta version that was successfully synced to the synced table
Timestamp string: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table
TriggeredUpdateProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress: (SyncedTablePipelineProgress) - Progress of the active data synchronization pipeline

LastProcessedCommitVersion int: (integer) - The last source table Delta version that was successfully synced to the synced table
Timestamp string: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table
TriggeredUpdateProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress: (SyncedTablePipelineProgress) - Progress of the active data synchronization pipeline

lastProcessedCommitVersion Integer: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp String: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table
triggeredUpdateProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress: (SyncedTablePipelineProgress) - Progress of the active data synchronization pipeline

lastProcessedCommitVersion number: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp string: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table
triggeredUpdateProgress DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress: (SyncedTablePipelineProgress) - Progress of the active data synchronization pipeline

last_processed_commit_version int: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp str: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table
triggered_update_progress DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress: (SyncedTablePipelineProgress) - Progress of the active data synchronization pipeline

lastProcessedCommitVersion Number: (integer) - The last source table Delta version that was successfully synced to the synced table
timestamp String: (string) - The end timestamp of the last time any data was synchronized from the source table to the synced table. This is when the data is available in the synced table
triggeredUpdateProgress Property Map: (SyncedTablePipelineProgress) - Progress of the active data synchronization pipeline

DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress, DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgressArgs

EstimatedCompletionTimeSeconds double: (number) - The estimated time remaining to complete this update in seconds
LatestVersionCurrentlyProcessing int: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
ProvisioningPhase string: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
SyncProgressCompletion double: (number) - The completion ratio of this update. This is a number between 0 and 1
SyncedRowCount int: (integer) - The number of rows that have been synced in this update
TotalRowCount int: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

EstimatedCompletionTimeSeconds float64: (number) - The estimated time remaining to complete this update in seconds
LatestVersionCurrentlyProcessing int: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
ProvisioningPhase string: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
SyncProgressCompletion float64: (number) - The completion ratio of this update. This is a number between 0 and 1
SyncedRowCount int: (integer) - The number of rows that have been synced in this update
TotalRowCount int: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimatedCompletionTimeSeconds Double: (number) - The estimated time remaining to complete this update in seconds
latestVersionCurrentlyProcessing Integer: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioningPhase String: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
syncProgressCompletion Double: (number) - The completion ratio of this update. This is a number between 0 and 1
syncedRowCount Integer: (integer) - The number of rows that have been synced in this update
totalRowCount Integer: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimatedCompletionTimeSeconds number: (number) - The estimated time remaining to complete this update in seconds
latestVersionCurrentlyProcessing number: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioningPhase string: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
syncProgressCompletion number: (number) - The completion ratio of this update. This is a number between 0 and 1
syncedRowCount number: (integer) - The number of rows that have been synced in this update
totalRowCount number: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimated_completion_time_seconds float: (number) - The estimated time remaining to complete this update in seconds
latest_version_currently_processing int: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioning_phase str: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
sync_progress_completion float: (number) - The completion ratio of this update. This is a number between 0 and 1
synced_row_count int: (integer) - The number of rows that have been synced in this update
total_row_count int: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

estimatedCompletionTimeSeconds Number: (number) - The estimated time remaining to complete this update in seconds
latestVersionCurrentlyProcessing Number: (integer) - The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet
provisioningPhase String: (string) - The current phase of the data synchronization pipeline. Possible values are: PROVISIONING_PHASE_INDEX_SCAN, PROVISIONING_PHASE_INDEX_SORT, PROVISIONING_PHASE_MAIN
syncProgressCompletion Number: (number) - The completion ratio of this update. This is a number between 0 and 1
syncedRowCount Number: (integer) - The number of rows that have been synced in this update
totalRowCount Number: (integer) - The total number of rows that need to be synced in this update. This number may be an estimate

DatabaseSyncedDatabaseTableSpec, DatabaseSyncedDatabaseTableSpecArgs

CreateDatabaseObjectsIfMissing bool

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 DatabaseSyncedDatabaseTableSpecNewPipelineSpec

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 List<string>

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

SchedulingPolicy string

Scheduling policy of the underlying pipeline. Possible values are: CONTINUOUS, SNAPSHOT, TRIGGERED

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

CreateDatabaseObjectsIfMissing bool

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.

NewPipelineSpec DatabaseSyncedDatabaseTableSpecNewPipelineSpec

At most one of existing_pipeline_id and new_pipeline_spec should be defined.

PrimaryKeyColumns []string

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

SchedulingPolicy string

Scheduling policy of the underlying pipeline. Possible values are: CONTINUOUS, SNAPSHOT, TRIGGERED

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

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.

newPipelineSpec DatabaseSyncedDatabaseTableSpecNewPipelineSpec

At most one of existing_pipeline_id and new_pipeline_spec should be defined.

primaryKeyColumns List<String>

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

schedulingPolicy String

Scheduling policy of the underlying pipeline. Possible values are: CONTINUOUS, SNAPSHOT, TRIGGERED

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

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.

newPipelineSpec DatabaseSyncedDatabaseTableSpecNewPipelineSpec

At most one of existing_pipeline_id and new_pipeline_spec should be defined.

primaryKeyColumns string[]

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

schedulingPolicy string

Scheduling policy of the underlying pipeline. Possible values are: CONTINUOUS, SNAPSHOT, TRIGGERED

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

create_database_objects_if_missing bool

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

existing_pipeline_id str

At most one of existing_pipeline_id and new_pipeline_spec should be defined.

new_pipeline_spec DatabaseSyncedDatabaseTableSpecNewPipelineSpec

At most one of existing_pipeline_id and new_pipeline_spec should be defined.

primary_key_columns Sequence[str]

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

scheduling_policy str

Scheduling policy of the underlying pipeline. Possible values are: CONTINUOUS, SNAPSHOT, TRIGGERED

source_table_full_name str

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

timeseries_key str

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

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.

newPipelineSpec Property Map

At most one of existing_pipeline_id and new_pipeline_spec should be defined.

primaryKeyColumns List<String>

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

schedulingPolicy String

Scheduling policy of the underlying pipeline. Possible values are: CONTINUOUS, SNAPSHOT, TRIGGERED

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

DatabaseSyncedDatabaseTableSpecNewPipelineSpec, DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs

StorageCatalog string

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables

StorageSchema string

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables

StorageCatalog string

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables

StorageSchema string

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables

storageCatalog String

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables

storageSchema String

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables

storageCatalog string

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables

storageSchema string

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables

storage_catalog str

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables

storage_schema str

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables

storageCatalog String

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC catalog for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be a standard catalog where the user has permissions to create Delta tables

storageSchema String

This field needs to be specified if the destination catalog is a managed postgres catalog.

UC schema for the pipeline to store intermediate files (checkpoints, event logs etc). This needs to be in the standard catalog where the user has permissions to create Delta tables

Import

As of Pulumi v1.5, resources can be imported through configuration.

hcl

import {

id = name

to = databricks_database_synced_database_table.this

}

If you are using an older version of Pulumi, import the resource using the pulumi import command as follows:

$ pulumi import databricks:index/databaseSyncedDatabaseTable:DatabaseSyncedDatabaseTable databricks_database_synced_database_table name

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi

pulumi/pulumi-databricks

databricks.DatabaseSyncedDatabaseTable

On this page

On this page

Example Usage

Creating a Synced Database Table inside a Database Catalog

Creating a Synced Database Table inside a Standard Catalog

Creating multiple Synced Database Tables and bin packing them into a single pipeline

Create DatabaseSyncedDatabaseTable Resource

Constructor syntax

Parameters

Constructor example

DatabaseSyncedDatabaseTable Resource Properties

Inputs

Outputs

Look up Existing DatabaseSyncedDatabaseTable Resource

Supporting Types

DatabaseSyncedDatabaseTableDataSynchronizationStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusArgs

DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusArgs

DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgress, DatabaseSyncedDatabaseTableDataSynchronizationStatusContinuousUpdateStatusInitialPipelineSyncProgressArgs

DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusFailedStatusArgs

DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSync, DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncArgs

DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfo, DatabaseSyncedDatabaseTableDataSynchronizationStatusLastSyncDeltaTableSyncInfoArgs

DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusArgs

DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgress, DatabaseSyncedDatabaseTableDataSynchronizationStatusProvisioningStatusInitialPipelineSyncProgressArgs

DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatus, DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusArgs

DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgress, DatabaseSyncedDatabaseTableDataSynchronizationStatusTriggeredUpdateStatusTriggeredUpdateProgressArgs

DatabaseSyncedDatabaseTableSpec, DatabaseSyncedDatabaseTableSpecArgs

DatabaseSyncedDatabaseTableSpecNewPipelineSpec, DatabaseSyncedDatabaseTableSpecNewPipelineSpecArgs

Import

Package Details

On this page

On this page