TiDB固有の機能

次の関数はTiDB 拡張機能であり、MySQL には存在しません。

例

このセクションでは、上記の関数のいくつかの例を示します。

TIDB_デコードキー

次の例では、テーブルt1に TiDB によって生成された隠しrowidあります。ステートメントではTIDB_DECODE_KEYが使用されています。結果から、隠しrowidがデコードされて出力されていることがわかります。これは、クラスター化されていない主キーの一般的な結果です。

SELECT START_KEY, TIDB_DECODE_KEY(START_KEY) FROM information_schema.tikv_region_status WHERE table_name='t1' AND REGION_ID=2\G

*************************** 1. row ***************************
                 START_KEY: 7480000000000000FF3B5F728000000000FF1DE3F10000000000FA
TIDB_DECODE_KEY(START_KEY): {"_tidb_rowid":1958897,"table_id":"59"}
1 row in set (0.00 sec)

次の例では、テーブルt2に複合クラスター化主キーがあります。JSON 出力から、主キーの一部である両方の列の名前と値を含むhandleを確認できます。

SHOW CREATE TABLE t2\G

*************************** 1. row ***************************
       Table: t2
Create Table: CREATE TABLE `t2` (
  `id` binary(36) NOT NULL,
  `a` tinyint(3) unsigned NOT NULL,
  `v` varchar(512) DEFAULT NULL,
  PRIMARY KEY (`a`,`id`) /*T![clustered_index] CLUSTERED */
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin
1 row in set (0.001 sec)

SELECT * FROM information_schema.tikv_region_status WHERE table_name='t2' LIMIT 1\G

*************************** 1. row ***************************
                REGION_ID: 48
                START_KEY: 7480000000000000FF3E5F720400000000FF0000000601633430FF3338646232FF2D64FF3531632D3131FF65FF622D386337352DFFFF3830653635303138FFFF61396265000000FF00FB000000000000F9
                  END_KEY:
                 TABLE_ID: 62
                  DB_NAME: test
               TABLE_NAME: t2
                 IS_INDEX: 0
                 INDEX_ID: NULL
               INDEX_NAME: NULL
           EPOCH_CONF_VER: 1
            EPOCH_VERSION: 38
            WRITTEN_BYTES: 0
               READ_BYTES: 0
         APPROXIMATE_SIZE: 136
         APPROXIMATE_KEYS: 479905
  REPLICATIONSTATUS_STATE: NULL
REPLICATIONSTATUS_STATEID: NULL
1 row in set (0.005 sec)

SELECT tidb_decode_key('7480000000000000FF3E5F720400000000FF0000000601633430FF3338646232FF2D64FF3531632D3131FF65FF622D386337352DFFFF3830653635303138FFFF61396265000000FF00FB000000000000F9');

+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tidb_decode_key('7480000000000000FF3E5F720400000000FF0000000601633430FF3338646232FF2D64FF3531632D3131FF65FF622D386337352DFFFF3830653635303138FFFF61396265000000FF00FB000000000000F9') |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| {"handle":{"a":"6","id":"c4038db2-d51c-11eb-8c75-80e65018a9be"},"table_id":62}                                                                                                        |
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
1 row in set (0.001 sec)

テーブルの最初のリージョンは、テーブルのtable_idのみを含むキーで始まります。テーブルの最後のリージョンはtable_id + 1で終わります。その間のリージョンには、 _tidb_rowidまたはhandleを含む長いキーがあります。

SELECT
  TABLE_NAME,
  TIDB_DECODE_KEY(START_KEY),
  TIDB_DECODE_KEY(END_KEY)
FROM
  information_schema.TIKV_REGION_STATUS
WHERE
  TABLE_NAME='stock'
  AND IS_INDEX=0
ORDER BY
  START_KEY;

+------------+-----------------------------------------------------------+-----------------------------------------------------------+
| TABLE_NAME | TIDB_DECODE_KEY(START_KEY)                                | TIDB_DECODE_KEY(END_KEY)                                  |
+------------+-----------------------------------------------------------+-----------------------------------------------------------+
| stock      | {"table_id":143}                                          | {"handle":{"s_i_id":"32485","s_w_id":"3"},"table_id":143} |
| stock      | {"handle":{"s_i_id":"32485","s_w_id":"3"},"table_id":143} | {"handle":{"s_i_id":"64964","s_w_id":"5"},"table_id":143} |
| stock      | {"handle":{"s_i_id":"64964","s_w_id":"5"},"table_id":143} | {"handle":{"s_i_id":"97451","s_w_id":"7"},"table_id":143} |
| stock      | {"handle":{"s_i_id":"97451","s_w_id":"7"},"table_id":143} | {"table_id":145}                                          |
+------------+-----------------------------------------------------------+-----------------------------------------------------------+
4 rows in set (0.031 sec)

TIDB_DECODE_KEY成功した場合は有効な JSON を返し、デコードに失敗した場合は引数の値を返します。

TIDB_デコードプラン

スロー クエリ ログには、エンコードされた形式の TiDB 実行プランが記録されています。1 関数は、エンコードされたプランTIDB_DECODE_PLAN()人間が読める形式にデコードするために使用されます。

この関数は、ステートメントの実行時にプランがキャプチャされるため便利です。 EXPLAINのステートメントを再実行すると、データの分布と統計が時間の経過とともに変化するため、異なる結果が生成される場合があります。

SELECT tidb_decode_plan('8QIYMAkzMV83CQEH8E85LjA0CWRhdGE6U2VsZWN0aW9uXzYJOTYwCXRpbWU6NzEzLjHCtXMsIGxvb3BzOjIsIGNvcF90YXNrOiB7bnVtOiAxLCBtYXg6IDU2OC41wgErRHByb2Nfa2V5czogMCwgcnBjXxEpAQwFWBAgNTQ5LglZyGNvcHJfY2FjaGVfaGl0X3JhdGlvOiAwLjAwfQkzLjk5IEtCCU4vQQoxCTFfNgkxXzAJMwm2SGx0KHRlc3QudC5hLCAxMDAwMCkNuQRrdgmiAHsFbBQzMTMuOMIBmQnEDDk2MH0BUgEEGAoyCTQzXzUFVwX1oGFibGU6dCwga2VlcCBvcmRlcjpmYWxzZSwgc3RhdHM6cHNldWRvCTk2ISE2aAAIMTUzXmYA')\G

*************************** 1. row ***************************
  tidb_decode_plan('8QIYMAkzMV83CQEH8E85LjA0CWRhdGE6U2VsZWN0aW9uXzYJOTYwCXRpbWU6NzEzLjHCtXMsIGxvb3BzOjIsIGNvcF90YXNrOiB7bnVtOiAxLCBtYXg6IDU2OC41wgErRHByb2Nfa2V5czogMCwgcnBjXxEpAQwFWBAgNTQ5LglZyGNvcHJfY2FjaGVfaGl0X3JhdGlvOiAwLjAwfQkzLjk5IEtCCU4vQQoxCTFfNgkxXz:     id                     task         estRows    operator info                              actRows    execution info                                                                                                                         memory     disk
    TableReader_7          root         319.04     data:Selection_6                           960        time:713.1µs, loops:2, cop_task: {num: 1, max: 568.5µs, proc_keys: 0, rpc_num: 1, rpc_time: 549.1µs, copr_cache_hit_ratio: 0.00}    3.99 KB    N/A
    └─Selection_6          cop[tikv]    319.04     lt(test.t.a, 10000)                        960        tikv_task:{time:313.8µs, loops:960}                                                                                                   N/A        N/A
      └─TableFullScan_5    cop[tikv]    960        table:t, keep order:false, stats:pseudo    960        tikv_task:{time:153µs, loops:960}                                                                                                     N/A        N/A

TIDB_PARSE_TSO

TIDB_PARSE_TSO関数は、TiDB TSO タイムスタンプから物理タイムスタンプを抽出するために使用できます。TSO は Time Stamp Oracle の略で、PD (Placement Driver) によってトランザクションごとに発行される単調に増加するタイムスタンプです。

TSO は 2 つの部分で構成される番号です。

• 物理的なタイムスタンプ
• 論理的なカウンター

BEGIN;
SELECT TIDB_PARSE_TSO(@@tidb_current_ts);
ROLLBACK;

+-----------------------------------+
| TIDB_PARSE_TSO(@@tidb_current_ts) |
+-----------------------------------+
| 2021-05-26 11:33:37.776000        |
+-----------------------------------+
1 row in set (0.0012 sec)

ここでTIDB_PARSE_TSO 、セッション変数tidb_current_tsで使用可能なタイムスタンプ番号から物理的なタイムスタンプを抽出するために使用されます。タイムスタンプはトランザクションごとに発行されるため、この関数はトランザクション内で実行されます。

TIDB_バージョン

TIDB_VERSION関数を使用すると、接続している TiDBサーバーのバージョンとビルドの詳細を取得できます。この関数は、GitHub で問題を報告するときに使用できます。

SELECT TIDB_VERSION()\G

*************************** 1. row ***************************
TIDB_VERSION(): Release Version: v5.1.0-alpha-13-gd5e0ed0aa-dirty
Edition: Community
Git Commit Hash: d5e0ed0aaed72d2f2dfe24e9deec31cb6cb5fdf0
Git Branch: master
UTC Build Time: 2021-05-24 14:39:20
GoVersion: go1.13
Race Enabled: false
TiKV Min Version: v3.0.0-60965b006877ca7234adaced7890d7b029ed1306
Check Table Before Drop: false
1 row in set (0.00 sec)

TIDB_DECODE_SQL_DIGESTS

TIDB_DECODE_SQL_DIGESTS()関数は、クラスター内の SQL ダイジェストのセットに対応する正規化された SQL ステートメント (形式と引数のない形式) を照会するために使用されます。この関数は、1 つまたは 2 つの引数を受け入れます。

• digests : 文字列。このパラメータは JSON 文字列配列の形式であり、配列内の各文字列は SQL ダイジェストです。
• stmtTruncateLength : 整数 (オプション)。返される結果内の各 SQL ステートメントの長さを制限するために使用されます。SQL ステートメントが指定された長さを超える場合、ステートメントは切り捨てられます。2 0長さが無制限であることを意味します。

この関数は、JSON 文字列配列の形式の文字列を返します。配列のi番目の項目は、 digestsパラメータのi番目の要素に対応する正規化された SQL 文です。 digestsパラメータの要素が有効な SQL ダイジェストでないか、システムが対応する SQL 文を見つけられない場合、返される結果の対応する項目はnullです。切り捨て長が指定されている場合 ( stmtTruncateLength > 0 )、返される結果でこの長さを超える各文については、最初のstmtTruncateLength文字が保持され、切り捨てを示すために末尾にサフィックス"..."が追加されます。 digestsパラメータがNULLの場合、関数の戻り値はNULLです。

注記：

• この機能を使用できるのは、権限プロセスを持つユーザーのみです。
• TIDB_DECODE_SQL_DIGESTS実行すると、TiDB は各 SQL ダイジェストに対応するステートメントをステートメント サマリー テーブルから照会するため、どの SQL ダイジェストに対しても必ず対応するステートメントが見つかるという保証はありません。見つかるのはクラスター内で実行されたステートメントのみであり、これらの SQL ステートメントを照会できるかどうかは、ステートメント サマリー テーブルの関連設定にも影響されます。ステートメント サマリー テーブルの詳細な説明については、 ステートメント要約表を参照してください。
• この関数には高いオーバーヘッドがあります。多数の行を含むクエリ (たとえば、大規模でビジーなクラスター上のinformation_schema.cluster_tidb_trxのテーブル全体をクエリする) では、この関数を使用するとクエリの実行時間が長くなりすぎる可能性があります。注意して使用してください。
  • この関数は、呼び出されるたびに内部的にSTATEMENTS_SUMMARY 、 STATEMENTS_SUMMARY_HISTORY 、 CLUSTER_STATEMENTS_SUMMARY 、およびCLUSTER_STATEMENTS_SUMMARY_HISTORYテーブルを照会し、その照会にUNION操作が含まれるため、オーバーヘッドが高くなります。この関数は現在ベクトル化をサポートしていません。つまり、複数行のデータに対してこの関数を呼び出すと、上記のクエリが各行に対して個別に実行されます。

set @digests = '["e6f07d43b5c21db0fbb9a31feac2dc599787763393dd5acbfad80e247eb02ad5","38b03afa5debbdf0326a014dbe5012a62c51957f1982b3093e748460f8b00821","e5796985ccafe2f71126ed6c0ac939ffa015a8c0744a24b7aee6d587103fd2f7"]';

select tidb_decode_sql_digests(@digests);

+------------------------------------+
| tidb_decode_sql_digests(@digests)  |
+------------------------------------+
| ["begin",null,"select * from `t`"] |
+------------------------------------+
1 row in set (0.00 sec)

上記の例では、パラメータは 3 つの SQL ダイジェストを含む JSON 配列であり、対応する SQL 文はクエリ結果の 3 つの項目です。ただし、2 番目の SQL ダイジェストに対応する SQL 文はクラスターから見つからないため、結果の 2 番目の項目はnullになります。

select tidb_decode_sql_digests(@digests, 10);

+---------------------------------------+
| tidb_decode_sql_digests(@digests, 10) |
+---------------------------------------+
| ["begin",null,"select * f..."]        |
+---------------------------------------+
1 row in set (0.01 sec)

上記の呼び出しでは、2 番目のパラメーター (つまり、切り捨ての長さ) が 10 に指定されていますが、クエリ結果の 3 番目のステートメントの長さは 10 を超えています。したがって、最初の 10 文字のみが保持され、最後に切り捨てを示す"..."が追加されます。

参照:

• Statement Summary Tables
• INFORMATION_SCHEMA.TIDB_TRX

TIDB_シャード

TIDB_SHARD関数を使用すると、インデックス ホットスポットを分散するためのシャード インデックスを作成できます。シャード インデックスは、 TIDB_SHARD関数がプレフィックスとして付いた式インデックスです。

• 作成:

  インデックスフィールドaのシャードインデックスを作成するには、 uk((tidb_shard(a)), a))使用できます。一意のセカンダリインデックスuk((tidb_shard(a)), a))のインデックスフィールドaのデータが単調に増加または減少することによってホットスポットが発生した場合、インデックスのプレフィックスtidb_shard(a)によってホットスポットを分散させ、クラスターのスケーラビリティを向上させることができます。

