TTL (Time to Live) を使用して期限切れのデータを定期的に削除する

Time to Live (TTL) は、行レベルで TiDB データの有効期間を管理できる機能です。TTL 属性を持つテーブルの場合、TiDB は自動的にデータの有効期間をチェックし、行レベルで期限切れのデータを削除します。この機能により、一部のシナリオではstorageスペースを効果的に節約し、パフォーマンスを向上させることができます。

TTL の一般的なシナリオを以下に示します。

• 確認コードと短縮 URL を定期的に削除してください。
• 不要な履歴注文を定期的に削除します。
• 計算の中間結果を自動的に削除します。

TTL は、オンラインの読み取りおよび書き込みワークロードに影響を与えることなく、ユーザーが不必要なデータを定期的かつタイムリーにクリーンアップできるように設計されています。TTL は、異なるジョブを異なる TiDB ノードに同時にディスパッチして、テーブル単位でデータを並行して削除します。TTL では、期限切れのデータがすぐに削除されることは保証されません。つまり、一部のデータが期限切れになった場合でも、そのデータがバックグラウンド TTL ジョブによって削除されるまで、クライアントは有効期限が切れてからしばらく経ってからそのデータを読み取る可能性があります。

構文

CREATE TABLEまたはALTER TABLEステートメントを使用して、テーブルの TTL 属性を設定できます。

TTL属性を持つテーブルを作成する

• TTL 属性を持つテーブルを作成します。

  CREATE TABLE t1 (
      id int PRIMARY KEY,
      created_at TIMESTAMP
  ) TTL = `created_at` + INTERVAL 3 MONTH;
  

  前の例では、テーブルt1を作成し、データの作成時刻を示す TTL タイムスタンプ列としてcreated_atを指定します。また、この例では、行がテーブル内で存続できる最長期間を 3 か月からINTERVAL 3 MONTHに設定します。この値よりも長く存続するデータは後で削除されます。

• 期限切れのデータをクリーンアップする機能を有効または無効にするには、 TTL_ENABLE属性を設定します。

  CREATE TABLE t1 (
      id int PRIMARY KEY,
      created_at TIMESTAMP
  ) TTL = `created_at` + INTERVAL 3 MONTH TTL_ENABLE = 'OFF';
  

  TTL_ENABLE OFFに設定されている場合、他の TTL オプションが設定されていても、TiDB はこのテーブル内の期限切れデータを自動的にクリーンアップしません。TTL 属性を持つテーブルの場合、デフォルトではTTL_ENABLEがONなります。

• MySQL との互換性を保つために、コメントを使用して TTL 属性を設定できます。

  CREATE TABLE t1 (
      id int PRIMARY KEY,
      created_at TIMESTAMP
  ) /*T![ttl] TTL = `created_at` + INTERVAL 3 MONTH TTL_ENABLE = 'OFF'*/;
  

  TiDB では、テーブル TTL 属性を使用するか、コメントを使用して TTL を構成することは同等です。MySQL では、コメントは無視され、通常のテーブルが作成されます。

テーブルのTTL属性を変更する

• テーブルの TTL 属性を変更します。

  ALTER TABLE t1 TTL = `created_at` + INTERVAL 1 MONTH;
  

  上記のステートメントを使用して、既存の TTL 属性を持つテーブルを変更したり、TTL 属性のないテーブルに TTL 属性を追加したりできます。

• TTL 属性を持つテーブルの値をTTL_ENABLEに変更します。

  ALTER TABLE t1 TTL_ENABLE = 'OFF';
  

• テーブルのすべての TTL 属性を削除するには:

  ALTER TABLE t1 REMOVE TTL;
  

TTLとデータ型のデフォルト値

TTL はデータ型のデフォルト値と一緒に使用できます。次に、一般的な使用例を 2 つ示します。

• DEFAULT CURRENT_TIMESTAMP使用すると、列のデフォルト値を現在の作成時刻として指定し、この列を TTL タイムスタンプ列として使用します。3 か月前に作成されたレコードは期限切れです。

  CREATE TABLE t1 (
      id int PRIMARY KEY,
      created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
  ) TTL = `created_at` + INTERVAL 3 MONTH;
  

• 列のデフォルト値を作成時刻または最終更新時刻として指定し、この列を TTL タイムスタンプ列として使用します。3 か月間更新されていないレコードは期限切れになります。

  CREATE TABLE t1 (
      id int PRIMARY KEY,
      created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
  ) TTL = `created_at` + INTERVAL 3 MONTH;
  

TTLと生成された列

