Skip to content

Conversation

@dveeden
Copy link
Contributor

@dveeden dveeden commented Sep 22, 2025

First-time contributors' checklist

What is changed, added or deleted? (Required)

  • Remove reference manual links for functions for which we have our own docs.
  • Keep links for functions/operators that are not explained in the TiDB docs yet
  • We can keep a link at the top linking to the corresponding page in the MySQL Reference Manual like this: TiDB supports most of the user-level [locking functions](https://dev.mysql.com/doc/refman/8.0/en/locking-functions.html) available in MySQL 8.0.

This was done with sed -E -i -e 's/(^#* )\[(.*)\].*$/\1\2/' path/to/file.md

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@dveeden dveeden requested review from hfxsd, mjonss and qiancai September 22, 2025 17:03
@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 22, 2025
@gemini-code-assist
Copy link

Summary of Changes

Hello @dveeden, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the TiDB documentation by streamlining the user experience for functions and operators. It systematically removes direct links to the MySQL Reference Manual for features that are comprehensively documented within TiDB's own pages. This change aims to keep users within the TiDB documentation ecosystem, providing a more cohesive and self-contained information source, while still acknowledging MySQL compatibility where necessary.

Highlights

  • Documentation Self-Sufficiency: Removed external MySQL Reference Manual links from numerous function and operator documentation pages where TiDB provides its own comprehensive coverage.
  • Improved User Experience: Users will now primarily find information within the TiDB documentation, reducing the need to navigate to external sites for functions already covered.
  • Targeted External Links: External links to the MySQL Reference Manual are now maintained only for functions/operators not yet explained in TiDB's own documentation, or for general reference at the top of relevant pages.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@dveeden
Copy link
Contributor Author

dveeden commented Sep 22, 2025

With this PR:

functions-and-operators/operators.md	75
functions-and-operators/date-and-time-functions.md	62
functions-and-operators/numeric-functions-and-operators.md	38
vector-search/vector-search-functions-and-operators.md	28
functions-and-operators/aggregate-group-by-functions.md	11
tidb-cloud/tidb-cloud-dm-precheck-and-troubleshooting.md	7
scripts/update_mysql_ref.py	7
dm/dm-block-allow-table-lists.md	7
functions-and-operators/string-functions.md	6
functions-and-operators/locking-functions.md	6
functions-and-operators/expressions-pushed-down.md	6
functions-and-operators/control-flow-functions.md	5
character-set-and-collation.md	5
functions-and-operators/cast-functions-and-operators.md	4
dm/dm-glossary.md	4
system-variables.md	3
partitioned-table.md	3
mysql-compatibility.md	3
literal-values.md	3
develop/dev-guide-schema-design-overview.md	3
data-type-string.md	3
data-type-numeric.md	3
vector-search/vector-search-get-started-using-sql.md	2
tidb-lightning/tidb-lightning-data-source.md	2
security-compatibility-with-mysql.md	2
schema-object-names.md	2
releases/release-6.4.0.md	2
functions-and-operators/miscellaneous-functions.md	2
develop/dev-guide-create-table.md	2
user-defined-variables.md	1

And with master:

functions-and-operators/operators.md	75
functions-and-operators/string-functions.md	63
functions-and-operators/date-and-time-functions.md	62
functions-and-operators/numeric-functions-and-operators.md	38
vector-search/vector-search-functions-and-operators.md	28
functions-and-operators/encryption-and-compression-functions.md	13
functions-and-operators/window-functions.md	12
functions-and-operators/json-functions/json-functions-modify.md	11
functions-and-operators/aggregate-group-by-functions.md	11
functions-and-operators/json-functions/json-functions-search.md	9
functions-and-operators/bit-functions-and-operators.md	8
tidb-cloud/tidb-cloud-dm-precheck-and-troubleshooting.md	7
scripts/update_mysql_ref.py	7
dm/dm-block-allow-table-lists.md	7
functions-and-operators/locking-functions.md	6
functions-and-operators/expressions-pushed-down.md	6
functions-and-operators/control-flow-functions.md	5
character-set-and-collation.md	5
functions-and-operators/json-functions/json-functions-return.md	4
functions-and-operators/cast-functions-and-operators.md	4
dm/dm-glossary.md	4
system-variables.md	3
partitioned-table.md	3
mysql-compatibility.md	3
literal-values.md	3
functions-and-operators/json-functions/json-functions-utility.md	3
functions-and-operators/json-functions/json-functions-create.md	3
develop/dev-guide-schema-design-overview.md	3
data-type-string.md	3
data-type-numeric.md	3

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request removes external links to the MySQL Reference Manual from function documentation, which is a good cleanup. My review focuses on ensuring the formatting of the updated headings is consistent with the documentation style guide. I've found several instances in the JSON function documents where function names in headings are missing backticks and have provided suggestions to fix them.

@qiancai qiancai self-assigned this Oct 14, 2025
qiancai and others added 2 commits November 17, 2025 14:20
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@qiancai
Copy link
Collaborator

qiancai commented Nov 17, 2025

@dveeden, I've added some MySQL doc links to the Jason function docs. PTAL. Thanks.

3ea7017 (#21821)

@dveeden
Copy link
Contributor Author

dveeden commented Nov 17, 2025

@dveeden, I've added some MySQL doc links to the Jason function docs. PTAL. Thanks.

3ea7017 (#21821)

In general this is ok. But maybe we should consider to put MySQL compatibility info in a separate section in the end of the document instead? The main goal of these documents should be to describe the functionality of TiDB, both for users that migrate from MySQL but also for TiDB users that didn't start with another database.

As JSON was implemented after MariaDB was forked off, there are many differences between MariaDB and MySQL/TiDB. Also note that there is now an official standard: ISO/IEC 19075-6:2021. So in the future we may want to list MySQL, MariaDB and ISO standard compatibility.

For now there is no need to change anything, please keep this as-is.

@qiancai qiancai added needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. type/enhancement The issue or PR belongs to an enhancement. translation/doing This PR's assignee is translating this PR. area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. and removed missing-translation-status This PR does not have translation status info. labels Nov 17, 2025
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Nov 17, 2025
@ti-chi-bot
Copy link

ti-chi-bot bot commented Nov 17, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-11-17 10:42:36.392544269 +0000 UTC m=+1303605.835574138: ☑️ agreed by hfxsd.

@qiancai
Copy link
Collaborator

qiancai commented Nov 19, 2025

/approve

@qiancai qiancai added the lgtm label Nov 19, 2025
@ti-chi-bot
Copy link

ti-chi-bot bot commented Nov 19, 2025

[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

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added the approved label Nov 19, 2025
@qiancai qiancai removed the translation/doing This PR's assignee is translating this PR. label Nov 19, 2025
@qiancai qiancai added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Nov 19, 2025
@ti-chi-bot ti-chi-bot bot merged commit 8443fb2 into pingcap:master Nov 19, 2025
9 checks passed
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created to branch release-8.5: #22066.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/enhancement The issue or PR belongs to an enhancement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants