TiFlashコマンドラインフラグ

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

server --config-file

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

dttool migrate

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

• ユーザーシナリオ：

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

• パラメーター：

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

ノート：

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

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

dttool bench

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

• パラメーター：

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

dttool inspect

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

• ユーザーシナリオ：

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

• パラメーター：

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