コンフィグレーションオプション
TiDB クラスターを開始するときは、コマンドライン オプションまたは環境変数を使用して構成できます。このドキュメントでは、TiDB のコマンド オプションを紹介します。デフォルトの TiDB ポートは、クライアント要求用に4000
、ステータス レポート用に10080
です。
--advertise-address
- TiDBサーバーへのログインに使用する IP アドレス
- デフォルト:
""
- このアドレスには、TiDB クラスターの残りの部分とユーザーがアクセスできる必要があります。
--config
- 設定ファイル
- デフォルト:
""
- 構成ファイルを指定した場合、TiDB は構成ファイルを読み取ります。対応する設定がコマンド ライン オプションにも存在する場合、TiDB はコマンド ライン オプションの設定を使用して、設定ファイル内の設定を上書きします。詳しい構成情報については、 TiDBコンフィグレーションファイルの説明を参照してください。
--config-check
- 設定ファイルの有効性を確認して終了します
- デフォルト:
false
--config-strict
- 構成ファイルの有効性を強制します
- デフォルト:
false
--cors
- TiDB HTTP ステータス サービスの Cross-Origin Request Sharing (CORS) リクエストに
Access-Control-Allow-Origin
値を指定します。 - デフォルト:
""
--enable-binlog
- TiDBbinlogの生成を有効または無効にします。
- デフォルト:
false
--host
- TiDBサーバーが監視するホスト アドレス
- デフォルト:
"0.0.0.0"
- TiDBサーバーはこのアドレスを監視します。
"0.0.0.0"
アドレスはデフォルトですべてのネットワーク カードを監視します。複数のネットワーク カードがある場合は、サービスを提供するネットワーク カードを指定します (192.168.100.113
など)。
--initialize-insecure
- tidb-server を安全でないモードでブートストラップする
- デフォルト:
true
--initialize-secure
- tidb-server をセキュアモードでブートストラップする
- デフォルト:
false
--initialize-sql-file
- TiDB クラスターが初めて起動されるときに実行される SQL スクリプト。詳細は構成項目
initialize-sql-file
を参照 - デフォルト:
""
-L
- ログレベル
- デフォルト:
"info"
- オプションの値:
"debug"
、"info"
、"warn"
、"error"
、"fatal"
--lease
- スキーマのリース期間。何をするのか理解していない場合に値を変更するのは危険です。
- デフォルト:
45s
--log-file
- ログファイル
- デフォルト:
""
- このオプションが設定されていない場合、ログは「stderr」に出力されます。このオプションを設定すると、対応するファイルにログが出力されます。
--log-slow-query
- スロークエリログのディレクトリ
- デフォルト:
""
- このオプションが設定されていない場合、デフォルトでログは
--log-file
で指定されたファイルに出力されます。
--metrics-addr
- Prometheus プッシュゲートウェイのアドレス
- デフォルト:
""
- 空のままにすると、Prometheus クライアントのプッシュが停止されます。
- 形式は
--metrics-addr=192.168.100.115:9091
です。
--metrics-interval
- Prometheus クライアントのプッシュ間隔 (秒)
- デフォルト:
15s
- 値を 0 に設定すると、Prometheus クライアントのプッシュが停止されます。
-P
- TiDB サービスのモニタリング ポート
- デフォルト:
"4000"
- TiDBサーバーは、このポートから MySQL クライアント リクエストを受け入れます。
--path
- 「unistore」などのローカルstorageエンジンのデータ ディレクトリへのパス
--store = tikv
の場合は、パスを指定する必要があります。--store = unistore
の場合、パスを指定しない場合はデフォルト値が使用されます。- TiKV のような分散storageエンジンの場合、
--path
実際の PD アドレスを指定します。 PDサーバーを 192.168.100.113:2379、192.168.100.114:2379、および 192.168.100.115:2379 に展開すると仮定すると、--path
の値は「192.168.100.113:2379、192.168.100.114: 2379、192.168.100.115:2379" 。 - デフォルト:
"/tmp/tidb"
tidb-server --store=unistore --path=""
使用すると、純粋なインメモリ TiDB を有効にできます。
--proxy-protocol-fallbackable
- PROXY プロトコル フォールバック モードを有効にするかどうかを制御します。このパラメーターが
true
に設定されている場合、TiDB は、PROXY プロトコル仕様を使用せず、または PROXY プロトコル ヘッダーを送信せずに、--proxy-protocol-networks
に属するクライアント接続を受け入れます。デフォルトでは、TiDB は--proxy-protocol-networks
に属し、PROXY プロトコル ヘッダーを送信するクライアント接続のみを受け入れます。 - デフォルト値:
false
--proxy-protocol-networks
- プロキシプロトコルを使用して TiDB に接続できるプロキシ サーバーの IP アドレスのリスト。
- デフォルト:
""
- 一般に、リバース プロキシの背後で TiDB にアクセスすると、TiDB はリバース プロキシサーバーの IP アドレスをクライアントの IP アドレスとして取得します。 PROXY プロトコルを有効にすることにより、このプロトコルをサポートする HAProxy などのリバース プロキシは、実際のクライアント IP アドレスを TiDB に渡すことができます。
- このフラグを設定すると、TiDB は、設定されたソース IP アドレスが PROXY プロトコルを使用して TiDB に接続できるようにします。 PROXY 以外のプロトコルが使用されている場合、この接続は拒否されます。他のアドレスは、PROXY プロトコルを使用せずに TiDB に接続できます。このフラグを空のままにすると、どの IP アドレスも PROXY プロトコルを使用して TiDB に接続できなくなります。値には、区切り文字として
,
を使用した IP アドレス (192.168.1.50) または CIDR (192.168.1.0/24) を指定できます。*
任意の IP アドレスを意味します。
注記:
PROXY プロトコルを有効にして AWS Network Load Balancer (NLB) を使用するには、NLB の
target group
プロパティを設定する必要があります。具体的にはproxy_protocol_v2.client_to_server.header_place
~on_first_ack
を設定します。同時に、AWS サポートにチケットを送信する必要があります。 PROXY プロトコルを有効にすると、クライアントはサーバーからのハンドシェイク パケットの取得に失敗し、クライアントがタイムアウトになるまでパケットはブロックされることに注意してください。これは、NLB がクライアントがデータを送信した後にのみプロキシ パケットを送信するためです。ただし、クライアントがデータ パケットを送信する前に、サーバーから送信されたデータ パケットは内部ネットワークでドロップされます。
--proxy-protocol-header-timeout
- PROXY プロトコル ヘッダー読み取りのタイムアウト
- デフォルト:
5
(秒)
注記:
値を
0
に設定しないでください。特別な状況を除いてデフォルト値を使用してください。
--report-status
- ステータス レポートと pprof ツールを有効 (
true
) または無効 (false
) にします。 - デフォルト:
true
- このパラメーターを
true
に設定すると、メトリックと pprof が有効になります。このパラメータをfalse
に設定すると、メトリクスと pprof が無効になります。
--run-ddl
tidb-server
が DDL ステートメントを実行するかどうかを確認し、クラスター内でtidb-server
の数が 2 を超えたときに設定します。- デフォルト:
true
- 値は (true) または (false) です。 (true) は、
tidb-server
DDL 自体を実行することを示します。 (false) は、tidb-server
DDL 自体を実行しないことを示します。
--socket string
- TiDB サービスは、外部接続に unix ソケット ファイルを使用します。
- デフォルト:
""
- UNIX ソケット ファイルを開くには
/tmp/tidb.sock
を使用します。
--status
- TiDBサーバーのステータス レポート ポート
- デフォルト:
"10080"
- このポートはサーバーの内部データを取得するために使用されます。データにはプロメテウスのメトリクスとプロフが含まれます。
- Prometheus メトリクスには
"http://host:status_port/metrics"
でアクセスできます。 - pprof データには
"http://host:status_port/debug/pprof"
によってアクセスできます。
--status-host
HOST
TiDB サービスのステータスを監視するために使用されます- デフォルト:
0.0.0.0
--store
- 最レイヤーの TiDB によって使用されるstorageエンジンを指定します
- デフォルト:
"unistore"
- 「unistore」または「tikv」を選択できます。 (「unistore」はローカルstorageエンジン、「tikv」は分散storageエンジンです)
--temp-dir
- TiDB の一時ディレクトリ
- デフォルト:
"/tmp/tidb"
--token-limit
- TiDB で同時に実行できるセッションの数。交通規制に使われています。
- デフォルト:
1000
- 同時セッションの数が
token-limit
より大きい場合、リクエストはブロックされ、完了した操作がトークンを解放するのを待ちます。
-V
- TiDBのバージョンを出力します
- デフォルト:
""
--plugin-dir
- プラグインのstorageディレクトリ。
- デフォルト:
"/data/deploy/plugin"
--plugin-load
- ロードするプラグインの名前。それぞれをカンマで区切ります。
- デフォルト:
""
--affinity-cpus
- TiDB サーバーの CPU アフィニティをカンマで区切って設定します。たとえば、「1、2、3」です。
- デフォルト:
""
--repair-mode
- データ修復シナリオでのみ使用される修復モードを有効にするかどうかを決定します。
- デフォルト:
false
--repair-list
- 修復モードで修復するテーブルの名前。
- デフォルト:
""