TiFlashコマンドラインフラグ
このドキュメントでは、 TiFlash を起動するときに使用できるコマンドライン フラグについて説明します。
server --config-file
- TiFlash構成ファイルのパスを指定します
- デフォルト: ""
- 設定ファイルを指定する必要があります。詳細な設定項目についてはTiFlash構成パラメータを参照してください。
dttool migrate
DTFile のファイル形式を移行します (テストまたはダウングレード用)。データは 1 つの 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 のスペース使用量と読み取り速度をテストします。
- 小さなファイルのマージが有効になっているバージョン >= v7.3.0 (つまり、
storage.format_version
>= 5) からバージョン < v7.3.0 にTiFlash をダウングレードする必要がある場合は、このツールを使用して DTFile のデータ形式をダウングレードできます。
パラメーター:
--imitative
: DTFile の暗号化機能を使用しない場合は、このフラグを使用して、構成ファイルの使用と PD への接続を回避できます。--version
: DTFile のターゲット バージョン。値のオプションは1
、2
(既定値)、3
。1
は古いバージョン、2
は新しいチェックサムに対応するバージョン、3
小さなファイルのマージをサポートするバージョンです。--algorithm
: データ検証に使用されるハッシュ アルゴリズム。値のオプションはxxh3
(デフォルト)、city128
、crc32
、crc64
、およびnone
です。このパラメーターはversion
が2
の場合にのみ有効です。--frame
: 検証フレームのサイズ。デフォルト値は1048576
です。このパラメータはversion
が2
の場合にのみ有効です。--compression
: ターゲット圧縮アルゴリズム。値のオプションはLZ4
(デフォルト)、LZ4HC
、zstd
、およびnone
です。--level
: ターゲット圧縮レベル。指定しない場合は、圧縮アルゴリズムに従って、推奨される圧縮レベルがデフォルトで使用されます。2compression
LZ4
またはzstd
に設定されている場合、デフォルトのレベルは 1 です。8compression
LZ4HC
に設定されている場合、デフォルトのレベルは 9 です。--config-file
:dttool migrate
の設定ファイルはserver
の設定ファイルと同じです。詳細については--imitative
を参照してください。--file-id
: DTFile の ID。たとえば、DTFiledmf_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のバージョン。2dttool migrate
の--version
参照してください。--algorithm
: データ検証に使用されるハッシュアルゴリズムdttool migrate
の--algorithm
を参照してください。--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
の設定ファイル。4dttool migrate
の--config-file
参照してください。--check
: ハッシュ検証を実行します。--file-id
: DTFileのdttool migrate
の--file-id
を参照してください。--imitative
: データベースのコンテキストを模倣します。dttool migrate
の--imitative
を参照してください。--workdir
: データディレクトリ。2dttool migrate
の--workdir
参照してください。