TTL を生成された列と組み合わせて使用すると、複雑な有効期限ルールを設定できます。例:

CREATE TABLE message (
    id int PRIMARY KEY,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    image bool,
    expire_at TIMESTAMP AS (IF(image,
            created_at + INTERVAL 5 DAY,
            created_at + INTERVAL 30 DAY
    ))
) TTL = `expire_at` + INTERVAL 0 DAY;

上記のステートメントは、 expire_at列を TTL タイムスタンプ列として使用し、メッセージの種類に応じて有効期限を設定します。メッセージが画像の場合、5 日で有効期限が切れます。それ以外の場合は、30 日で有効期限が切れます。

TTL をJSON型と一緒に使用できます。例:

CREATE TABLE orders (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    order_info JSON,
    created_at DATE AS (JSON_EXTRACT(order_info, '$.created_at')) VIRTUAL
) TTL = `created_at` + INTERVAL 3 month;

TTLジョブ

注記：

TiDB Serverless では、テーブルのTTL_JOB_INTERVAL属性は15mに固定されており、変更できません。つまり、TiDB Serverless は、期限切れのデータをクリーンアップするために 15 分ごとにバックグラウンド ジョブをスケジュールします。

TTL 属性を持つ各テーブルについて、TiDB は期限切れのデータをクリーンアップするためのバックグラウンド ジョブを内部的にスケジュールします。テーブルのTTL_JOB_INTERVAL属性を設定することで、これらのジョブの実行期間をカスタマイズできます。次の例では、テーブルordersのバックグラウンド クリーンアップ ジョブを 24 時間ごとに 1 回実行するように設定します。

ALTER TABLE orders TTL_JOB_INTERVAL = '24h';

デフォルトではTTL_JOB_INTERVALは1hに設定されています。

TTL ジョブを実行すると、TiDB はテーブルを最大 64 個のタスクに分割します。最小単位はリージョンです。これらのタスクは分散して実行されます。システム変数tidb_ttl_running_tasksを設定することで、クラスター全体で同時実行可能な TTL タスクの数を制限できます。ただし、すべての種類のテーブルのすべての TTL ジョブをタスクに分割できるわけではありません。どの種類のテーブルの TTL ジョブをタスクに分割できないかの詳細については、セクション制限事項を参照してください。

TTL ジョブの実行を無効にするには、 TTL_ENABLE='OFF'テーブル オプションを設定することに加えて、 tidb_ttl_job_enableグローバル変数を設定してクラスター全体で TTL ジョブの実行を無効にすることもできます。

SET @@global.tidb_ttl_job_enable = OFF;

シナリオによっては、TTL ジョブを特定の時間枠でのみ実行できるようにしたい場合があります。この場合、グローバル変数tidb_ttl_job_schedule_window_start_timeとtidb_ttl_job_schedule_window_end_timeを設定して時間枠を指定できます。例:

SET @@global.tidb_ttl_job_schedule_window_start_time = '01:00 +0000';
SET @@global.tidb_ttl_job_schedule_window_end_time = '05:00 +0000';

上記のステートメントでは、TTL ジョブを UTC の 1:00 から 5:00 の間にのみスケジュールできます。デフォルトでは、時間ウィンドウは00:00 +0000から23:59 +0000に設定されており、ジョブをいつでもスケジュールできます。

可観測性

注記：

このセクションは、TiDB Self-Managed にのみ適用されます。現在、 TiDB Cloud はTTL メトリックを提供していません。

TiDB は定期的に TTL に関する実行時情報を収集し、Grafana でこれらのメトリックの視覚化されたチャートを提供します。これらのメトリックは、Grafana の TiDB -> TTL パネルで確認できます。

さらに、TiDB は TTL ジョブに関する詳細情報を取得するための 3 つのテーブルを提供します。

