postgres_cdf_statuses
Creates, updates, deletes, gets or lists a postgres_cdf_statuses resource.
Overview
| Name | postgres_cdf_statuses |
| Type | Resource |
| Id | databricks_workspace.postgres.postgres_cdf_statuses |
Fields
The following fields are returned by SELECT queries:
- list
| Name | Datatype | Description |
|---|---|---|
name | string | Output 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_lsn | string | The high-watermark Log Sequence Number (LSN) committed to Delta Lake. |
create_time | string (date-time) | When replication for this table was first established. |
last_sync_time | string (date-time) | The last time changes for this table were written to Delta Lake. |
postgres_table | string | The Postgres table being replicated. |
state | string | The current replication state of this table. (CDF_STATE_SKIPPED, CDF_STATE_SNAPSHOTTING, CDF_STATE_STREAMING, CDF_STATE_TERMINATED) |
status_detail | string | Human-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states. |
uc_table | string | The Unity Catalog table receiving replicated data. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | parent, deployment_name | page_size, page_token | List 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.
| Name | Datatype | Description |
|---|---|---|
deployment_name | string | The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc) |
parent | string | The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config} |
page_size | integer | Maximum number of CdfStatuses to return. |
page_token | string | Pagination token returned by a previous ListCdfStatuses call. Empty on the first page. |
SELECT examples
- list
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 }}'
;