Cdf Status

View as Markdown

The read-only replication status of a single Postgres table replicated under a CdfConfig. One status exists per replicated table. It is created automatically and cannot be modified.

Get a change data feed statusGET /api/2.0/postgres/{name=projects/*/branches/*/databases/*/cdf-configs/*/cdf-statuses/*}List change data feed statusesGET /api/2.0/postgres/{parent=projects/*/branches/*/databases/*/cdf-configs/*}/cdf-statuses

CdfStatus object

The read-only replication status of a single Postgres table replicated under a CdfConfig. One status exists per replicated table. It is created automatically and cannot be modified.

namestringBetaIDImmutable

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.

postgres_tablestringBetaOutput only

The Postgres table being replicated.

uc_tablestringBetaOutput only

The Unity Catalog table receiving replicated data.

statestringBetaOutput only

The current replication state of this table.

Values:

• CDF_STATE_UNSPECIFIED
• CDF_STATE_SNAPSHOTTING
• CDF_STATE_STREAMING
• CDF_STATE_TERMINATED
• CDF_STATE_SKIPPED

committed_lsnstringBetaOutput only

The high-watermark Log Sequence Number (LSN) committed to Delta Lake.

last_sync_timestringBetaOutput only

The last time changes for this table were written to Delta Lake.

create_timestringBetaOutput only

When replication for this table was first established.

status_detailstringBetaOutput only

Human-readable detail for the current state (e.g. the skip/error reason). Empty for healthy states.

View as Markdown

The CdfStatus object

{
  "name": "string",
  "postgres_table": "string",
  "uc_table": "string",
  "state": "CDF_STATE_SNAPSHOTTING",
  "committed_lsn": "string",
  "last_sync_time": "string",
  "create_time": "string",
  "status_detail": "string"
}

Get a change data feed status Beta

GET /api/2.0/postgres/{name=projects/*/branches/*/databases/*/cdf-configs/*/cdf-statuses/*}

Get the CDF status of a single table within a Lakebase CDF configuration, including its current state and the last committed position in the feed.

API scopes: postgres

Parameters

namestringRequiredpath

The resource name of the CdfStatus to retrieve. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}

Response

Returns the CdfStatus object.

View as Markdown

Response

{
  "name": "string",
  "postgres_table": "string",
  "uc_table": "string",
  "state": "CDF_STATE_SNAPSHOTTING",
  "committed_lsn": "string",
  "last_sync_time": "string",
  "create_time": "string",
  "status_detail": "string"
}

List change data feed statuses Beta

GET /api/2.0/postgres/{parent=projects/*/branches/*/databases/*/cdf-configs/*}/cdf-statuses

List the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a table's change data feed is snapshotting, streaming, or skipped.

API scopes: postgres

Parameters

parentstringRequiredpath

The parent CdfConfig to list CdfStatuses for. Format: projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}

page_sizeint32query

Maximum number of CdfStatuses to return.

page_tokenstringquery

Pagination token returned by a previous ListCdfStatuses call. Empty on the first page.

Response

Returns a list of CdfStatus objects.

View as Markdown

Response

{
  "cdf_statuses": [
    {
      "name": "string",
      "postgres_table": "string",
      "uc_table": "string",
      "state": "CDF_STATE_SNAPSHOTTING",
      "committed_lsn": "string",
      "last_sync_time": "string",
      "create_time": "string",
      "status_detail": "string"
    }
  ],
  "next_page_token": "string"
}