Serverless changefeed #21272
Serverless changefeed #21272
Conversation
…pingcap#19958) Co-authored-by: Grace Cai <[email protected]> Co-authored-by: xixirangrang <[email protected]> Co-authored-by: Yujie <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
ti-chi-bot
bot
added
area/develop
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
the
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 @shiyuhang0, 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 extensively updates and reorganizes the documentation for TiDB, with a strong focus on differentiating between TiDB Cloud (Serverless and Dedicated) and TiDB Self-Managed offerings. It introduces new sections, clarifies existing ones, updates terminology, and adds documentation for new features like Vector Search, enhanced Data Service APIs, and various CLI/Terraform resources. The changes also include general maintenance such as updating release versions, managing approvers, and ignoring new external links.
Highlights
- Documentation Restructuring: Major reorganization of the TiDB documentation, clearly separating content for TiDB Cloud (Serverless and Dedicated) and TiDB Self-Managed, and introducing new top-level sections like "GET STARTED", "DEVELOP", "GUIDES", "REFERENCE", and "RELEASES" in the Table of Contents.
- New Feature Documentation: Added comprehensive documentation for new features including Vector Search, expanded Data Service APIs (Chat2Query, Custom Domain, Integrations), Disaster Recovery (Recovery Group), and support for Apache Pulsar as a Changefeed sink.
- Terminology and Branding Updates: Consistent renaming of "TiDB Serverless" to "TiDB Cloud Serverless" and "TiDB Dedicated" to "TiDB Cloud Dedicated" across the documentation to align with product branding.
- Tooling and Integration Enhancements: Documented new Terraform resources for managing TiDB Cloud components and updated CLI commands, reflecting expanded automation and integration capabilities.
- Security and Observability Improvements: Added best practices for security configuration, detailed new monitoring metrics for backup/restore, and introduced new system tables for enhanced observability.
- Release and Compatibility Updates: Updated documentation to reflect new TiDB release versions (e.g., 8.1 LTS) and provided detailed compatibility matrices for tools like BR.
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 is currently in preview and 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 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
The code changes involve updates to .lycheeignore, OWNERS, README.md, TOC-tidb-cloud.md, TOC.md, _docHome.md, _index.md, and various other files. These updates include adding new URLs to the ignore list, modifying approvers, updating documentation, and reorganizing table of contents. The changes seem to focus on improving documentation clarity, adding new features, and updating configurations.
| emeritus_approvers: | ||
| - CaitinChen | ||
| - CharLotteiu | ||
| - cofyc | ||
| - DanielZhangQD | ||
| - dcalvin | ||
| - dragonly | ||
| - en-jin19 | ||
| - lichunzhu | ||
| - Liuxiaozhen12 | ||
| - morgo | ||
| - queenypingcap | ||
| - ran-huang | ||
| - shichun-0415 | ||
| - SunRunAway | ||
| - tangenta | ||
| - TomShawn | ||
| - toutdesuite | ||
| - WangXiangUSTC |
There was a problem hiding this comment.
Moving approvers to emeritus_approvers is a significant change. Ensure that this change aligns with the team's current structure and responsibilities.
| summary: Learn the `AUTO_INCREMENT` column attribute of TiDB. | ||
| aliases: ['/docs/dev/auto-increment/'] | ||
| --- |
There was a problem hiding this comment.
Consider removing the aliases as they are no longer needed.
| # Only open ports 4000 and 9000 to external users | ||
| sudo iptables -A INPUT -p tcp --dport 4000 -j ACCEPT |
There was a problem hiding this comment.
Consider using a more general description to avoid confusion.
| # Only open ports 4000 and 9000 to external users | |
| sudo iptables -A INPUT -p tcp --dport 4000 -j ACCEPT | |
| sudo iptables -A INPUT -p tcp --dport 4000 -j ACCEPT |
| - [Connect via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections.md) | ||
| - [Connect via Private Endpoint (Private Service Connect) with Google Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md) | ||
| - [Connect via Private Endpoint with Azure](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md) |
There was a problem hiding this comment.
Consider using Public Connection instead of Standard Connection for clarity and consistency.
| - [Connect via Private Endpoint with Azure](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md) | |
| - [Connect via Public Connection](/tidb-cloud/connect-via-standard-connection.md) |
| - Explore Data | ||
| - [Chat2Query (Beta)](/tidb-cloud/explore-data-with-chat2query.md) | ||
| - Data Service (Beta) | ||
| - [Chat2Query in SQL Editor](/tidb-cloud/explore-data-with-chat2query.md)  |
There was a problem hiding this comment.
It seems like the SQL Proxy Account is not a beta feature, so the beta tag should be removed.
| - [Chat2Query in SQL Editor](/tidb-cloud/explore-data-with-chat2query.md)  | |
| - [SQL Proxy Account](/tidb-cloud/sql-proxy-account.md) |
|
|
||
| If your average row size is larger than 512 bytes, you can enable Titan to reduce the compaction I/O flow as follows, with `min-blob-size` set to `"512B"` or `"1KB"` and `blob-file-compression` set to `"zstd"`: | ||
|
|
||
| ```toml |
There was a problem hiding this comment.
Consider rephrasing for better readability.
| ```toml | |
| 245: - [Overview of Resource Allocation](/tidb-cloud/optimize-resource-allocation.md) |
|
|
||
| If your average row size is larger than 512 bytes, you can enable Titan to reduce the compaction I/O flow as follows, with `min-blob-size` set to `"512B"` or `"1KB"` and `blob-file-compression` set to `"zstd"`: | ||
|
|
||
| ```toml |
There was a problem hiding this comment.
Consider rephrasing for better readability.
| ```toml | |
| 246: - [Resource Control](/tidb-resource-control.md) |
|
|
||
| If your average row size is larger than 512 bytes, you can enable Titan to reduce the compaction I/O flow as follows, with `min-blob-size` set to `"512B"` or `"1KB"` and `blob-file-compression` set to `"zstd"`: | ||
|
|
||
| ```toml |
There was a problem hiding this comment.
Consider rephrasing for better readability.
| ```toml | |
| 247: - TiDB Node Group |
|
|
||
| If your average row size is larger than 512 bytes, you can enable Titan to reduce the compaction I/O flow as follows, with `min-blob-size` set to `"512B"` or `"1KB"` and `blob-file-compression` set to `"zstd"`: | ||
|
|
||
| ```toml |
There was a problem hiding this comment.
Consider rephrasing for better readability.
| ```toml | |
| 248: - [Overview of TiDB Node Group](/tidb-cloud/tidb-node-group-overview.md) |
|
|
||
| If your average row size is larger than 512 bytes, you can enable Titan to reduce the compaction I/O flow as follows, with `min-blob-size` set to `"512B"` or `"1KB"` and `blob-file-compression` set to `"zstd"`: | ||
|
|
||
| ```toml |
There was a problem hiding this comment.
Consider rephrasing for better readability.
| ```toml | |
| 249: - [Manage TiDB Node Groups](/tidb-cloud/tidb-node-group-management.md) |
|
@shiyuhang0: The following test failed, say
Full PR test history. Your PR dashboard. 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 kubernetes-sigs/prow repository. I understand the commands that are listed here. |
First-time contributors' checklist
What is changed, added or deleted? (Required)
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?