*: clarify feature availability on Starter and Essential clusters (#21509) #21550
Conversation
Signed-off-by: ti-chi-bot <[email protected]>
ti-chi-bot
added
area/develop
|
@lilin90 This PR has conflicts, I have hold it. |
|
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository. |
ti-chi-bot
bot
added
size/XXL
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, 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!
I've updated the documentation to clarify the availability of various features and INFORMATION_SCHEMA tables across TiDB Cloud Starter and Essential clusters. Previously, some features were only noted as unavailable on Starter clusters, but this change extends that clarification to Essential clusters as well. This ensures that our documentation provides accurate and comprehensive information regarding feature support across all TiDB Cloud cluster tiers.
Highlights
- TiDB Cloud Cluster Compatibility Documentation: I've updated numerous documentation pages to accurately reflect feature compatibility and tutorial applicability for both TiDB Cloud Starter and Essential clusters. This ensures users have precise information about what works on each tier.
- Introduction of New Feature Documentation: New documentation pages have been added for advanced features such as JSON Schema Validation, Index Advisor, Schema Cache, and specific
ADMIN ALTER DDL JOBSstatements. These new pages include clear notes on their availability across different TiDB Cloud tiers. - Enhanced TiDB Vector Search Documentation: The documentation for TiDB Vector Search has been refined and expanded, including new integration guides for ORMs like peewee and SQLAlchemy. These updates provide detailed information on Vector Search availability and usage across Starter, Essential, and Dedicated clusters.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to clarify feature availability on both TiDB Cloud Starter and Essential clusters. The changes are generally correct and consistent with the goal of the PR. However, a significant number of files contain unresolved merge conflicts, which must be addressed before this PR can be merged. I have added comments to highlight each of these conflicts. Additionally, I've provided a few minor suggestions for grammar and style improvements in the newly added documentation files.
functions-and-operators/json-functions/json-functions-validate.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-validate.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-validate.md
Outdated
Show resolved
Hide resolved
functions-and-operators/json-functions/json-functions-validate.md
Outdated
Show resolved
Hide resolved
lilin90
added
the
translation/done
Deleted documentation files related to JSON validation functions, Index Advisor, schema cache, ADMIN ALTER DDL JOBS, resource control for background tasks and runaway queries, and vector search integration. This change removes detailed guides and references for these features from the documentation set.
Updated multiple vector search documentation pages to clarify that TiDB Vector Search is only available for TiDB Self-Managed (v8.4+) and TiDB Cloud Serverless, and is not available for TiDB Cloud Dedicated. Removed outdated or conflicting notes and instructions regarding feature availability and environment setup for unsupported cluster types.
ti-chi-bot
bot
added
size/XL
|
Note: This is ready for merging. |
|
/unhold |
ti-chi-bot
bot
removed
the
do-not-merge/hold
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lilin90 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 |
This is an automated cherry-pick of #21509
What is changed, added or deleted? (Required)
Updated documentation to indicate that various features and INFORMATION_SCHEMA tables are not available on both TiDB Cloud Starter and Essential clusters, instead of only Starter clusters. This change ensures accurate information about feature availability across different TiDB Cloud cluster tiers.
Note
This PR updated only those files outside the
./tidb-clouddirectory. For changes inside the./tidb-clouddirectory, see #21516.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)?
Do your changes match any of the following descriptions?