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

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

--advertise-address

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

--config

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

--config-check

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

--config-strict

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

--cors

• TiDB HTTPステータスサービスのクロスオリジンリクエストシェアリング（CORS）リクエストにAccess-Control-Allow-Originの値を指定します
• デフォルト： ""

--host

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

--enable-binlog

• TiDBbinlog生成を有効または無効にします
• デフォルト： false

-L

• ログレベル
• デフォルト： "info"
• "error" "fatal" "info" "warn" "debug"

--lease

• スキーマリースの期間。自分が何をしているのかわからない限り、値を変更するのは危険です。
• デフォルト： 45s

--log-file

• ログファイル
• デフォルト： ""
• このオプションが設定されていない場合、ログは「stderr」に出力されます。このオプションが設定されている場合、ログは対応するファイルに出力されます。

--log-slow-query

• 低速クエリログのディレクトリ
• デフォルト： ""
• このオプションが設定されていない場合、ログはデフォルトで--log-fileで指定されたファイルに出力されます。

--metrics-addr

• プロメテウスプッシュゲートウェイの住所
• デフォルト： ""
• 空のままにすると、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:2379,192.168.100.115:2379」になります。 。
• デフォルト： "/tmp/tidb"
• tidb-server --store=unistore --path=""を使用して、純粋なメモリ内TiDBを有効にすることができます。

--proxy-protocol-networks

• PROXYプロトコルを使用して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-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"
• このポートは、サーバーの内部データを取得するために使用されます。データにはプロメテウスメトリクスとpprofが含まれます。
• 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

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

--require-secure-transport

• クライアントがデータ転送にセキュアモードを使用することを要求するかどうかを決定します。
• デフォルト： false