From c0cb1df124c574d32d991a677caffd05b8b016d9 Mon Sep 17 00:00:00 2001 From: Yasuo Honda Date: Mon, 19 Oct 2026 17:07:48 +0900 Subject: [PATCH 1/4] information-schema, develop, ai: fix wrong values, links, and wording MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - information-schema-engines.md: the column is `ENGINE`, not `ENGINES`. - information-schema-analyze-status.md: the example result shows 7 rows, not 6. - information-schema-tidb-hot-regions.md: move the backticks inside the link so that the link renders. - information-schema-tables.md: describe `CREATE_OPTIONS` as the extra options used with `CREATE TABLE`. "Creates options." reads as a verb phrase, and the Japanese translation rendered it as 「オプションを作成 します」. - information-schema-memory-usage-ops-history.md: add the missing "[" of the `tidb_server_memory_limit` link. - information-schema-statistics.md: add the missing colon after `Expression`. - dev-guide-use-temporary-tables.md: `ON COMMIT DELETE ROWS` deletes the data in the table, not the table. - dev-guide-create-database.md and dev-guide-object-naming-guidelines.md: "library" means database here; the Japanese translation rendered it literally as 「ライブラリ」. - dev-guide-third-party-tools-compatibility.md: the "third-party tools supported by TiDB" link pointed to the page itself. - serverless-driver.md: the option is `decoders`, as in the example. - vector-search-auto-embedding-overview.md: `VEC_EMBED_COSINE_DISTANCE()` calculates the cosine distance, not the similarity. - vector-search-integrate-with-llamaindex.md and vector-search-integrate-with-langchain.md: describe ``, the placeholder that the connection URL uses. Co-Authored-By: Claude Opus 5.5 --- ai/integrations/vector-search-auto-embedding-overview.md | 2 +- ai/integrations/vector-search-integrate-with-langchain.md | 2 +- ai/integrations/vector-search-integrate-with-llamaindex.md | 2 +- develop/dev-guide-create-database.md | 2 +- develop/dev-guide-object-naming-guidelines.md | 2 +- develop/dev-guide-third-party-tools-compatibility.md | 2 +- develop/dev-guide-use-temporary-tables.md | 2 +- develop/serverless-driver.md | 2 +- information-schema/information-schema-analyze-status.md | 2 +- information-schema/information-schema-engines.md | 2 +- .../information-schema-memory-usage-ops-history.md | 2 +- information-schema/information-schema-statistics.md | 2 +- information-schema/information-schema-tables.md | 2 +- information-schema/information-schema-tidb-hot-regions.md | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/ai/integrations/vector-search-auto-embedding-overview.md b/ai/integrations/vector-search-auto-embedding-overview.md index bbc12a988dc90..9f268ebc1d992 100644 --- a/ai/integrations/vector-search-auto-embedding-overview.md +++ b/ai/integrations/vector-search-auto-embedding-overview.md @@ -149,7 +149,7 @@ Use this function in `GENERATED ALWAYS AS` clauses to automatically generate emb ### `VEC_EMBED_COSINE_DISTANCE()` -Calculates cosine similarity between a stored vector in the vector column and a text query: +Calculates cosine distance between a stored vector in the vector column and a text query: ```sql VEC_EMBED_COSINE_DISTANCE(vector_column, "query_text") diff --git a/ai/integrations/vector-search-integrate-with-langchain.md b/ai/integrations/vector-search-integrate-with-langchain.md index b66cc877e9a8f..cfdc7ed548a9f 100644 --- a/ai/integrations/vector-search-integrate-with-langchain.md +++ b/ai/integrations/vector-search-integrate-with-langchain.md @@ -138,7 +138,7 @@ The following are descriptions for each parameter: - ``: The password to connect to TiDB. - ``: The host of the TiDB cluster. - ``: The port of the TiDB cluster. -- ``: The name of the database you want to connect to. +- ``: The name of the database you want to connect to. diff --git a/ai/integrations/vector-search-integrate-with-llamaindex.md b/ai/integrations/vector-search-integrate-with-llamaindex.md index a2aa701aee73e..9fd20b17b2cd5 100644 --- a/ai/integrations/vector-search-integrate-with-llamaindex.md +++ b/ai/integrations/vector-search-integrate-with-llamaindex.md @@ -137,7 +137,7 @@ The following are descriptions for each parameter: - ``: The password to connect to TiDB. - ``: The host of the TiDB cluster. - ``: The port of the TiDB cluster. -- ``: The name of the database you want to connect to. +- ``: The name of the database you want to connect to. diff --git a/develop/dev-guide-create-database.md b/develop/dev-guide-create-database.md index 2f5780b41cef2..1ea96035cd6d0 100644 --- a/develop/dev-guide-create-database.md +++ b/develop/dev-guide-create-database.md @@ -31,7 +31,7 @@ CREATE DATABASE IF NOT EXISTS `bookshop`; For more information and examples of the `CREATE DATABASE` statement, see the [`CREATE DATABASE`](/sql-statements/sql-statement-create-database.md) document. -To execute the library build statement as the `root` user, run the following command: +To execute the database creation statement as the `root` user, run the following command: ```shell mysql diff --git a/develop/dev-guide-object-naming-guidelines.md b/develop/dev-guide-object-naming-guidelines.md index f854b0220f558..2ca74fc29f6eb 100644 --- a/develop/dev-guide-object-naming-guidelines.md +++ b/develop/dev-guide-object-naming-guidelines.md @@ -17,7 +17,7 @@ This document introduces the rules to name database objects, such as database, t ## Database naming convention -It is recommended to differentiate database names by business, product, or other metrics and use no more than 20 characters in a database name. For example, you can name a temporary library as `tmp_crm` or a test library as `test_crm`. +It is recommended to differentiate database names by business, product, or other metrics and use no more than 20 characters in a database name. For example, you can name a temporary database as `tmp_crm` or a test database as `test_crm`. ## Table naming convention diff --git a/develop/dev-guide-third-party-tools-compatibility.md b/develop/dev-guide-third-party-tools-compatibility.md index 2b5fdfe7ce2bc..d5bd235c22943 100644 --- a/develop/dev-guide-third-party-tools-compatibility.md +++ b/develop/dev-guide-third-party-tools-compatibility.md @@ -19,7 +19,7 @@ aliases: ['/tidb/stable/dev-guide-third-party-tools-compatibility/','/tidb/dev/d > > The preceding unsupported features are expected behavior and are not listed in this document. For more details, see [MySQL Compatibility](/mysql-compatibility.md). -The incompatibility issues listed in this document are found in some [third-party tools supported by TiDB](/develop/dev-guide-third-party-tools-compatibility.md). +The incompatibility issues listed in this document are found in some [third-party tools supported by TiDB](/develop/dev-guide-third-party-support.md). ## General incompatibility diff --git a/develop/dev-guide-use-temporary-tables.md b/develop/dev-guide-use-temporary-tables.md index 4ff583b2f7979..6001c768c7b8f 100644 --- a/develop/dev-guide-use-temporary-tables.md +++ b/develop/dev-guide-use-temporary-tables.md @@ -134,7 +134,7 @@ public List getTop50EldestAuthorInfo() throws SQLException {
-To create a global temporary table, you can add the `GLOBAL` keyword and end with `ON COMMIT DELETE ROWS`, which means the table will be deleted after the current transaction ends. +To create a global temporary table, you can add the `GLOBAL` keyword and end with `ON COMMIT DELETE ROWS`, which means the data in the table will be deleted after the current transaction ends. ```sql CREATE GLOBAL TEMPORARY TABLE IF NOT EXISTS top_50_eldest_authors_global ( diff --git a/develop/serverless-driver.md b/develop/serverless-driver.md index 69b8ba4ffd17b..d479a59c25fe0 100644 --- a/develop/serverless-driver.md +++ b/develop/serverless-driver.md @@ -232,7 +232,7 @@ const tx = await conn.begin({isolation:"READ COMMITTED"}) **decoders** -To customize the format of returned column values, you can configure the `decoder` option in the `connect()` method as follows: +To customize the format of returned column values, you can configure the `decoders` option in the `connect()` method as follows: ```ts import { connect, ColumnType } from '@tidbcloud/serverless'; diff --git a/information-schema/information-schema-analyze-status.md b/information-schema/information-schema-analyze-status.md index 875cccb3f5bb1..e2d04d2cf32cf 100644 --- a/information-schema/information-schema-analyze-status.md +++ b/information-schema/information-schema-analyze-status.md @@ -56,7 +56,7 @@ SELECT * FROM information_schema.analyze_status; | test | t | p0 | analyze columns | 0 | 2022-05-27 11:29:46 | 2022-05-27 11:29:46 | finished | NULL | 127.0.0.1:4000 | NULL | NULL | NULL | NULL | | test | t | p1 | analyze table all columns with 256 buckets, 500 topn, 1 samplerate | 1000000 | 2022-05-27 11:30:12 | 2022-05-27 11:40:12 | running | NULL | 127.0.0.1:4000 | 690208308 | 600s | 0.25 | 4000000 | +--------------+------------+----------------+--------------------------------------------------------------------+----------------+---------------------+---------------------+----------+-------------+----------------+------------+----------------------+----------+-----------------------+ -6 rows in set (0.00 sec) +7 rows in set (0.00 sec) ``` Fields in the `ANALYZE_STATUS` table are described as follows: diff --git a/information-schema/information-schema-engines.md b/information-schema/information-schema-engines.md index 734bad64b44b6..845def7a61dca 100644 --- a/information-schema/information-schema-engines.md +++ b/information-schema/information-schema-engines.md @@ -41,7 +41,7 @@ SELECT * FROM engines; The description of columns in the `ENGINES` table is as follows: -* `ENGINES`: The name of the storage engine. +* `ENGINE`: The name of the storage engine. * `SUPPORT`: The level of support that the server has on the storage engine. In TiDB, the value is always `DEFAULT`. * `COMMENT`: The brief comment on the storage engine. * `TRANSACTIONS`: Whether the storage engine supports transactions. diff --git a/information-schema/information-schema-memory-usage-ops-history.md b/information-schema/information-schema-memory-usage-ops-history.md index 73d8be6f57a32..51f4ef7aaf0d8 100644 --- a/information-schema/information-schema-memory-usage-ops-history.md +++ b/information-schema/information-schema-memory-usage-ops-history.md @@ -51,7 +51,7 @@ The columns in the `MEMORY_USAGE_OPS_HISTORY` table are described as follows: * `TIME`: The timestamp when the session is terminated. * `OPS`: "SessionKill" -* `MEMORY_LIMIT`: The memory usage limit of TiDB at the time of termination, in bytes. Its value is the same as that of the system variable `tidb_server_memory_limit`](/system-variables.md#tidb_server_memory_limit-new-in-v640). +* `MEMORY_LIMIT`: The memory usage limit of TiDB at the time of termination, in bytes. Its value is the same as that of the system variable [`tidb_server_memory_limit`](/system-variables.md#tidb_server_memory_limit-new-in-v640). * `MEMORY_CURRENT`: The current memory usage of TiDB, in bytes. * `PROCESSID`: The connection ID of the terminated session. * `MEM`: The memory usage of the terminated session, in bytes. diff --git a/information-schema/information-schema-statistics.md b/information-schema/information-schema-statistics.md index b353f7a5fbc0e..5d35cfdbc2f5d 100644 --- a/information-schema/information-schema-statistics.md +++ b/information-schema/information-schema-statistics.md @@ -59,7 +59,7 @@ Fields in the `STATISTICS` table are described as follows: * `COMMENT`: Other information related to the index. * `INDEX_COMMENT`: Any comment with comment attribute provided for the index when creating the index. * `IS_VISIBLE`: Whether this index is visible or not. See also [Invisible index](/sql-statements/sql-statement-create-index.md#invisible-index). -* `Expression` For the index key of the non-expression part, this value is `NULL`; for the index key of the expression part, this value is the expression itself. Refer to [Expression Index](/sql-statements/sql-statement-create-index.md#expression-index). +* `Expression`: For the index key of the non-expression part, this value is `NULL`; for the index key of the expression part, this value is the expression itself. Refer to [Expression Index](/sql-statements/sql-statement-create-index.md#expression-index). The following statements are equivalent: diff --git a/information-schema/information-schema-tables.md b/information-schema/information-schema-tables.md index 77eb125c82bde..7d36366e4f313 100644 --- a/information-schema/information-schema-tables.md +++ b/information-schema/information-schema-tables.md @@ -120,7 +120,7 @@ The description of columns in the `TABLES` table is as follows: * `CHECK_TIME`: The time at which the table is checked. * `TABLE_COLLATION`: The collation of strings in the table. * `CHECKSUM`: Checksum. -* `CREATE_OPTIONS`: Creates options. +* `CREATE_OPTIONS`: Extra options used with `CREATE TABLE`. * `TABLE_COMMENT`: The comments and notes of the table. Most of the information in the table is the same as MySQL. The following columns are newly defined by TiDB: diff --git a/information-schema/information-schema-tidb-hot-regions.md b/information-schema/information-schema-tidb-hot-regions.md index 127cc9188d8e1..238840dc38b78 100644 --- a/information-schema/information-schema-tidb-hot-regions.md +++ b/information-schema/information-schema-tidb-hot-regions.md @@ -5,7 +5,7 @@ summary: Learn the `TIDB_HOT_REGIONS` information_schema table. # TIDB_HOT_REGIONS -The `TIDB_HOT_REGIONS` table provides information about the current hot Regions. For information about history hot Regions, see `[TIDB_HOT_REGIONS_HISTORY](/information-schema/information-schema-tidb-hot-regions-history.md)`. +The `TIDB_HOT_REGIONS` table provides information about the current hot Regions. For information about history hot Regions, see [`TIDB_HOT_REGIONS_HISTORY`](/information-schema/information-schema-tidb-hot-regions-history.md). > **Note:** > From 2182ce670f4a7041bad78ad6ce7605001d0c82e3 Mon Sep 17 00:00:00 2001 From: Yasuo Honda Date: Tue, 20 Oct 2026 09:41:47 +0900 Subject: [PATCH 2/4] ai: use the placeholder in the connection string format comments The connection URL and the parameter list now use , so use it in the "Connection string format" comments too. Co-Authored-By: Claude Opus 5.5 --- ai/integrations/vector-search-integrate-with-langchain.md | 4 ++-- ai/integrations/vector-search-integrate-with-llamaindex.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ai/integrations/vector-search-integrate-with-langchain.md b/ai/integrations/vector-search-integrate-with-langchain.md index cfdc7ed548a9f..ddd783f7822ab 100644 --- a/ai/integrations/vector-search-integrate-with-langchain.md +++ b/ai/integrations/vector-search-integrate-with-langchain.md @@ -101,7 +101,7 @@ For a {{{ .starter }}} or Essential instance, take the following steps to obtain import os # Copy your connection string from the TiDB Cloud console. - # Connection string format: "mysql+pymysql://:@:4000/?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true" + # Connection string format: "mysql+pymysql://:@:4000/?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true" tidb_connection_string = getpass.getpass("TiDB Connection String:") os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API Key:") ``` @@ -118,7 +118,7 @@ To configure the environment variables, run the following code. You will be prom import getpass import os -# Connection string format: "mysql+pymysql://:@:4000/?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true" +# Connection string format: "mysql+pymysql://:@:4000/?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true" tidb_connection_string = getpass.getpass("TiDB Connection String:") os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API Key:") ``` diff --git a/ai/integrations/vector-search-integrate-with-llamaindex.md b/ai/integrations/vector-search-integrate-with-llamaindex.md index 9fd20b17b2cd5..d37a8adb53ede 100644 --- a/ai/integrations/vector-search-integrate-with-llamaindex.md +++ b/ai/integrations/vector-search-integrate-with-llamaindex.md @@ -100,7 +100,7 @@ For a {{{ .starter }}} or Essential instance, take the following steps to obtain import os # Copy your connection string from the TiDB Cloud console. - # Connection string format: "mysql+pymysql://:@:4000/?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true" + # Connection string format: "mysql+pymysql://:@:4000/?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true" tidb_connection_string = getpass.getpass("TiDB Connection String:") os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API Key:") ``` @@ -117,7 +117,7 @@ To configure the environment variables, run the following code. You will be prom import getpass import os -# Connection string format: "mysql+pymysql://:@:4000/?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true" +# Connection string format: "mysql+pymysql://:@:4000/?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true" tidb_connection_string = getpass.getpass("TiDB Connection String:") os.environ["OPENAI_API_KEY"] = getpass.getpass("OpenAI API Key:") ``` From 7be83c9c4f75a55c638b6fa89dd2d833a974d42c Mon Sep 17 00:00:00 2001 From: Yasuo Honda Date: Tue, 20 Oct 2026 09:41:47 +0900 Subject: [PATCH 3/4] develop: use "criteria" instead of "metrics" in the database naming guideline "Metrics" means measurements; the guideline means naming criteria. The Japanese translation rendered it literally as "indicators". Co-Authored-By: Claude Opus 5.5 --- develop/dev-guide-object-naming-guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop/dev-guide-object-naming-guidelines.md b/develop/dev-guide-object-naming-guidelines.md index 2ca74fc29f6eb..f9e779b57b3c3 100644 --- a/develop/dev-guide-object-naming-guidelines.md +++ b/develop/dev-guide-object-naming-guidelines.md @@ -17,7 +17,7 @@ This document introduces the rules to name database objects, such as database, t ## Database naming convention -It is recommended to differentiate database names by business, product, or other metrics and use no more than 20 characters in a database name. For example, you can name a temporary database as `tmp_crm` or a test database as `test_crm`. +It is recommended to differentiate database names by business, product, or other criteria and use no more than 20 characters in a database name. For example, you can name a temporary database as `tmp_crm` or a test database as `test_crm`. ## Table naming convention From 70a1650ead38b97f9c96705c7859969ea32cd61d Mon Sep 17 00:00:00 2001 From: Grace Cai Date: Tue, 27 Oct 2026 21:50:43 +0800 Subject: [PATCH 4/4] Update serverless-driver.md --- develop/serverless-driver.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop/serverless-driver.md b/develop/serverless-driver.md index d479a59c25fe0..49e76fca3fb42 100644 --- a/develop/serverless-driver.md +++ b/develop/serverless-driver.md @@ -248,7 +248,7 @@ const conn = connect({ } }) -// You can also configure the decoder option at the SQL level to override the decoders with the same keys at the connection level. +// You can also configure the decoders option at the SQL level to override the decoders with the same keys at the connection level. conn.execute(`select ...`, [], { decoders: { // ...