TTL

Purpose

The ALTER SYSTEM TRIGGER/SUSPEND/RESUME/CANCEL TTL statement is used to manually trigger, suspend, resume, or cancel a tenant-level Time-To-Live (TTL) task.

Privilege requirements

To execute the ALTER SYSTEM TRIGGER/SUSPEND/RESUME/CANCEL TTL statement, the current user must have the ALTER SYSTEM privilege. For more information about OceanBase Database privileges, see Privilege classification in MySQL-compatible mode and Privilege classification in Oracle-compatible mode.

Syntax

ALTER SYSTEM {TRIGGER | SUSPEND | RESUME | CANCEL} TTL [TENANT [=] all | all_user | tenant_list];

tenant_list:
  tenant_name[,tenant_name ...]

Parameters

Examples

• The sys tenant triggers a TTL task for the user tenant tenant1.

  1. Enable the TTL feature for the tenant tenant1.

     obclient(root@sys)[(none)]> ALTER SYSTEM SET enable_ttl = True TENANT = tenant1;
     

  2. Manually trigger a TTL task for the user tenant tenant1.

     obclient(root@sys)[(none)]> ALTER SYSTEM TRIGGER TTL TENANT = tenant1;
     

• A user tenant triggers a TTL task for itself.

  1. Enable the TTL feature.

     obclient(root@mysql001)[(none)]> ALTER SYSTEM SET enable_ttl = True;
     

  2. Manually trigger a TTL task.

     obclient(root@mysql001)[(none)]> ALTER SYSTEM TRIGGER TTL;
     

References

• For detailed operations and information about TTL tasks in SQL scenarios, see Use the TTL feature.