TiFlashコマンドライン フラグ

このドキュメントでは、 TiFlash を起動するときに使用できるコマンドライン フラグを紹介します。

server --config-file

• TiFlash構成ファイルのパスを指定します
• デフォルト： ""
• 構成ファイルを指定する必要があります。詳しい設定項目についてはTiFlash設定パラメータを参照してください。

dttool migrate

• DTFile のファイル形式を移行します (テストまたはダウングレード用)。データは 1 つの DTFile 単位で移行されます。テーブル全体を移行する場合は、 <data dir>/t_<table id>/stable/dmf_<file id>に類似したすべてのパスを見つけて、1 つずつ移行する必要があります。スクリプトを使用して移行を自動化できます。

• ユーザーシナリオ:

  • データ検証が有効になっているTiFlash をv5.4.0 以上のバージョンから v5.4.0 未満のバージョンにダウングレードする必要がある場合は、このツールを使用して DTFile のデータ形式をダウングレードできます。
  • TiFlash をv5.4.0 以上のバージョンにアップグレードし、既存のデータのデータ検証を有効にしたい場合は、このツールを使用して DTFile のデータ形式をアップグレードできます。
  • さまざまな構成で DTFile のスペース使用量と読み取り速度をテストします。

• パラメーター：

  • --imitative : DTFile の暗号化機能を使用しない場合、このフラグを使用して、設定ファイルの使用と PD への接続を回避できます。
  • --version : DTFile のバージョン。値のオプションは1と2 (デフォルト) です。 1が古いバージョン、 2が新しいチェックサムに対応するバージョンです。
  • --algorithm : データ検証に使用されるハッシュ アルゴリズム。値のオプションはxxh3 (デフォルト)、 city128 、 crc32 、 crc64 、およびnoneです。このパラメータは、 versionが2の場合にのみ有効です。
  • --frame : 検証フレームのサイズ。デフォルト値は1048576です。このパラメータはversionが2の場合にのみ有効です。
  • --compression : ターゲットの圧縮アルゴリズム。値のオプションはLZ4 (デフォルト)、 LZ4HC zstdおよびnoneです。
  • --level : 目標の圧縮レベル。指定しない場合は、圧縮アルゴリズムに従って推奨圧縮レベルがデフォルトで使用されます。 compressionがLZ4またはzstdに設定されている場合、デフォルトのレベルは 1 です。 compressionがLZ4HCに設定されている場合、デフォルトのレベルは 9 です。
  • --config-file ： dttool migrateの設定ファイルはserverの設定ファイルと同じです。詳細については、 --imitativeを参照してください。
  • --file-id : DTFile の ID。たとえば、DTFile dmf_123の ID は123です。
  • --workdir : dmf_xxxの親ディレクトリ。
  • --dry : ドライランモード。移行プロセスのみが出力されます。
  • --nokeep : 元のデータを保持しません。このオプションが有効になっていない場合、 dmf_xxx.oldファイルが作成されます。

ノート：

セキュリティ上の理由から、DTTool は移行モードで作業ディレクトリにロックを追加しようとします。したがって、同じディレクトリ内では、同時に移行タスクを実行できる DTTool は 1 つだけです。ロックが解放されていない状態で DTTool を強制的に停止すると、後で DTTool を再実行しようとすると、移行タスクの実行が拒否される可能性があります。

この状況が発生し、LOCK ファイルを削除してもデータが破損しないことがわかっている場合は、作業ディレクトリ内の LOCK ファイルを手動で削除してロックを解除できます。

dttool bench

• DTFile の基本的な I/O 速度テストを提供します。

• パラメーター：

  • --version : DTFile のバージョン。 dttool migrateの--versionを参照してください。
  • --algorithm : データ検証に使用されるハッシュ アルゴリズム。 dttool migrateの--algorithmを参照してください。
  • --frame : 検証フレームのサイズ。 dttool migrateの--frameを参照してください。
  • --column : テストするテーブルの列。デフォルト値は100です。
  • --size : テストするテーブルの行。デフォルト値は1000です。
  • --field : テストするテーブルのフィールド長制限。デフォルト値は1024です。
  • --random : ランダムシード。このパラメーターを指定しない場合、ランダム シードはシステム エントロピー プールから抽出されます。
  • --encryption : 暗号化機能を有効にします。
  • --repeat : テストを繰り返す回数。デフォルト値は5です。
  • --workdir : 一時データ ディレクトリ。テスト対象のファイル システム内のパスを指します。デフォルト値は/tmp/testです。

dttool inspect

• DTFile の整合性をチェックします。データ検証は 1 つの DTFile 単位で実行されます。テーブル全体を検証する場合は、 <data dir>/t_<table id>/stable/dmf_<file id>に類似したパスをすべて見つけて、それらを 1 つずつ検証する必要があります。スクリプトを使用して検証を自動化できます。

• ユーザーシナリオ:

  • フォーマットのアップグレードまたはダウングレードを実行した後、DTFile のデータの整合性を検証できます。
  • DTFile を新しい環境に移行した後、DTFile のデータ整合性を検証できます。

• パラメーター：

  • --config-file : dttool benchの設定ファイル。 dttool migrateの--config-fileを参照してください。
  • --check : ハッシュ検証を実行します。
  • --file-id : DTFile の ID。 dttool migrateの--file-idを参照してください。
  • --imitative : データベースコンテキストを模倣します。 dttool migrateの--imitativeを参照してください。
  • --workdir : データディレクトリ。 dttool migrateの--workdirを参照してください。