• シナリオ:

  • 一意のセカンダリ インデックス上のキーが単調に増加または減少することによって書き込みホットスポットが発生し、インデックスに整数型のフィールドが含まれています。
  • SQL ステートメントは、セカンダリ インデックスのすべてのフィールドに基づいて、個別のSELECTとして、またはUPDATE 、 DELETEなどで生成された内部クエリとして、等価クエリを実行します。等価クエリには、 a = 1またはa IN (1, 2, ......) 2 つの方法があります。

• 制限事項:

  • 不等式クエリでは使用できません。
  • ORと最外部のAND演算子が混在するクエリでは使用できません。
  • GROUP BY節では使用できません。
  • ORDER BY節では使用できません。
  • ON節では使用できません。
  • WHEREサブクエリでは使用できません。
  • 整数フィールドのみの一意のインデックスを分散するために使用できます。
  • 複合インデックスでは効果がない可能性があります。
  • FastPlan プロセスを実行できないため、オプティマイザーのパフォーマンスに影響します。
  • 実行プラン キャッシュの準備には使用できません。

次の例は、 TIDB_SHARD関数の使用方法を示しています。

• TIDB_SHARD関数を使用して SHARD 値を計算します。

  次のステートメントは、 TIDB_SHARD関数を使用して12373743746の SHARD 値を計算する方法を示しています。

  SELECT TIDB_SHARD(12373743746);
  

