cdc_status()#

relationalai.app
#cdc_status()

A procedure that retrieves the current status and other details of the CDC Service. Requires the cdc_admin application role.

Parameters#

None.

Returns#

A table with the following columns:

ColumnTypeDescription
CDC_ENABLEDBOOLEANWhether the CDC service is enabled.
CDC_ENGINE_NAMESTRINGThe name of the current CDC engine. NULL if CDC is disabled.
CDC_ENGINE_STATUSSTRINGThe status of the CDC engine. May be one of:
  • PROVISIONING
  • READY
  • SUSPENDED
  • DELETING
NULL if CDC is disabled.
CDC_ENGINE_SIZESTRINGThe configured size of the CDC engine.
CDC_TASK_STATUSSTRINGThe status of the CDC service. May be one of:
  • STARTED
  • SUSPENDED
CDC_TASK_INFOVARIANTA JSON object with four fields: createdOn, lastSuspendedOn, lastSuspendedReason, and state.

Example#

Use app.cdc_status() to check the current status of the RAI Native App’s CDC Service:

#CALL relationalai.app.cdc_status();
/*+--------------+--------------------+-------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------|
  | CDC_ENABLED  | CDC_ENGINE_NAME    | CDC_ENGINE_STATUS | CDC_ENGINE_SIZE  | CDC_TASK_STATUS | CDC_TASK_INFO                                                                                                            |
  |--------------+--------------------+-------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------|
  | TRUE         | CDC_MANAGED_ENGINE | READY             | HIGHMEM_X64_S    | started         | {"createdOn": "2024-10-15 21:58:11.291 -0700", "lastSuspendedOn": null, "lastSuspendedReason": null, "state": "started"} |
  +--------------+--------------------+-------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------| */

See Data Management for more information on the CDC service.

See Also#