cdc_status()
relationalai.app
cdc_status()A procedure that retrieves the current status and other details of the CDC Service.
Requires the app_user application role.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”A table with the following columns:
| Column | Type | Description |
|---|---|---|
CDC_ENABLED | BOOLEAN | Whether the CDC service is enabled. |
CDC_ENGINE_NAME | STRING | The name of the current CDC engine. NULL if CDC is disabled. |
CDC_ENGINE_STATUS | STRING | The status of the CDC engine. May be one of:
NULL if CDC is disabled. |
CDC_ENGINE_SIZE | STRING | The configured size of the CDC engine. |
CDC_TASK_STATUS | STRING | The status of the CDC service. May be one of:
|
CDC_TASK_INFO | VARIANT | A JSON object with four fields: status, created_on, last_suspended_on, and last_suspension_reason. |
Example
Section titled “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 | {"status": "started", "created_on": "2024-10-15 21:58:11.291 -0700", "last_suspended_on": null, "last_suspension_reason": null} | +--------------+--------------------+-------------------+------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------| */See Enable and disable CDC for more information on the CDC service.