• SHARD 値は次のとおりです。

  +-------------------------+
  | TIDB_SHARD(12373743746) |
  +-------------------------+
  |                     184 |
  +-------------------------+
  1 row in set (0.00 sec)
  

• TIDB_SHARD関数を使用してシャード インデックスを作成します。

  CREATE TABLE test(id INT PRIMARY KEY CLUSTERED, a INT, b INT, UNIQUE KEY uk((tidb_shard(a)), a));
  

TIDB_ROW_CHECKSUM

TIDB_ROW_CHECKSUM関数は、行のチェックサム値を照会するために使用されます。この関数は、FastPlan プロセス内のSELECTステートメントでのみ使用できます。つまり、 SELECT TIDB_ROW_CHECKSUM() FROM t WHERE id = ?やSELECT TIDB_ROW_CHECKSUM() FROM t WHERE id IN (?, ?, ...)などのステートメントを通じて照会できます。

TiDB 内の単一行データのチェックサム機能を有効にするには (システム変数tidb_enable_row_level_checksumによって制御されます)、次のステートメントを実行します。

SET GLOBAL tidb_enable_row_level_checksum = ON;

テーブルtを作成し、データを挿入します。

USE test;
CREATE TABLE t (id INT PRIMARY KEY, k INT, c int);
INSERT INTO TABLE t values (1, 10, a);

