コンフィグレーションオプション
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:23200. 379" . - デフォルト:
"/tmp/tidb"
tidb-server --store=unistore --path=""
使用して、純粋なメモリ内 TiDB を有効にすることができます。
--proxy-protocol-fallbackable
- PROXY プロトコル フォールバック モードを有効にするかどうかを制御します。このパラメーターが
true
に設定されている場合、TiDB は PROXY クライアント接続と、PROXY プロトコル ヘッダーなしのクライアント接続を受け入れます。デフォルトでは、TiDB は PROXY プロトコル ヘッダーを持つクライアント接続のみを受け入れます。 - デフォルト値:
false
--proxy-protocol-networks
- プロキシ プロトコルを使用して TiDB に接続できるプロキシ サーバーの IP アドレスのリスト。
- デフォルト:
""
- 一般に、リバース プロキシの背後にある TiDB にアクセスすると、TiDB はリバース プロキシサーバーの IP アドレスをクライアントの IP アドレスとして取得します。 PROXY プロトコルを有効にすることで、HAProxy などのこのプロトコルをサポートするリバース プロキシは、実際のクライアント IP アドレスを TiDB に渡すことができます。
- このフラグを構成した後、TiDB は、構成されたソース IP アドレスが PROXY プロトコルを使用して TiDB に接続できるようにします。 PROXY 以外のプロトコルが使用されている場合、この接続は拒否されます。このフラグを空のままにすると、PROXY プロトコルを使用して IP アドレスが 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 ソケット ファイルを使用します。
- デフォルト:
""
/tmp/tidb.sock
を使用して UNIX ソケット ファイルを開きます。
--status
- TiDBサーバーのステータス レポート ポート
- デフォルト:
"10080"
- このポートは、サーバーの内部データを取得するために使用されます。データにはプロメテウスの指標とプロフが含まれます。
- Prometheus メトリクスには
"http://host:status_port/metrics"
でアクセスできます。 - pprof データは
"http://host:status_port/debug/pprof"
でアクセスできます。
--status-host
- TiDB サービスのステータスを監視するために使用される
HOST
- デフォルト:
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
- 修復モードで修復されるテーブルの名前。
- デフォルト:
""