From 463ab8492d5caa27a3078d3186d98f66f89e88d3 Mon Sep 17 00:00:00 2001 From: Aolin Date: Thu, 21 Dec 2023 16:25:09 +0800 Subject: [PATCH 1/3] Add docs for the I_S keyword table Signed-off-by: Aolin --- TOC.md | 1 + .../information-schema-keywords.md | 49 +++++++++++++++++++ information-schema/information-schema.md | 1 + keywords.md | 2 + 4 files changed, 53 insertions(+) create mode 100644 information-schema/information-schema-keywords.md diff --git a/TOC.md b/TOC.md index 7e58ca26159c..921a7e246555 100644 --- a/TOC.md +++ b/TOC.md @@ -942,6 +942,7 @@ - [`INSPECTION_RESULT`](/information-schema/information-schema-inspection-result.md) - [`INSPECTION_RULES`](/information-schema/information-schema-inspection-rules.md) - [`INSPECTION_SUMMARY`](/information-schema/information-schema-inspection-summary.md) + - [`KEYWORDS`](/information-schema/information-schema-keywords.md) - [`KEY_COLUMN_USAGE`](/information-schema/information-schema-key-column-usage.md) - [`MEMORY_USAGE`](/information-schema/information-schema-memory-usage.md) - [`MEMORY_USAGE_OPS_HISTORY`](/information-schema/information-schema-memory-usage-ops-history.md) diff --git a/information-schema/information-schema-keywords.md b/information-schema/information-schema-keywords.md new file mode 100644 index 000000000000..33c361de6526 --- /dev/null +++ b/information-schema/information-schema-keywords.md @@ -0,0 +1,49 @@ +--- +title: KEYWORDS +summary: 了解 INFORMATION_SCHEMA 表 `KEYWORDS`。 +--- + +# KEYWORDS + +TiDB 从 v7.6.0 开始提供 `KEYWORDS` 表，你可以使用该表查看 TiDB 中[关键字](/keywords.md)的信息。 + +```sql +USE INFORMATION_SCHEMA; +DESC keywords; +``` + +输出结果如下： + +``` ++----------+--------------+------+------+---------+-------+ +| Field | Type | Null | Key | Default | Extra | ++----------+--------------+------+------+---------+-------+ +| WORD | varchar(128) | YES | | NULL | | +| RESERVED | int(11) | YES | | NULL | | ++----------+--------------+------+------+---------+-------+ +2 rows in set (0.00 sec) +``` + +字段含义如下： + +- `WORD`：关键字 +- `RESERVED`：关键字是否为保留关键字 + + +下面的 SQL 语句查询 `ADD` 和 `USER` 关键字的信息： + +```sql +SELECT * FROM keywords WHERE WORD IN ('ADD','USER'); +``` + +输出结果显示 `ADD` 是一个保留关键字，`USER` 是一个非保留关键字。 + +``` ++------+----------+ +| WORD | RESERVED | ++------+----------+ +| ADD | 1 | +| USER | 0 | ++------+----------+ +2 rows in set (0.00 sec) +``` diff --git a/information-schema/information-schema.md b/information-schema/information-schema.md index 340fff130843..a5485df39e10 100644 --- a/information-schema/information-schema.md +++ b/information-schema/information-schema.md @@ -25,6 +25,7 @@ Information Schema 提供了一种查看系统元数据的 ANSI 标准方法。 | `FILES` | TiDB 未实现，返回零行。 | | `GLOBAL_STATUS` | TiDB 未实现，返回零行。 | | `GLOBAL_VARIABLES` | TiDB 未实现，返回零行。 | +| [`KEYWORDS`](/information-schema/information-schema-keywords.md) | 提供关键字列表。 | | [`KEY_COLUMN_USAGE`](/information-schema/information-schema-key-column-usage.md) | 描述列的键约束，例如主键约束。 | | `OPTIMIZER_TRACE` | TiDB 未实现，返回零行。 | | `PARAMETERS` | TiDB 未实现，返回零行。 | diff --git a/keywords.md b/keywords.md index 9e83477276d2..2b0cb18aeb10 100644 --- a/keywords.md +++ b/keywords.md @@ -56,6 +56,8 @@ CREATE TABLE test.select (BEGIN int, END int); Query OK, 0 rows affected (0.08 sec) ``` +TiDB 从 v7.6.0 开始提供 [`INFORMATION_SCHEMA.KEYWORDS`](/information-schema/information-schema-keywords.md) 表，其中包含了所有 TiDB 关键字的信息。 + ## 关键字列表 下表列出了 TiDB 中所有的关键字。其中保留字用 `(R)` 来标识。[窗口函数](/functions-and-operators/window-functions.md)的保留字用 `(R-Window)` 来标识。需要用反引号 `` ` `` 包裹的特殊非保留字用 `(S)` 来标识。 From 4e28be85d784ccd3114d3c265d5b5461a0aac501 Mon Sep 17 00:00:00 2001 From: Aolin Date: Mon, 25 Dec 2023 09:21:02 +0800 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Grace Cai --- information-schema/information-schema-keywords.md | 4 ++-- keywords.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/information-schema/information-schema-keywords.md b/information-schema/information-schema-keywords.md index 33c361de6526..d60e139342d5 100644 --- a/information-schema/information-schema-keywords.md +++ b/information-schema/information-schema-keywords.md @@ -30,10 +30,10 @@ DESC keywords; - `RESERVED`：关键字是否为保留关键字 -下面的 SQL 语句查询 `ADD` 和 `USER` 关键字的信息： +例如，你可以使用以下 SQL 语句查询 `ADD` 和 `USER` 关键字的信息： ```sql -SELECT * FROM keywords WHERE WORD IN ('ADD','USER'); +SELECT * FROM INFORMATION_SCHEMA.KEYWORDS WHERE WORD IN ('ADD','USER'); ``` 输出结果显示 `ADD` 是一个保留关键字，`USER` 是一个非保留关键字。 diff --git a/keywords.md b/keywords.md index 2b0cb18aeb10..02b9fb1c66d0 100644 --- a/keywords.md +++ b/keywords.md @@ -56,7 +56,7 @@ CREATE TABLE test.select (BEGIN int, END int); Query OK, 0 rows affected (0.08 sec) ``` -TiDB 从 v7.6.0 开始提供 [`INFORMATION_SCHEMA.KEYWORDS`](/information-schema/information-schema-keywords.md) 表，其中包含了所有 TiDB 关键字的信息。 +TiDB 从 v7.6.0 开始提供 [`INFORMATION_SCHEMA.KEYWORDS`](/information-schema/information-schema-keywords.md) 表，可以用于查询 TiDB 中所有的关键字。 ## 关键字列表 From 3ee2f47be6a2ae9ed9b8e2d474ac0d17eb9d0cb8 Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 10 Jan 2024 16:32:00 +0800 Subject: [PATCH 3/3] make ci happy --- information-schema/information-schema-keywords.md | 1 - 1 file changed, 1 deletion(-) diff --git a/information-schema/information-schema-keywords.md b/information-schema/information-schema-keywords.md index d60e139342d5..d8dc99412763 100644 --- a/information-schema/information-schema-keywords.md +++ b/information-schema/information-schema-keywords.md @@ -29,7 +29,6 @@ DESC keywords; - `WORD`：关键字 - `RESERVED`：关键字是否为保留关键字 - 例如，你可以使用以下 SQL 语句查询 `ADD` 和 `USER` 关键字的信息： ```sql