*: clarify feature availability on Starter and Essential clusters (#21509) #21548
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 provide clearer information regarding feature availability and behavior across TiDB Cloud Starter and Essential clusters. This includes specifying which features, INFORMATION_SCHEMA tables, SQL statements, and system variables are either unavailable, have limitations, or behave differently on these cluster types. Additionally, I've added new documentation for several features like JSON schema validation, Index Advisor, Schema Cache, and ADMIN ALTER DDL JOBS, explicitly noting their compatibility with different TiDB tiers. The goal is to ensure users have accurate expectations for their chosen TiDB Cloud cluster.
Highlights
- Clarified Feature Availability for Starter and Essential Clusters: The documentation has been updated to accurately reflect that various features and
INFORMATION_SCHEMAtables are unavailable on both TiDB Cloud Starter and Essential clusters, expanding on previous clarifications that only mentioned Starter clusters. - Introduced JSON Schema Validation Functions: New documentation has been added for JSON functions that validate JSON documents, such as
JSON_SCHEMA_VALID(), explicitly noting their current unavailability on Starter and Essential clusters. - Documented New Index Advisor Feature: A new section introduces the Index Advisor feature, designed to optimize query performance by recommending indexes, with a clear note that this feature is not available on Starter and Essential clusters.
- Added Schema Cache Documentation: Documentation for the Schema Cache mechanism has been added, which helps reduce memory usage in multi-tenant scenarios, and it is noted that this feature is not available on Starter and Essential clusters.
- Documented ADMIN ALTER DDL JOBS Statement: The
ADMIN ALTER DDL JOBSstatement, which allows modification of running DDL jobs, has been documented, along with a note about its unavailability on Starter and Essential clusters. - Updated SLEEP() Function Limitations: The
SLEEP()function documentation now includes a specific limitation of a 300-second maximum sleep time when used on Starter and Essential clusters. - Enhanced IMPORT INTO Documentation: The
IMPORT INTOstatement documentation has been updated to provide detailed information on supported file storage locations (Amazon S3, GCS, Alibaba Cloud OSS) for Starter and Essential clusters. - Clarified LOAD DATA Support: The
LOAD DATAdocumentation now clarifies that Starter and Essential clusters only supportLOAD DATA LOCAL INFILEfor importing data. - Updated LOCK TABLES Compatibility: The
LOCK TABLESdocumentation explicitly states that enabling the table locks feature (enable-table-lock) is not supported on Starter and Essential clusters. - Clarified FLASHBACK CLUSTER Inapplicability: The
FLASHBACK CLUSTERdocumentation now explicitly warns that this syntax is not applicable to Starter and Essential clusters. - Comprehensive Updates Across Features and Variables: Various
INFORMATION_SCHEMAtables, SQL statements (e.g.,ALTER INSTANCE,ALTER PLACEMENT POLICY,BACKUP,QUERY WATCH), and system variables have been updated to consistently reflect their unavailability, read-only status, or specific behaviors on both Starter and Essential clusters. - Introduced New Resource Control Features: New documentation has been introduced for 'Use Resource Control to Manage Background Tasks' and 'Manage Queries That Consume More Resources Than Expected (Runaway Queries)', both of which are noted as unavailable on Starter and Essential clusters.
- Added New Vector Search Integration Guides: New integration guides for TiDB Vector Search with
peeweeandSQLAlchemyhave been added, providing clear details on the feature's availability across different TiDB tiers, including Starter and Essential 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 aims to clarify feature availability on TiDB Cloud Starter and Essential clusters by updating the documentation. The changes primarily involve replacing {{{ .starter }}} with {{{ .starter }}}, {{{ .essential }}} or {{{ .starter }}} or Essential across multiple files. While most changes are correct and consistent with the goal, I've identified several files with merge conflicts that need to be resolved. Additionally, there are a couple of minor inconsistencies in the documentation that could be improved for clarity. Overall, the changes are good, but the merge conflicts are critical and must be addressed.
Cleaned up leftover merge conflict markers across multiple documentation files. Updated TiDB Vector Search documentation to clarify feature availability, removing redundant or outdated notes and ensuring consistent messaging about supported cluster types and versions.
Deleted documentation files for JSON validation functions, Index Advisor, schema cache, admin DDL job alteration, resource control for background tasks, runaway queries, and vector search integration. This change removes detailed guides and references for these features from the documentation set.
ti-chi-bot
bot
added
size/XL
Replaces the reference to TiDB Serverless with template variables for .starter and .essential clusters, and updates the documentation links accordingly for the SLEEP() function limitation.
|
Note: This PR is ready for merging. |
lilin90
added
the
translation/done
|
/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?