Note
This view is available starting with V3.1.4.
Overview
This API is used to query the historical TTL tasks of all tenants under the system tenant.
Columns
Field |
Type |
Nullable |
Description |
|---|---|---|---|
| TENANT_ID | bigint(20) | NO | Tenant ID |
| TABLE_NAME | varchar(256) | NO | Table name |
| TABLE_ID | bigint(20) | NO | Table ID |
| TABLET_ID | bigint(20) | NO | Tablet ID |
| TASK_ID | bigint(20) | NO | Task ID, starting from 1. |
| START_TIME | timestamp(6) | NO | Task Start Time |
| END_TIME | timestamp(6) | NO | End Time |
| TRIGGER_TYPE | varchar(8) | NO | Task trigger type. Valid values: PERIODIC and USER. |
| STATUS | varchar(13) | NO | Task status. For more information, see Task status. |
| TTL_DEL_CNT | bigint(20) | NO | Based ontime_to_liveNumber of records deleted |
| MAX_VERSION_DEL_CNT | bigint(20) | NO | Based onMAX_VERSIONNumber of Records Deleted |
| SCAN_CNT | bigint(20) | NO | Number of Records Scanned by Task |
| RET_CODE | varchar(512) | NO | Task return code |
| SCAN_INDEX | varchar(128) | NO | Index used for task scanning. The default is PRIMARY KEY. |
Sample query
You can view the historical TTL tasks of all tenants under the sys tenant.
obclient [oceanbase]> SELECT * FROM oceanbase.CDB_OB_KV_TTL_TASK_HISTORY LIMIT 10\G;
The query result is as follows:
*************************** 1. row ***************************
TENANT_ID: 1004
TABLE_NAME: ttl_table_1
TABLE_ID: 500017
TABLET_ID: 200019
TASK_ID: 1
START_TIME: 2026-04-23 17:44:04.445966
END_TIME: 2026-04-23 17:44:04.451643
TRIGGER_TYPE: USER
STATUS: FINISHED
TTL_DEL_CNT: 4
MAX_VERSION_DEL_CNT: 0
SCAN_CNT: 4
RET_CODE: OB_SUCCESS
TASK_TYPE: NORMAL
SCAN_INDEX: PRIMARY KEY
*************************** 2. row ***************************
TENANT_ID: 1004
TABLE_NAME: ttl_table_1
TABLE_ID: 500017
TABLET_ID: 200018
TASK_ID: 1
START_TIME: 2026-04-23 17:44:09.269205
END_TIME: 2026-04-23 17:44:09.274552
TRIGGER_TYPE: USER
STATUS: FINISHED
TTL_DEL_CNT: 2
MAX_VERSION_DEL_CNT: 0
SCAN_CNT: 2
RET_CODE: OB_SUCCESS
TASK_TYPE: NORMAL
SCAN_INDEX: PRIMARY KEY