重要

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

重要

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

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

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

TiDB コントロールを取得する

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

ノート：
使用するコントロールツールのバージョンは、クラスターのバージョンと一致していることが推奨されます。

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

TiUP をインストールすると、コマンドtiup ctl tidbつで TiDB Control を取得して実行できます。

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

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

使い方紹介

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

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

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

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

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

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 Control は、複数のコマンド層で構成されています。各コマンド/サブコマンドの後に-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を使用してテーブルスキーマを取得するために使用されます。 inサブコマンドを使用して特定のスキーマのすべてのテーブル ID を取得し、 tidサブコマンドを使用して詳細なテーブル情報を取得できます。

たとえば、テーブル ID mysql.stat_metaは21です。 tidb-ctl schema tid -i 21を使用して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]

次の 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);

HTTP API インターフェイスを使用した Obtian 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.
   }
  ]
 }
}%

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

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

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は KEY VALUE を etcd に追加するために使用されます (すべての 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 を削除します。プレフィックスが/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 行形式です。 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)

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

TiDB コントロールを取得する

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

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

使い方紹介

助けを得ます

グローバル オプション

schemaコマンド

inサブコマンド

tidサブコマンド

base64decodeコマンド

decoderコマンド

etcdコマンド

logコマンド

keyrangeコマンド