Repository navigation
information-schema, develop, ai: fix wrong values, links, and wording - #24489
ti-chi-bot[bot] merged 4 commits into
Conversation
- 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 `<DATABASE_NAME>`, the placeholder that the connection URL uses. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Skipping CI for Draft Pull Request. |
ti-chi-bot
Bot
added
do-not-merge/work-in-progress
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
AI integration references ai/integrations/vector-search-auto-embedding-overview.md, ai/integrations/vector-search-integrate-with-langchain.md, ai/integrations/vector-search-integrate-with-llamaindex.md |
The vector-search function description now identifies cosine distance. LangChain and LlamaIndex connection examples and database parameter descriptions use <DATABASE_NAME>. |
Developer guide references develop/dev-guide-create-database.md, develop/dev-guide-object-naming-guidelines.md, develop/dev-guide-third-party-tools-compatibility.md, develop/dev-guide-use-temporary-tables.md, develop/serverless-driver.md |
The guides update database terminology, clarify what ON COMMIT DELETE ROWS removes, correct a support-page link, and use the decoders option name. |
Information-schema references information-schema/information-schema-analyze-status.md, information-schema/information-schema-engines.md, information-schema/information-schema-memory-usage-ops-history.md, information-schema/information-schema-statistics.md, information-schema/information-schema-tables.md, information-schema/information-schema-tidb-hot-regions.md |
The documentation updates the ANALYZE_STATUS example row count, corrects the ENGINE column name, fixes link formatting and punctuation, and clarifies CREATE_OPTIONS. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Other
Suggested reviewers: qiancai
Merge Risk: 
70a16
-
The documentation corrections are ready to merge with no identified user-facing risk.
Architecture risk: 
c0cb1
-
The change affects 3 systems.
Changed systems:
information-schema,develop,aiArchitecture concerns
No architecture-level concerns identified.Review details
-
Systems and components
- observed — information-schema (service) was modified; 6 changed files map to changed impact.
- observed — develop (service) was modified; 5 changed files map to changed impact.
- observed — ai (service) was modified; 3 changed files map to changed impact.
Before / after behavior
- observed — Modified behavior in ai/integrations/vector-search-auto-embedding-overview.md: Changed the
VEC_EMBED_COSINE_DISTANCE()documentation from describing cosine similarity to describing cosine distance. - observed — Modified behavior in ai/integrations/vector-search-integrate-with-langchain.md: Renamed the documented database connection parameter placeholder from
<DATABASE>to<DATABASE_NAME>. - observed — Modified behavior in ai/integrations/vector-search-integrate-with-llamaindex.md: Renamed the documented connection-string database parameter from
<DATABASE>to<DATABASE_NAME>. - observed — Modified behavior in develop/dev-guide-create-database.md: Updated the instruction text from “library build statement” to “database creation statement.”
-
Pre-merge checks: 
-
Check name Status Explanation Description check The description clearly explains the documentation fixes, affected files, target versions, AI involvement, and applicable change categories. All required sections are present. Title check The title concisely identifies the affected documentation areas and the primary fixes to incorrect values, links, and wording. Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (4 skipped: 4 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
ti-chi-bot
Bot
added
missing-translation-status
ti-chi-bot
Bot
removed
the
do-not-merge/work-in-progress
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
31ce7cb2-9271-4ef5-af4c-8e60db03769e
📒 Files selected for processing: 14
ai/integrations/vector-search-auto-embedding-overview.mdai/integrations/vector-search-integrate-with-langchain.mdai/integrations/vector-search-integrate-with-llamaindex.mddevelop/dev-guide-create-database.mddevelop/dev-guide-object-naming-guidelines.mddevelop/dev-guide-third-party-tools-compatibility.mddevelop/dev-guide-use-temporary-tables.mddevelop/serverless-driver.mdinformation-schema/information-schema-analyze-status.mdinformation-schema/information-schema-engines.mdinformation-schema/information-schema-memory-usage-ops-history.mdinformation-schema/information-schema-statistics.mdinformation-schema/information-schema-tables.mdinformation-schema/information-schema-tidb-hot-regions.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.
…at comments The connection URL and the parameter list now use <DATABASE_NAME>, so use it in the "Connection string format" comments too. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…uideline "Metrics" means measurements; the guideline means naming criteria. The Japanese translation rendered it literally as "indicators". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ti-chi-bot
Bot
added
size/M
ti-chi-bot
Bot
removed
the
missing-translation-status
| **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: |
There was a problem hiding this comment.
The TypeScript example just below this sentence still contains a code comment reading "You can also configure the decoder option at the SQL level to override the decoders with the same keys at the connection level." — since the option is decoders, consider updating that comment to "the decoders option" for consistency.
[LGTM Timeline notifier]Timeline:
|
qiancai
added
the
needs-cherry-pick-release-8.5
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
In response to a cherrypick label: new pull request created to branch |
What is changed, added, or deleted? (Required)
Fix wrong values, links, and wording in the INFORMATION_SCHEMA, developer guide, and AI docs. These errors were found while reviewing the English docs for issues that affect the Japanese translation. Each fix is shown below; the same wrong text was also searched for in the rest of the docs. Two items (
CREATE_OPTIONSand "library") are wording fixes: the current English made the Japanese translation wrong.ENGINESENGINE(the table column)[TIDB_HOT_REGIONS_HISTORY](…)" (the link is inside a code span)TIDB_HOT_REGIONS_HISTORY"CREATE_OPTIONS: "Creates options."CREATE TABLE." (The Japanese translation rendered the old text as 「オプションを作成します」, "creates options".)`tidb_server_memory_limit`](…)(missing[)[`tidb_server_memory_limit`](…)ExpressionFor the index key …"Expression: For …"ON COMMIT DELETE ROWS"means the table will be deleted"decoderoption"decoders(as in the example)VEC_EMBED_COSINE_DISTANCE(): "Calculates cosine similarity"<DATABASE>, but the connection URL uses<DATABASE_NAME><DATABASE_NAME>Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
🤖 Generated with Claude Code
Summary by CodeRabbit