Essential v2 changes#23158
Conversation
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
missing-translation-status
|
@qqqdan PTAL |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates TiDB Cloud documentation to reflect tier-specific feature changes, notably restricting branching, local file imports, Parquet imports, and certain export options to the Starter tier, while introducing the new Essential Connection exclusive model (rolling out July 1, 2026) and updating changefeed billing. Reviewer feedback highlights several style guide violations, recommending the use of active voice and present tense, correcting grammatical issues (such as missing prepositions, articles, and template variable spacing), ensuring terminology consistency by using {{{ .starter }}} instead of hardcoded text, and removing an obsolete section in the audit logging documentation.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| You can export data to the following locations: | ||
|
|
||
| - A local file | ||
| - A local file (Only for Starter) |
There was a problem hiding this comment.
Use the template variable {{{ .starter }}} instead of the hardcoded "Starter" for consistency, and use lowercase "only".
| - A local file (Only for Starter) | |
| - A local file (only for {{{ .starter }}}) |
References
- Use consistent terminology. (link)
|
|
||
| You can store audit logs in the following locations: | ||
|
|
||
| - TiDB Cloud |
There was a problem hiding this comment.
Since you are removing TiDB Cloud as a storage location for audit logs, please note that the section ## Access audit logging with TiDB Cloud Storage (lines 359-397) later in this file is now obsolete and should also be removed or updated in this PR.
| </div> | ||
| </SimpleTab> | ||
|
|
||
| The Essential Connection exclusive model will be rolled out to new users in phases starting July 1, 2026. It supports standalone endpoints, eliminating the need for users to include the previously required account prefix when connecting. To Create an AWS Endpoint Service private link connection with exclusive model, same Networking page in the **AWS Private Endpoint for External Services** area, click **Create Private Endpoint for External Services**, enter the required information and create. |
There was a problem hiding this comment.
Rewrite the paragraph to use active voice, present tense, correct capitalization ("To create"), and improve clarity and flow.
| The Essential Connection exclusive model will be rolled out to new users in phases starting July 1, 2026. It supports standalone endpoints, eliminating the need for users to include the previously required account prefix when connecting. To Create an AWS Endpoint Service private link connection with exclusive model, same Networking page in the **AWS Private Endpoint for External Services** area, click **Create Private Endpoint for External Services**, enter the required information and create. | |
| The Essential Connection exclusive model rolls out to new users in phases starting July 1, 2026. It supports standalone endpoints, which eliminates the need to include the account prefix when connecting. To create an AWS Endpoint Service private link connection using the exclusive model, on the same **Networking** page, in the **AWS Private Endpoint for External Services** area, click **Create Private Endpoint for External Services**, enter the required information, and then click **Create**. |
References
- Passive voice overuse. Prefer present tense unless describing historical behavior. Correct English grammar, spelling, and punctuation mistakes, if any. (link)
| - `header`: specify whether to include a header row in the exported data. The default value is `true`. | ||
| - `null-value`: specify the string that represents a NULL value in the exported data. The default value is `\N`. | ||
| - `Parquet`: export data in Parquet format. | ||
| - `Parquet`: export data in Parquet format. (Only for Starter) |
There was a problem hiding this comment.
Use the template variable {{{ .starter }}} instead of the hardcoded "Starter" for consistency, and use lowercase "only".
| - `Parquet`: export data in Parquet format. (Only for Starter) | |
| - `Parquet`: export data in Parquet format. (only for {{{ .starter }}}) |
References
- Use consistent terminology. (link)
|
|
||
| - [Amazon S3](https://aws.amazon.com/s3/) | ||
| - [Google Cloud Storage](https://cloud.google.com/storage) | ||
| - [Google Cloud Storage](https://cloud.google.com/storage) (Only for Starter) |
There was a problem hiding this comment.
Use the template variable {{{ .starter }}} instead of the hardcoded "Starter" for consistency, and use lowercase "only".
| - [Google Cloud Storage](https://cloud.google.com/storage) (Only for Starter) | |
| - [Google Cloud Storage](https://cloud.google.com/storage) (only for {{{ .starter }}}) |
References
- Use consistent terminology. (link)
| > When creating a VPC endpoint, if you encounter an error `private-dns-enabled cannot be set because there is already a conflicting DNS domain for gatewayXX-privatelink.XX.prod.aws.tidbcloud.com in the VPC vpc-XXXXX`, a private endpoint already exists in that VPC. You do not need to create another one for the same private DNS name. | ||
|
|
||
| ## Set up a private endpoint with AWS (Exclusive Model) | ||
| The Essential Connection exclusive model will be rolled out to new users in phases starting July 1, 2026. It supports standalone endpoints, eliminating the need for users to include the previously required account prefix when connecting. To connect to a {{{ .essential }}} instance via a private endpoint with exclusive model, take the following steps: |
There was a problem hiding this comment.
Rewrite the paragraph to use active voice, present tense, and improve clarity and flow.
| The Essential Connection exclusive model will be rolled out to new users in phases starting July 1, 2026. It supports standalone endpoints, eliminating the need for users to include the previously required account prefix when connecting. To connect to a {{{ .essential }}} instance via a private endpoint with exclusive model, take the following steps: | |
| The Essential Connection exclusive model rolls out to new users in phases starting July 1, 2026. It supports standalone endpoints, which eliminates the need to include the account prefix when connecting. To connect to a {{{ .essential }}} instance via a private endpoint using the exclusive model, take the following steps: |
References
- Passive voice overuse. Prefer present tense unless describing historical behavior. Correct English grammar, spelling, and punctuation mistakes, if any. (link)
|
|
||
| If you have multiple instances, you need to repeat these steps for each instance that you want to connect to using AWS PrivateLink. | ||
|
|
||
| ### Step 1. Select a {{{ .essential}}} instance {#step-1-select-a-essential-instance} |
There was a problem hiding this comment.
Add a missing space in the template variable {{{ .essential}}} to make it {{{ .essential }}}.
| ### Step 1. Select a {{{ .essential}}} instance {#step-1-select-a-essential-instance} | |
| ### Step 1. Select a {{{ .essential }}} instance {#step-1-select-a-essential-instance} |
References
- Correct English grammar, spelling, and punctuation mistakes, if any. (link)
|
|
||
| > **Tip:** | ||
| > | ||
| > If your service is spanning across more than three availability zones (AZs), you might not be able to select AZs in the **Subnets** area. This issue occurs when there is an extra AZ in your selected region in addition to the AZs where your {{{ .essential}}} instance is located. In this case, contact [PingCAP Technical Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support). |
There was a problem hiding this comment.
Add a missing space in the template variable {{{ .essential}}} to make it {{{ .essential }}}.
| > If your service is spanning across more than three availability zones (AZs), you might not be able to select AZs in the **Subnets** area. This issue occurs when there is an extra AZ in your selected region in addition to the AZs where your {{{ .essential}}} instance is located. In this case, contact [PingCAP Technical Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support). | |
| If your service is spanning across more than three availability zones (AZs), you might not be able to select AZs in the **Subnets** area. This issue occurs when there is an extra AZ in your selected region in addition to the AZs where your {{{ .essential }}} instance is located. In this case, contact [PingCAP Technical Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support). |
References
- Correct English grammar, spelling, and punctuation mistakes, if any. (link)
| No. Currently, you can only import all columns of a CSV file into an existing table when using the Import feature. | ||
|
|
||
| To import only some specified columns, you can use the MySQL client to connect your {{{ .starter }}} or Essential instance, and then use [`LOAD DATA`](https://docs.pingcap.com/tidb/stable/sql-statement-load-data) to specify the columns to be imported. For example: | ||
| To import only some specified columns, you can use the MySQL client to connect your {{{ .starter }}} instance, and then use [`LOAD DATA`](https://docs.pingcap.com/tidb/stable/sql-statement-load-data) to specify the columns to be imported. For example: |
There was a problem hiding this comment.
Add the missing preposition "to" after "connect" to make the sentence grammatically correct.
| To import only some specified columns, you can use the MySQL client to connect your {{{ .starter }}} instance, and then use [`LOAD DATA`](https://docs.pingcap.com/tidb/stable/sql-statement-load-data) to specify the columns to be imported. For example: | |
| To import only some specified columns, you can use the MySQL client to connect to your {{{ .starter }}} instance, and then use [`LOAD DATA`](https://docs.pingcap.com/tidb/stable/sql-statement-load-data) to specify the columns to be imported. For example: |
References
- Correct English grammar, spelling, and punctuation mistakes, if any. (link)
| 5. Click **Create**. | ||
|
|
||
| Depending on the data size in your {{{ .starter }}} or Essential instance, the branch creation will be completed in a few minutes. | ||
| Depending on the data size in your {{{ .starter }}} instance, the branch creation will be completed in a few minutes. |
There was a problem hiding this comment.
The phrase "the branch creation will be completed" is in the passive voice and future tense. Using active voice and present tense makes the documentation more direct and concise.
| Depending on the data size in your {{{ .starter }}} instance, the branch creation will be completed in a few minutes. | |
| Depending on the data size in your {{{ .starter }}} instance, branch creation completes in a few minutes. |
References
- Passive voice overuse. Prefer present tense unless describing historical behavior. (link)
|
@qiqi-power: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. |
1 participant
First-time contributors' checklist
What is changed, added or deleted? (Required)
Essential v2 changes doc.
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?