重要
このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

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のバージョン。値のオプションは12 (デフォルト)です。 1は古いバージョンで、 2は新しいチェックサムに対応するバージョンです。
    • --algorithm :データ検証に使用されるハッシュアルゴリズム。値のオプションは、 xxh3 (デフォルト)、 city128none crc32 crc64このパラメーターは、 version2の場合にのみ有効です。
    • --frame :検証フレームのサイズ。デフォルト値は1048576です。このパラメータは、 version2の場合にのみ有効です。
    • --compression :ターゲット圧縮アルゴリズム。値のオプションは、 LZ4 (デフォルト)、 LZ4HC 、およびzstd none
    • --level :目標圧縮レベル。指定しない場合、推奨される圧縮レベルが圧縮アルゴリズムに従ってデフォルトで使用されます。 compressionLZ4またはzstdに設定されている場合、デフォルトレベルは1ですcompressionLZ4HCに設定されている場合、デフォルトレベルは9です。
    • --config-filedttool migrateの設定ファイルはserverの構成ファイルと同じです。構成ファイルを使用する場合は、ローカルTiFlashサーバーインスタンスを終了します。詳細については、 --imitativeを参照してください。
    • --file-id :DTFileのID。たとえば、 dmf_123のIDは123です。
    • --workdirdmf_xxxの親ディレクトリ。
    • --dry :ドライランモード。移行プロセスのみが出力されます。
    • --nokeep :元のデータを保持しません。このオプションが有効になっていない場合、 dmf_xxx.oldのファイルが作成されます。
警告

TiFlashは、カスタム圧縮アルゴリズムと圧縮レベルを使用するDTFileを読み取ることができます。ただし、デフォルトの圧縮レベルを持つlz4のアルゴリズムのみが公式にサポートされています。カスタム圧縮パラメータは徹底的にテストされておらず、実験的ものにすぎません。

ノート:

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

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

dttool bench

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

  • パラメーター:

    • --version :DTFileのバージョン。 --versiondttool migrateを参照してください。
    • --algorithm :データ検証に使用されるハッシュアルゴリズム。 --algorithmdttool 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のデータ整合性を検証できます。
  • パラメーター: