📣
TiDB Cloud Serverless が
Starter
に変わりました！このページは自動翻訳されたものです。
原文はこちらからご覧ください。
TiDB Cloud
TiDB Self-Managed
Learning Center
お問い合わせ

TiDB コントロール ユーザー ガイド

TiDB ControlはTiDBのコマンドラインツールであり、通常はデバッグのためにTiDBのステータス情報を取得するために使用されます。このドキュメントでは、TiDB Controlの機能とその使用方法について説明します。

注記：

TiDB Controlはデバッグ用に特別に設計されており、TiDBに将来導入される機能との互換性が完全には確保されていない可能性があります。情報取得のためにこのツールをアプリケーションやユーティリティの開発に組み込むことは推奨されません。

TiDBコントロールを入手

TiDB Control は、 TiUPを使用してインストールするか、ソース コードからコンパイルすることで入手できます。

注記：

使用する制御ツールのバージョンは、クラスターのバージョンと一致させることをお勧めします。

TiUPを使用して TiDB コントロールをインストールする

TiUPをインストールした後、 tiup ctl:v<CLUSTER_VERSION> tidbコマンドを使用して TiDB Control を取得して実行できます。

ソースコードからコンパイルする

  • コンパイル環境要件: 行く 1.21以降
  • コンパイル手順: TiDB制御プロジェクトのルート ディレクトリに移動し、 makeコマンドを使用してコンパイルし、 tidb-ctl生成します。
  • コンパイル ドキュメント: ヘルプ ファイルはdocディレクトリにあります。ヘルプ ファイルが失われた場合、または更新する場合は、 make docコマンドを使用してヘルプ ファイルを生成します。

使い方の紹介

このセクションでは、 tidb-ctlのコマンド、サブコマンド、オプション、およびフラグの使用方法について説明します。

  • コマンド: -または--のない文字
  • サブコマンド: コマンドの後に続く-または--のない文字
  • オプション: -または--の文字
  • フラグ: コマンド/サブコマンドまたはオプションの直後に続く文字。コマンド/サブコマンドまたはオプションに値を渡す。

使用例: tidb-ctl schema in mysql -n db

  • schema : コマンド
  • in : schemaのサブコマンド
  • mysql ： inのフラグ
  • -n : オプション
  • db ： -nのフラグ

現在、TiDB コントロールには次のサブコマンドがあります。

  • tidb-ctl base64decode : BASE64デコードに使用
  • tidb-ctl decoder : KEYデコードに使用
  • tidb-ctl etcd : etcdの操作に使用
  • tidb-ctl log : ログファイルをフォーマットして、単一行のスタック情報を拡張するために使用されます
  • tidb-ctl mvcc : MVCC情報を取得するために使用される
  • tidb-ctl region :リージョン情報を取得するために使用される
  • tidb-ctl schema : スキーマ情報を取得するために使用される
  • tidb-ctl table : テーブル情報を取得するために使用される

ヘルプを受ける

使用情報を取得するにはtidb-ctl -h/--help使用します。

TiDBコントロールは複数のコマンド層で構成されています。各コマンド／サブコマンドの後に-h/--helpを付けると、それぞれの使用状況情報を取得できます。

次の例は、スキーマ情報を取得する方法を示しています。

使用方法の詳細を取得するには、 tidb-ctl schema -h使用します。 schemaコマンド自体には、 inとtid 2つのサブコマンドがあります。

  • in 、データベース名を通じてデータベース内のすべてのテーブルのテーブル スキーマを取得するために使用されます。
  • tid 、データベース全体で一意のtable_id使用してテーブル スキーマを取得するために使用されます。

グローバルオプション

tidb-ctlには、次の接続関連のグローバル オプションがあります。

  • --host : TiDB サービスアドレス (デフォルト 127.0.0.1)
  • --port : TiDBステータスポート（デフォルト10080）
  • --pdhost : PD サービス アドレス (デフォルト 127.0.0.1)
  • --pdport : PD サービス ポート (デフォルト 2379)
  • --ca : TLS接続に使用されるCAファイルパス
  • --ssl-key : TLS接続に使用されるキーファイルパス
  • --ssl-cert : TLS接続に使用される証明書ファイルパス

