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つ示します。

• 列のデフォルト値を現在の作成時刻に指定し、この列をTTLタイムスタンプ列として使用するには、 DEFAULT CURRENT_TIMESTAMP使用します。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は、TTL属性を持つ各テーブルに対して、期限切れデータをクリーンアップするためのバックグラウンドジョブを内部的にスケジュールします。これらのジョブの実行周期は、テーブルのTTL属性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セルフマネージドにのみ適用されます。現在、 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 ジョブは、次のシナリオでのみ複数のサブタスクに分割できます。
  • 主キーまたは複合主キーの最初の列は、 INTEGERまたはバイナリ文字列型です。バイナリ文字列型は主に以下のものを指します。
    • CHAR(N) CHARACTER SET BINARY
    • VARCHAR(N) CHARACTER SET BINARY
    • BINARY(N)
    • VARBINARY(N)
    • BIT(N)
  • 主キーまたは複合主キーの最初の列の文字セットはutf8またはutf8mb4であり、照合順序はutf8_bin 、 utf8mb4_bin 、またはutf8mb4_0900_binです。
  • 主キーの最初の列の文字セットタイプがutf8またはutf8mb4あるテーブルの場合、サブタスクは表示可能なASCII文字の範囲に基づいてのみ分割されます。多くの主キー値に同じASCIIプレフィックスが付いている場合、タスクの分割が不均一になる可能性があります。
  • 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タスクによるパフォーマンスへの影響を軽減したりできます。