重要

現在表示されているページは、TiDBのアーカイブされたドキュメント (非更新) です。TiDBをご利用の場合、最新のLTS (Long Term Support) バージョンの使用を推奨します。

重要

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

Configuration / コンフィグレーションオプション

TiDB クラスターを起動すると、コマンドラインオプションまたは環境変数を使用して構成できます。このドキュメントでは、TiDB のコマンドオプションを紹介します。デフォルトの TiDB ポートは、クライアントリクエスト用に4000 、ステータスレポート用に10080です。

`--advertise-address`

TiDBサーバーへのログインに使用する IP アドレス
デフォルト: ""
このアドレスは、TiDB クラスターの残りの部分とユーザーがアクセスできる必要があります。

`--config`

構成ファイル
デフォルト: ""
構成ファイルを指定した場合、TiDB は構成ファイルを読み取ります。対応する構成がコマンドラインオプションにも存在する場合、TiDB はコマンドラインオプションの構成を使用して、構成ファイル内の構成を上書きします。詳細な構成情報については、 TiDBConfiguration / コンフィグレーションファイルの説明を参照してください。

`--config-check`

構成ファイルの有効性を確認して終了します
デフォルト: false

`--config-strict`

構成ファイルの有効性を強制します
デフォルト: false

`--cors`

TiDB HTTP ステータスサービスの Cross-Origin Request Sharing (CORS) リクエストにAccess-Control-Allow-Originの値を指定します
デフォルト: ""

`--host`

TiDBサーバーが監視するホストアドレス
デフォルト: "0.0.0.0"
TiDBサーバーはこのアドレスを監視します。
"0.0.0.0"のアドレスは、デフォルトですべてのネットワークカードを監視します。複数のネットワークカードがある場合は、サービスを提供するネットワークカードを192.168.100.113などで指定します。

`--enable-binlog`

TiDB バイナリログ生成を有効または無効にします
デフォルト: false

`-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」などのローカルストレージエンジンのデータディレクトリへのパス
--store = tikvの場合、パスを指定する必要があります。 --store = unistoreの場合、パスを指定しない場合はデフォルト値が使用されます。
TiKV のような分散ストレージエンジンの場合、 --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:22079、8.195」です。 .
デフォルト: "/tmp/tidb"
tidb-server --store=unistore --path=""を使用して、純粋なメモリ内 TiDB を有効にすることができます。

`--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 アドレスを意味します。

警告

*を使用すると、任意の IP アドレスのクライアントがその IP アドレスを報告できるようになり、セキュリティ上のリスクが生じる可能性があるため、注意して使用してください。さらに、 *を使用すると、TiDB に直接接続する内部コンポーネント (TiDB ダッシュボードなど) が使用できなくなる可能性もあります。

ノート：
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 (秒)

警告

v6.3.0 以降、このパラメーターは非推奨になりました。 PROXY プロトコルヘッダーはネットワークデータの初回読み取り時に読み取られるため、使用されなくなりました。このパラメーターを非推奨にすることで、ネットワークデータが初めて読み取られるときに設定されたタイムアウトへの影響を回避できます。

ノート：
値を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 が使用するストレージエンジンを指定します。
デフォルト: "unistore"
「unistore」または「tikv」を選択できます。 (「unistore」はローカルストレージエンジン、「tikv」は分散ストレージエンジン)

`--token-limit`

TiDB で同時に実行できるセッションの数。交通整理に使用しています。
デフォルト: 1000
同時セッション数がtoken-limitより大きい場合、リクエストはブロックされ、完了した操作がトークンを解放するのを待ちます。

`-V`

TiDBのバージョンを出力します
デフォルト: ""

`--plugin-dir`

プラグインの格納ディレクトリ。
デフォルト: "/data/deploy/plugin"

`--plugin-load`

ロードするプラグインの名前。それぞれをカンマで区切ります。
デフォルト: ""

`--affinity-cpus`

コンマで区切られた TiDB サーバーの CPU アフィニティを設定します。たとえば、「1,2,3」です。
デフォルト: ""

`--repair-mode`

データ修復シナリオでのみ使用される修復モードを有効にするかどうかを決定します。
デフォルト: false

`--repair-list`

修復モードで修復されるテーブルの名前。
デフォルト: ""