--pdhostと--pdport主にetcdサブコマンドで使用されます。例えばtidb-ctl etcd ddlinfoです。アドレスとポートを指定しない場合は、以下のデフォルト値が使用されます。

  • TiDBおよびPDのデフォルトのサービスアドレス： 127.0.0.1 。サービスアドレスはIPアドレスである必要があります。
  • TiDB のデフォルトのサービス ポート: 10080 。
  • PD のデフォルトのサービス ポート: 2379 。

schemaコマンド

inサブコマンド

in 、データベース名を通じてデータベース内のすべてのテーブルのテーブル スキーマを取得するために使用されます。

tidb-ctl schema in <database name>

たとえば、 tidb-ctl schema in mysql実行すると次の結果が返されます。

[
    {
        "id": 13,
        "name": {
            "O": "columns_priv",
            "L": "columns_priv"
        },
              ...
        "update_timestamp": 399494726837600268,
        "ShardRowIDBits": 0,
        "Partition": null
    }
]

結果はJSON形式で表示されます。（上記の出力は切り捨てられています。）

  • テーブル名を指定する場合は、 tidb-ctl schema in <database> -n <table name>使用してフィルタリングします。

    たとえば、 tidb-ctl schema in mysql -n db mysqlデータベース内のdbテーブルのテーブル スキーマを返します。

    {
    "id": 9,
    "name": {
        "O": "db",
        "L": "db"
    },
    ...
    "Partition": null
}

    (上記の出力も切り捨てられています。)

    デフォルトのTiDBサービスアドレスとポートを使用しない場合は、 --hostと--portオプションを使用して設定します。例： tidb-ctl --host 172.16.55.88 --port 8898 schema in mysql -n db 。

tidサブコマンド

tid 、データベース全体で一意のtable_idを使用してテーブルスキーマを取得するために使用されます。4 inコマンドを使用して特定のスキーマのすべてのテーブルIDを取得し、 tidサブコマンドを使用して詳細なテーブル情報を取得できます。

例えば、テーブルID mysql.stat_metaは21です。テーブルID tidb-ctl schema tid -i 21を使用すると、テーブルID mysql.stat_metaの詳細を取得できます。

{
 "id": 21,
 "name": {
  "O": "stats_meta",
  "L": "stats_meta"
 },
 "charset": "utf8mb4",
 "collate": "utf8mb4_bin",
  ...
}

inサブコマンドと同様に、デフォルトの TiDB サービス アドレスとステータス ポートを使用しない場合は、 --hostおよび--portオプションを使用してホストとポートを指定します。

base64decodeコマンド

base64decode base64データをデコードするために使用されます。

tidb-ctl base64decode [base64_data]
tidb-ctl base64decode [db_name.table_name] [base64_data]
tidb-ctl base64decode [table_id] [base64_data]

  1. 環境を準備するには、次の SQL ステートメントを実行します。

    use test;
create table t (a int, b varchar(20),c datetime default current_timestamp , d timestamp default current_timestamp, unique index(a));
insert into t (a,b,c) values(1,"哈哈 hello",NULL);
alter table t add column e varchar(20);

  2. HTTP API インターフェースを使用して MVCC データを取得します。

    $ curl "http://$IP:10080/mvcc/index/test/t/a/1?a=1"
{
 "info": {
  "writes": [
   {
    "start_ts": 407306449994645510,
    "commit_ts": 407306449994645513,
    "short_value": "AAAAAAAAAAE="    # The unique index a stores the handle id of the corresponding row.
   }
  ]
 }
}%

$ curl "http://$IP:10080/mvcc/key/test/t/1"
{
 "info": {
  "writes": [
   {
    "start_ts": 407306588892692486,
    "commit_ts": 407306588892692489,
    "short_value": "CAIIAggEAhjlk4jlk4ggaGVsbG8IBgAICAmAgIDwjYuu0Rk="  # Row data that handle id is 1.
   }
  ]
 }
}%

  3. handle id (uint64) using `base64decode` をデコードします。

    $ tidb-ctl base64decode AAAAAAAAAAE=
