:TTL テーブルの定義

TTL_EXPR

TTL テーブルの時間列とデータ保持期間を指定します。

• 構文:

  TTL_EXPR = ttl_column EXPIRE AFTER ttl_interval_definition timezone_definition
  
  ttl_interval_definition:
    ttl_interval_num { DAY | MONTH | YEAR }
  
  timezone_definition:
    TIMEZONE time_zone_value

  説明

  • ttl_column: TTL テーブルの時間列。Date、Datetime、Timestamp 型の列のみがサポートされています。

  • ttl_interval_definition: TTL テーブル内のデータの保持期間。単位: DAY、MONTH、YEAR。now() の値と ttl_column の値の差が、ttl_interval_definition で指定された ttl_interval_num の値よりも大きい場合、システムは ttl_column の値を持つ対応するデータを自動的にクリーンアップします。

  • timezone_definition: TTL テーブルのタイムゾーン。Timestamp などのタイムゾーン依存型の場合、TTL 定義でタイムゾーンを指定して、タイムゾーンベースのクリーンアップを実装できます。

• 例:

  TTL_EXPR = `date_field` EXPIRE AFTER 2 MONTH TIMEZONE '+08:00'

  説明

  • date_field 列は、TTL テーブルの時間列です。

  • 2 MONTH は、データ保持期間が 2 か月であることを指定します。指定された時間列の値に基づいて、2 か月の保持期間が終了すると、テーブル内のデータは期限切れになります。

  • +08:00 は、タイムゾーンが UTC + 08:00 であることを指定します。

TTL_JOB

クリーンアップジョブを実行するスケジュールを指定します。デフォルト値: '0 0 1 */1 * ? *'。これは、クリーンアップジョブが毎日 01:00 に実行されることを指定します。

• 構文:

  TTL_JOB = quartz_cron_expr_definition timezone_definition
  
  quartz_cron_expr_definition:
     CRON cron_expr_value
  
  timezone_definition:
    TIMEZONE time_zone_value

  説明

  quartz_cron_expr_definition: クリーンアップジョブを実行するスケジュール。値は、Quartz フレームワークの CRON 式で、以下の部分で構成されます。

  • 秒。有効な値: 0 ～ 59。

  • 分。有効な値: 0 ～ 59。

  • 時。有効な値: 0 ～ 23 およびアスタリスク (*)。アスタリスク (*) は、クリーンアップジョブが毎時実行されることを指定します。

  • 日。月の何日目を指定します。有効な値: 1 ～ 31 およびアスタリスク (*)。アスタリスク (*) は、クリーンアップジョブが毎日実行されることを指定します。

  • 月。有効な値: 1 ～ 12 または JAN、FEB、MAR、APR、...、DEC、およびアスタリスク (*)。アスタリスク (*) は、クリーンアップジョブが毎月実行されることを指定します。

  • 曜日。有効な値: 1 ～ 7 または SUN、MON、TUE、WED、THU、FRI、SAT、および疑問符 (?)。1 は日曜日を指定します。疑問符 (?) はプレースホルダーとして機能し、値が設定されていないことを指定します。

  • 年。有効な値: 年の値およびアスタリスク (*)。アスタリスク (*) は、クリーンアップジョブが毎年実行されることを指定します。

  重要

  スケジュールされたクリーンアップジョブは、特定量のリソースを消費します。頻繁なクリーンアップジョブがビジネスの安定性に影響を与えるのを防ぐため、PolarDB-X 2.0 では、クリーンアップジョブの実行スケジュールを分または秒単位の式に設定することはできません。

• 例: スケジュールされたクリーンアップジョブを毎日 02:00 に実行するように設定します。

   TTL_JOB = CRON '0 0 2 */1 * ?  *' TIMEZONE '+08:00'

TTL_ENABLE

TTL テーブルのスケジュールされたクリーンアップジョブを有効にするかどうかを指定します。

TTL_ENABLE = {'ON' | 'OFF'}

TTL_FILTER

TTL テーブルに対してクリーンアップジョブがトリガーされると、デフォルトでは、時間列の値が NULL の行が削除されます。これらの行を保持するには、TTL テーブルに TTL_FILTER=COND_EXPR(<ttl_column> IS NOT NULL) を明示的に設定します。

サンプルコード:

ALTER TABLE `my_ttl_tbl` 
MODIFY TTL
SET
TTL_FILTER = COND_EXPR(`date_field` IS NOT NULL); 

既存のテーブルに TTL 定義を指定する

この例では、次の文を実行して my_ttl_tbl という名前のテーブルを作成します。

CREATE TABLE `my_ttl_tbl` (
	`id` int(11) NOT NULL AUTO_INCREMENT,
	`date_field` datetime DEFAULT CURRENT_TIMESTAMP,
	PRIMARY KEY (`id`)
) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4
PARTITION BY KEY(`id`)
PARTITIONS 8;

次の ALTER 文を実行して、my_ttl_tbl テーブルの TTL 定義を指定します。

ALTER TABLE my_ttl_tbl
MODIFY TTL
SET
TTL_EXPR = `date_field` EXPIRE AFTER 2 MONTH TIMEZONE '+08:00';

テーブルの作成時に TTL 定義を指定する

次の文を実行して、TTL 定義を指定した my_ttl_tbl という名前のテーブルを作成します。

CREATE TABLE `my_ttl_tbl` (
	`id` int(11) NOT NULL AUTO_INCREMENT,
	`date_field` datetime DEFAULT CURRENT_TIMESTAMP,
	PRIMARY KEY (`id`)
) ENGINE = InnoDB DEFAULT CHARSET = utf8mb4 TTL = TTL_DEFINITION ( TTL_EXPR = `date_field` EXPIRE AFTER 2 MONTH TIMEZONE '+08:00' ) 
PARTITION BY KEY(`id`)
PARTITIONS 8;

時間列の変更

次の ALTER 文を実行して、TTL 定義の時間列を date_field から create_date に変更します。

ALTER TABLE my_ttl_tbl 
MODIFY TTL
SET
TTL_EXPR = `create_date` EXPIRE AFTER 2 MONTH TIMEZONE '+08:00';

データ保持期間の変更

ALTER TABLE `my_ttl_tbl` 
MODIFY TTL
SET
TTL_EXPR = `create_date` EXPIRE AFTER 2 YEAR TIMEZONE '+08:00';

クリーンアップジョブの実行スケジュールの変更

ALTER TABLE `my_ttl_tbl` 
MODIFY TTL
SET
TTL_JOB = CRON '0 0 3 */1 * ?  *' TIMEZONE '+08:00';

スケジュールされたクリーンアップジョブの有効化ステータスの変更

ALTER TABLE `my_ttl_tbl` 
MODIFY TTL
SET
TTL_ENABLE = 'ON';