Skip to main content

postgres_cdf_statuses

Creates, updates, deletes, gets or lists a postgres_cdf_statuses resource.

Overview

Namepostgres_cdf_statuses
TypeResource
Iddatabricks_workspace.postgres.postgres_cdf_statuses

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringOutput only. The full resource name of the CdfStatus. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status} The {cdf_status} segment is the Postgres table name.
committed_lsnstringThe high-watermark Log Sequence Number (LSN) committed to Delta Lake.
create_timestring (date-time)When replication for this table was first established.
last_sync_timestring (date-time)The last time changes for this table were written to Delta Lake.
postgres_tablestringThe Postgres table being replicated.
statestringThe current replication state of this table. (CDF_STATE_SKIPPED, CDF_STATE_SNAPSHOTTING, CDF_STATE_STREAMING, CDF_STATE_TERMINATED)
status_detailstringHuman-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states.
uc_tablestringThe Unity Catalog table receiving replicated data.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectparent, deployment_namepage_size, page_tokenList the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
deployment_namestringThe Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
parentstringThe parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
page_sizeintegerMaximum number of CdfStatuses to return.
page_tokenstringPagination token returned by a previous ListCdfStatuses call. Empty on the first page.

SELECT examples

List the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a

SELECT
name,
committed_lsn,
create_time,
last_sync_time,
postgres_table,
state,
status_detail,
uc_table
FROM databricks_workspace.postgres.postgres_cdf_statuses
WHERE parent = '{{ parent }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;