*: clarify feature availability on Starter and Essential clusters #21509
Conversation
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.
lilin90
added
translation/no-need
ti-chi-bot
bot
added
the
size/L
![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 @lilin90, 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 focuses on improving the precision of the TiDB documentation by extending the scope of feature unavailability notes. Previously, certain features and INFORMATION_SCHEMA tables were documented as unavailable only on TiDB Cloud Starter clusters. This PR updates these notes to correctly include Essential clusters as well, ensuring users have accurate information regarding functionality across different TiDB Cloud service tiers.
Highlights
- Documentation Accuracy: Updated various documentation pages to accurately reflect feature unavailability on TiDB Cloud's 'Essential' cluster tier, in addition to the 'Starter' tier.
- Feature Availability Clarification: Clarified the limitations of several TiDB features and
INFORMATION_SCHEMAtables, such as JSON functions, Index Advisor, variousCLUSTER_andTIKV_tables, SQL statements for resource management, backup/restore, and more, for specific cloud cluster types.
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. ↩
Replaces plain '{{{ .essential }}}' mentions with proper links to the Essential tier documentation across all feature and table availability notes. Ensures consistent formatting and accurate references for TiDB Cloud Starter and Essential cluster limitations.
|
Warning Gemini encountered an error creating the review. You can try again by commenting |
Updated multiple documentation files to include references to the Essential tier ({{{ .essential }}}) alongside Starter and other TiDB Cloud tiers. Adjusted compatibility notes, feature support, and configuration instructions to reflect Essential tier availability and limitations.
ti-chi-bot
bot
added
area/develop
Co-authored-by: Grace Cai <[email protected]>
Replaces all occurrences of <div label="{{{ .starter }}}"> with <div label="{{{ .starter }}} or Essential"> across multiple developer guide and vector search documentation files. This clarifies that instructions apply to both Starter and Essential cluster types.
[LGTM Timeline notifier]Timeline:
|
|
/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 |
ti-chi-bot
bot
merged commit d7c28f7
into
pingcap:feature/preview-starter
lilin90
added
translation/doing
lilin90
changed the title
lilin90
added
translation/done
lilin90
added
needs-cherry-pick-master
|
In response to a cherrypick label: new pull request created to branch |
Signed-off-by: ti-chi-bot <[email protected]>
Signed-off-by: ti-chi-bot <[email protected]>
|
In response to a cherrypick label: new pull request created to branch |
|
In response to a cherrypick label: new pull request created to branch |
Signed-off-by: ti-chi-bot <[email protected]>
…1509) (#21550) Co-authored-by: Lilian Lee <[email protected]>
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?