• mysql.tidb_ttl_table_statusテーブルには、すべての TTL テーブルについて、以前に実行された TTL ジョブと進行中の TTL ジョブに関する情報が含まれています。

  TABLE mysql.tidb_ttl_table_status LIMIT 1\G
  

  *************************** 1. row ***************************
                        table_id: 85
                 parent_table_id: 85
                table_statistics: NULL
                     last_job_id: 0b4a6d50-3041-4664-9516-5525ee6d9f90
             last_job_start_time: 2023-02-15 20:43:46
            last_job_finish_time: 2023-02-15 20:44:46
             last_job_ttl_expire: 2023-02-15 19:43:46
                last_job_summary: {"total_rows":4369519,"success_rows":4369519,"error_rows":0,"total_scan_task":64,"scheduled_scan_task":64,"finished_scan_task":64}
                  current_job_id: NULL
            current_job_owner_id: NULL
          current_job_owner_addr: NULL
       current_job_owner_hb_time: NULL
          current_job_start_time: NULL
          current_job_ttl_expire: NULL
               current_job_state: NULL
              current_job_status: NULL
  current_job_status_update_time: NULL
  1 row in set (0.040 sec)
  

  列table_idはパーティションテーブルの ID であり、列parent_table_idテーブルの ID で、列information_schema.tablesの ID に対応します。テーブルがパーティションテーブルでない場合、2 つの ID は同じになります。

  列{last, current}_job_{start_time, finish_time, ttl_expire}は、それぞれ、前回または現在の実行の TTL ジョブで使用された開始時刻、終了時刻、有効期限を示します。列last_job_summaryは、行の合計数、成功した行の数、失敗した行の数など、最後の TTL タスクの実行ステータスを示します。

• mysql.tidb_ttl_taskテーブルには、進行中の TTL サブタスクに関する情報が含まれています。TTL ジョブは多くのサブタスクに分割され、このテーブルには現在実行中のサブタスクが記録されます。

• mysql.tidb_ttl_job_historyテーブルには、実行された TTL ジョブに関する情報が含まれています。TTL ジョブ履歴の記録は 90 日間保持されます。

  TABLE mysql.tidb_ttl_job_history LIMIT 1\G
  

  *************************** 1. row ***************************
             job_id: f221620c-ab84-4a28-9d24-b47ca2b5a301
           table_id: 85
    parent_table_id: 85
       table_schema: test_schema
         table_name: TestTable
     partition_name: NULL
        create_time: 2023-02-15 17:43:46
        finish_time: 2023-02-15 17:45:46
         ttl_expire: 2023-02-15 16:43:46
       summary_text: {"total_rows":9588419,"success_rows":9588419,"error_rows":0,"total_scan_task":63,"scheduled_scan_task":63,"finished_scan_task":63}
       expired_rows: 9588419
       deleted_rows: 9588419
  error_delete_rows: 0
             status: finished
  

  列table_idはパーティションテーブルの ID で、 parent_table_idテーブルの ID で、 information_schema.tablesの ID に対応します。 table_schema 、 table_name 、およびpartition_name 、データベース、テーブル名、およびパーティション名に対応します。 create_time 、 finish_time 、およびttl_expire 、TTL タスクの作成時刻、終了時刻、および有効期限を示します。 expired_rowsとdeleted_rows 、期限切れの行数と正常に削除された行数を示します。

TiDBツールとの互換性

TTL は、他の TiDB 移行、バックアップ、およびリカバリ ツールと共に使用できます。

SQLとの互換性

制限事項

現在、TTL 機能には次の制限があります。

• TTL 属性は、ローカル一時テーブルやグローバル一時テーブルなどの一時テーブルには設定できません。
• TTL 属性を持つテーブルは、外部キー制約のプライマリ テーブルとして他のテーブルから参照されることをサポートしていません。
• すべての期限切れデータがすぐに削除されることは保証されません。期限切れデータが削除される時間は、バックグラウンド クリーンアップ ジョブのスケジュール間隔とスケジュール ウィンドウによって異なります。
• クラスター化インデックスを使用するテーブルの場合、主キーが整数型でもバイナリ文字列型でもない場合は、TTL ジョブを複数のタスクに分割できません。これにより、TTL ジョブは単一の TiDB ノードで順番に実行されます。テーブルに大量のデータが含まれている場合、TTL ジョブの実行が遅くなる可能性があります。

よくある質問

• tidb_ttl_scan_worker_countとtidb_ttl_delete_worker_count適切に設定するにはどうすればいいですか?

  TiKV ノードの数が多い場合は、値をtidb_ttl_scan_worker_count増やすと、TTL タスクのワークロードがより均等になります。

  ただし、TTL ワーカーが多すぎると大きな負担がかかるため、TiDB の CPU レベルと TiKV のディスクおよび CPU 使用率を一緒に評価する必要があります。さまざまなシナリオとニーズ (TTL を可能な限り高速化する必要があるか、TTL が他のクエリに与える影響を減らす必要があるか) に応じて、 tidb_ttl_scan_worker_countとtidb_ttl_delete_worker_countの値を調整して、TTL スキャンと削除の速度を向上させたり、TTL タスクによってもたらされるパフォーマンスへの影響を減らしたりすることができます。