tidb-cloud: add the Features doc #22166
+287
−6
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,278 @@ | ||
| --- | ||
| title: Features | ||
| summary: Learn about feature support status for different TiDB Cloud plans. | ||
| --- | ||
|
|
||
| # Features | ||
|
|
||
| This document lists the feature support status for different TiDB Cloud plans, including {{{ .starter }}}, Essential, and Dedicated. | ||
|
|
||
| > **Tip:** | ||
| > | ||
| > [TiDB Cloud Starter](/tidb-cloud/select-cluster-tier.md#starter) is the best way to get started with TiDB Cloud. Additionally, you can try out TiDB Cloud features on [TiDB Playground](https://play.tidbcloud.com/?utm_source=docs&utm_medium=tidb_cloud_quick_start). | ||
|
|
||
| - ✅: The feature is generally available unless otherwise noted as preview. | ||
| - ❌: The feature is currently not available. | ||
|
|
||
| <table><thead> | ||
| <tr> | ||
| <th>Category</th> | ||
| <th>Feature</th> | ||
| <th style="text-align:center;">Starter</th> | ||
| <th style="text-align:center;">Essential</th> | ||
| <th style="text-align:center;">Dedicated</th> | ||
| </tr></thead> | ||
| <tbody> | ||
qiancai marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <tr> | ||
| <td rowspan="3" style="background-color: white;">Basics</td> | ||
| <td>TiKV</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>TiFlash</td> | ||
qiancai marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>API</td> | ||
| <td style="text-align:center;">✅<br/><span style="font-size: 14px; white-space: nowrap;">(Public preview)</span></td> | ||
| <td style="text-align:center;">✅<br/><span style="font-size: 14px; white-space: nowrap;">(Public preview)</span></td> | ||
| <td style="text-align:center;">✅<br/><span style="font-size: 14px; white-space: nowrap;">(Public preview)</span></td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="3" style="background-color: white;">Cluster management</td> | ||
| <td>Pause & resume</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Maintenance window</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Recycle bin</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2" style="background-color: white;">Data import</td> | ||
| <td>Import (using <code>IMPORT INTO</code> or the TiDB Cloud console)</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Data migration</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅ <br/><span style="font-size: 14px; white-space: nowrap;">(Private preview)</span></td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2" style="background-color: white;">Data export</td> | ||
| <td>Export</td> | ||
| <td style="text-align:center;">✅ <br/><span style="font-size: 14px; white-space: nowrap;">(Public preview)</span></td> | ||
| <td style="text-align:center;">✅ <br/><span style="font-size: 14px; white-space: nowrap;">(Public preview)</span></td> | ||
| <td style="text-align:center;">❌</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Changefeed</td> | ||
|
Collaborator
Author
There was a problem hiding this comment. “Changefeed” is the feature name used in the TiDB Cloud console, and the term “TiCDC” does not appear in the console. |
||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅ <br/><span style="font-size: 14px; white-space: nowrap;">(Private preview in CLI)</span></td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="4" style="background-color: white;">Backup & restore</td> | ||
| <td>Automatic backup</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Dual region backup</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Manual backup</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Point-in-time recovery (PITR)</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="background-color: white;">Storage</td> | ||
| <td>Standard storage</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="7" style="background-color: white;">Observability</td> | ||
| <td>Built-in metrics</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Alerting</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>SQL Statement</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Slow Query</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Top SQL</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Events</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Third-party integrations</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2" style="background-color: white;">High availability</td> | ||
| <td>Failover (cross-AZ)</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Recovery group (cross-region)</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="2" style="background-color: white;">Resource allocation</td> | ||
| <td>Node group</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Resource control</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="7" style="background-color: white;">Security</td> | ||
| <td>Private endpoint</td> | ||
|
Member
There was a problem hiding this comment. Private Endpoint & VPC peering should belong to "Connection".
Member
There was a problem hiding this comment. Private endpoint & VPC peering also belong to security, so it's reasonable to put them in Security, especially when we want to emphasize security. |
||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>VPC peering</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Database audit logging</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅ <br/><span style="font-size: 14px; white-space: nowrap;">(Private preview)</span></td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Console audit logging</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>CMEK</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Log redaction</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Dual-layer encryption</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="3" style="background-color: white;">AI & Development</td> | ||
| <td>Vector search</td> | ||
| <td style="text-align:center;">✅ <br/><span style="font-size: 14px; white-space: nowrap;">(Public preview)</span></td> | ||
| <td style="text-align:center;">✅ <br/><span style="font-size: 14px; white-space: nowrap;">(Public preview)</span></td> | ||
| <td style="text-align:center;">✅ <br/><span style="font-size: 14px; white-space: nowrap;">(Public preview)</span></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Data branch</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">❌</td> | ||
| </tr> | ||
| <tr> | ||
| <td>SQL editor</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| </tr> | ||
| <tr> | ||
| <td rowspan="4" style="background-color: white;">Cloud and regions</td> | ||
| <td>AWS</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Alibaba Cloud</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">✅</td> | ||
| <td style="text-align:center;">❌</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Azure</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| <tr> | ||
| <td>Google Cloud</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">❌</td> | ||
| <td style="text-align:center;">✅</td> | ||
| </tr> | ||
| </tbody></table> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@likidu PTAL
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will probably not include Clinic / Ops now as I felt Starter / Essential customers do not need to even worry about those existence...
cc @nicole-yc @lilin90
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated in https://github.com/pingcap/docs/pull/22166/files/937370be24daf54647ba0d20869bb8be5debcbf7..04e7da9704f238d36c01745debd1288aa729e2a7. Now all the comments are resolved.