次のステートメントは、表tの行id = 1のチェックサム値を照会する方法を示しています。

SELECT *, TIDB_ROW_CHECKSUM() FROM t WHERE id = 1;

出力は次のようになります。

+----+------+------+---------------------+
| id | k    | c    | TIDB_ROW_CHECKSUM() |
+----+------+------+---------------------+
|  1 |   10 | a    | 3813955661          |
+----+------+------+---------------------+
1 row in set (0.000 sec)

現在のリソースグループ

CURRENT_RESOURCE_GROUP機能は、現在のセッションがバインドされているリソース グループ名を表示するために使用されます。3 リソース管理を有効にすると、SQL ステートメントで使用できるリソースは、バインドされたリソース グループのリソース クォータによって制限されます。

セッションが確立されると、TiDB は、ログイン ユーザーがデフォルトでバインドされているリソース グループにセッションをバインドします。ユーザーがどのリソース グループにもバインドされていない場合、セッションはdefaultリソース グループにバインドされます。セッションが確立されると、ユーザーのバインドされているリソース グループがユーザーにバインドされたリソース グループを変更するで変更されたとしても、バインドされているリソース グループはデフォルトでは変更されません。現在のセッションのバインドされているリソース グループを変更するには、 SET RESOURCE GROUPを使用できます。

例

ユーザーuser1を作成し、 2 つのリソース グループrg1とrg2を作成し、ユーザーuser1をリソース グループrg1にバインドします。

CREATE USER 'user1';
CREATE RESOURCE GROUP 'rg1' RU_PER_SEC = 1000;
CREATE RESOURCE GROUP 'rg2' RU_PER_SEC = 2000;
ALTER USER 'user1' RESOURCE GROUP `rg1`;

user1使用してログインし、現在のユーザーにバインドされているリソース グループを表示します。

SELECT CURRENT_RESOURCE_GROUP();

+--------------------------+
| CURRENT_RESOURCE_GROUP() |
+--------------------------+
| rg1                      |
+--------------------------+
1 row in set (0.00 sec)

SET RESOURCE GROUPを実行して、現在のセッションのリソース グループをrg2に設定し、現在のユーザーにバインドされているリソース グループを表示します。

SET RESOURCE GROUP `rg2`;
SELECT CURRENT_RESOURCE_GROUP();

+--------------------------+
| CURRENT_RESOURCE_GROUP() |
+--------------------------+
| rg2                      |
+--------------------------+
1 row in set (0.00 sec)