TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

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

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

--advertise-address

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

--config

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

--config-check

  • 設定ファイルの有効性をチェックして終了します
  • デフォルト: false

--config-strict

  • 設定ファイルの有効性を強制する
  • デフォルト: false

--cors

  • TiDB HTTPステータスサービスのクロスオリジンリクエスト共有（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"
  • "warn" "fatal" "error" "debug" "info"

--lease

  • スキーマ リースの期間。何をするのか理解していない場合は、値を変更するのは危険です。
  • デフォルト: 45s

--log-file

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

--log-general

  • 一般ログのファイル名
  • デフォルト: ""
  • このオプションが設定されていない場合、一般ログはデフォルトで--log-fileで指定されたファイルに書き込まれます。

--log-slow-query

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

--metrics-addr

  • Prometheus Pushgatewayアドレス
  • デフォルト: ""
  • 空のままにすると、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

  • PROXYプロトコルを使用して 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) を指定できます。3 *任意の 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"

--tidb-service-scope

  • 現在の TiDB インスタンスの初期値tidb_service_scopeを指定します。
  • デフォルト: ""

--token-limit

  • TiDB で同時に実行できるセッションの数。トラフィック制御に使用されます。
  • デフォルト: 1000
  • 同時セッション数がtoken-limitより大きい場合、リクエストはブロックされ、トークンを解放する操作が終了するまで待機します。

-V

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

--plugin-dir

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

--plugin-load

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

--affinity-cpus

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

--redact

  • サブコマンドcollect-logを使用するときに、 TiDBサーバーがログ ファイルを非感度化するかどうかを決定します。
  • デフォルト: false
  • 値がtrueの場合はマスキング操作となり、 ‹ ›マーク記号で囲まれたすべてのフィールドが?に置き換えられます。値がfalseの場合は復元操作となり、すべてのマーク記号が削除されます。この機能を使用するには、 ./tidb-server --redact=xxx collect-log <input> <output>実行して、 <input>で指定した TiDBサーバーログ ファイルを非感応化または復元し、 <output>に出力します。詳細については、システム変数tidb_redact_logを参照してください。

--repair-mode

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

--repair-list

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

このページは役に立ちましたか？