hex: 0000000000000001
uint64: 1

  4. base64decodeを使用して行データをデコードします。

    $ ./tidb-ctl base64decode test.t CAIIAggEAhjlk4jlk4ggaGVsbG8IBgAICAmAgIDwjYuu0Rk=
a:      1
b:      哈哈 hello
c is NULL
d:      2019-03-28 05:35:30
e not found in data

# if the table id of test.t is 60, you can also use below command to do the same thing.
$ ./tidb-ctl base64decode 60 CAIIAggEAhjlk4jlk4ggaGVsbG8IBgAICAmAgIDwjYuu0Rk=
a:      1
b:      哈哈 hello
c is NULL
d:      2019-03-28 05:35:30
e not found in data

decoderコマンド

  • 次の例は、インデックス キーのデコードと同様に、行キーをデコードする方法を示しています。

    $ ./tidb-ctl decoder "t\x00\x00\x00\x00\x00\x00\x00\x1c_r\x00\x00\x00\x00\x00\x00\x00\xfa"
format: table_row
table_id: -9223372036854775780      table_id: -9223372036854775780
row_id: -9223372036854775558        row_id: -9223372036854775558

  • 次の例は、 valueデコードする方法を示しています。

    $ ./tidb-ctl decoder AhZoZWxsbyB3b3JsZAiAEA==
format: index_value
type: bigint, value: 1024       index_value[0]: {type: bytes, value: hello world}
index_value[1]: {type: bigint, value: 1024}

etcdコマンド

  • tidb-ctl etcd ddlinfo DDL 情報を取得するために使用されます。

  • tidb-ctl etcd putkey KEY VALUE etcd に KEY VALUE を追加するために使用されます (すべての KEY は/tidb/ddl/all_schema_versions/ディレクトリに追加されます)。

    tidb-ctl etcd putkey "foo" "bar"

    実際には、 KEY が/tidb/ddl/all_schema_versions/fooで VALUE がbarあるキーと値のペアが etcd に追加されます。

  • tidb-ctl etcd delkey etcd 内の KEY を削除します。2 または/tidb/ddl/fg/owner/ /tidb/ddl/all_schema_versions/プレフィックスを持つ KEY のみ削除できます。

    tidb-ctl etcd delkey "/tidb/ddl/fg/owner/foo"
tidb-ctl etcd delkey "/tidb/ddl/all_schema_versions/bar"

logコマンド

TiDBエラーログのスタック情報は1行形式です。1 tidb-ctl log指定すると、複数行形式に変更できます。

keyrangeコマンド

keyrangeサブコマンドは、16 進形式で出力されるグローバルまたはテーブル関連のキー範囲情報を照会するために使用されます。

  • tidb-ctl keyrangeコマンドを実行して、グローバル キー範囲情報を確認します。

    tidb-ctl keyrange

    global ranges:
  meta: (6d, 6e)
  table: (74, 75)

  • エンコードされたキーを表示するには、 --encodeオプションを追加します (TiKV および PD と同じ形式)。

    tidb-ctl keyrange --encode

    global ranges:
  meta: (6d00000000000000f8, 6e00000000000000f8)
  table: (7400000000000000f8, 7500000000000000f8)

  • tidb-ctl keyrange --database={db} --table={tbl}コマンドを実行して、グローバルおよびテーブル関連のキー範囲情報を確認します。

    tidb-ctl keyrange --database test --table ttt

    global ranges:
  meta: (6d, 6e)
  table: (74, 75)
table ttt ranges: (NOTE: key range might be changed after DDL)
  table: (74800000000000002f, 748000000000000030)
  table indexes: (74800000000000002f5f69, 74800000000000002f5f72)
    index c2: (74800000000000002f5f698000000000000001, 74800000000000002f5f698000000000000002)
    index c3: (74800000000000002f5f698000000000000002, 74800000000000002f5f698000000000000003)
    index c4: (74800000000000002f5f698000000000000003, 74800000000000002f5f698000000000000004)
  table rows: (74800000000000002f5f72, 748000000000000030)

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