Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 52 additions & 3 deletions tidb-cloud/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ This document lists the feature support status for different TiDB Cloud plans, i
<th>Feature</th>
<th style="text-align:center;">Starter</th>
<th style="text-align:center;">Essential</th>
<th style="text-align:center;">Premium</th>
<th style="text-align:center;">Dedicated</th>
</tr></thead>
<tbody>
Expand All @@ -31,198 +32,230 @@ This document lists the feature support status for different TiDB Cloud plans, i
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Analytical processing</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Vector storage &amp; 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>
<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>
<td style="text-align:center;">✅<br/><span style="font-size: 14px; white-space: nowrap;">(Public preview)</span></td>
</tr>
<tr>
<td rowspan="2" style="background-color: white;">Developer experience</td>
<td>Data branch</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center; font-size: 14px;">❌</td>
</tr>
<tr>
<td>SQL editor</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center; font-size: 14px;">❌</td>
</tr>
<tr>
<td rowspan="7" style="background-color: white;">Cluster management</td>
<td>Pay as you use</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center; font-size: 14px;">❌</td>
</tr>
<tr>
<td>Automatic scaling based on workload</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center; font-size: 14px;">❌</td>
</tr>
<tr>
<td>Manual cluster modification</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Password setting</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Pause &amp; resume</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>System maintenance window</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Backup file recycle bin</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td rowspan="4" style="background-color: white;">Data processing</td>
<td>Data import from CSV, Parquet, and SQL files to TiDB Cloud</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Data migration from MySQL-compatible databases into TiDB Cloud</td>
<td style="text-align:center; font-size: 14px;">❌</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>Data export via CSV, Parquet, and SQL files to local or object storages</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>
<td style="text-align:center; font-size: 14px;">❌</td>
</tr>
<tr>
<td>Change data replication to Kafka or other MySQL-compatible databases using changefeeds</td>
<td style="text-align:center; font-size: 14px;">❌</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>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td rowspan="5" style="background-color: white;">Backup &amp; restore</td>
<td>Automatic backup</td>
<td style="text-align:center;">✅</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; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</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; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Point-in-time recovery (PITR)</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Restore</td>
<td style="text-align:center;">✅</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>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Alerting</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>SQL statement analysis</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Slow query log</td>
<td style="text-align:center;">✅</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; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</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>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Third-party integrations, such as Datadog, Prometheus, and New Relic</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td rowspan="1" style="background-color: white;">High availability</td>
<td>Cross-AZ failover</td>
<td style="text-align:center; font-size: 14px;">❌</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 groups</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Resource control</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
Expand All @@ -231,55 +264,64 @@ This document lists the feature support status for different TiDB Cloud plans, i
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Public endpoint</td>
<td style="text-align:center;">✅</td>
<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; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</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="6" style="background-color: white;">Security</td>
<td>Database audit logging</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">🔒</td>
<td style="text-align:center;">🚧</td>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The status for "Database audit logging" on the Essential plan has changed from 🔒 (private preview) to 🚧 (under development). This seems like a feature regression. Could you please confirm if this change is intentional? According to the legend, 🚧 means "under development", which is usually a step before "private preview".

References
  1. The style guide requires technical accuracy. The change from 'private preview' to 'under development' for a feature seems to be a regression and might be technically inaccurate. (link)

<td style="text-align:center;">✅</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>
<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>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>CMEK</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</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>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>IAM (including email and password login, standard SSO, and organization SSO)</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
<td style="text-align:center;">✅</td>
</tr>
<CustomContent language="en,zh">
<tr>
Expand All @@ -288,23 +330,27 @@ This document lists the feature support status for different TiDB Cloud plans, i
<td style="text-align:center;">✅</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>
<td style="text-align:center; font-size: 14px;">❌</td>
</tr>
<tr>
<td>Azure</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Google Cloud</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
</tr>
</CustomContent>
Expand All @@ -315,17 +361,20 @@ This document lists the feature support status for different TiDB Cloud plans, i
<td style="text-align:center;">✅</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; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">🚧</td>
<td style="text-align:center;">✅</td>
</tr>
<tr>
<td>Google Cloud</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center; font-size: 14px;">❌</td>
<td style="text-align:center;">✅</td>
</tr>
</CustomContent>
Expand Down
10 changes: 10 additions & 0 deletions tidb-cloud/select-cluster-tier.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ To get the prefix for your cluster, take the following steps:
2. Click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. A connection dialog is displayed.
3. In the dialog, get the prefix from the connection string.

## {{{ .premium }}} {#premium}

For mission-critical enterprise workloads requiring hyper-scale and the highest levels of performance, the Premium plan delivers a true cloud-native experience with the following features:

- **Instant elasticity**: handles massive and unpredictable traffic spikes by scaling computing resources automatically, ensuring zero performance bottlenecks during peak demands.
- **Unlimited growth**: architected for virtually unlimited expansion in both storage and throughput, allowing your database to scale seamlessly alongside your business without physical infrastructure constraints.
- **Zero-infrastructure management**: provides a fully managed, "zero-touch" operational experience, eliminating the complexity of manual scaling, patching, or capacity planning.
- **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs), offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises.
- **Advanced security and compliance**: incorporates our most stringent security standards, including advanced encryption, CMEK, private networking options, and comprehensive compliance certifications to protect your most sensitive data.
Comment on lines +90 to +94
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

To align with the style guide's preference for using the second person ("you") and active voice, I suggest rewriting these feature descriptions for better clarity and a more direct address to the user. This will make the benefits of the Premium plan clearer.

Suggested change
- **Instant elasticity**: handles massive and unpredictable traffic spikes by scaling computing resources automatically, ensuring zero performance bottlenecks during peak demands.
- **Unlimited growth**: architected for virtually unlimited expansion in both storage and throughput, allowing your database to scale seamlessly alongside your business without physical infrastructure constraints.
- **Zero-infrastructure management**: provides a fully managed, "zero-touch" operational experience, eliminating the complexity of manual scaling, patching, or capacity planning.
- **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs), offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises.
- **Advanced security and compliance**: incorporates our most stringent security standards, including advanced encryption, CMEK, private networking options, and comprehensive compliance certifications to protect your most sensitive data.
- **Instant elasticity**: Automatically scales computing resources to handle massive and unpredictable traffic spikes, ensuring you experience zero performance bottlenecks during peak demands.
- **Unlimited growth**: Allows your database to scale seamlessly alongside your business with a virtually unlimited expansion in both storage and throughput, without physical infrastructure constraints.
- **Zero-infrastructure management**: Provides you with a fully managed, "zero-touch" operational experience, eliminating the complexity of manual scaling, patching, or capacity planning.
- **Predictable pricing**: Offers transparent, usage-based pricing that scales with your needs. You are billed based on storage and Request Capacity Units (RCUs), so you only pay for what you use without surprises.
- **Advanced security and compliance**: Incorporates our most stringent security standards to protect your most sensitive data, including advanced encryption, CMEK, private networking options, and comprehensive compliance certifications.
References
  1. The style guide recommends writing in the second person ('you') and using active voice to address users directly. The current text uses a mix of passive voice and third person. (link)


## TiDB Cloud Dedicated

TiDB Cloud Dedicated is for production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing).
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/tidb-cloud-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ TiDB Cloud provides the following deployment options:

{{{ .premium }}} is designed for mission-critical businesses that demand unlimited real-time scalability. It delivers workload-aware auto-scaling and comprehensive enterprise capabilities.

Currently, {{{ .premium }}} is in private preview on AWS and Alibaba Cloud.
Currently, {{{ .premium }}} is in public preview on AWS and Alibaba Cloud.

</CustomContent>

Expand Down
Loading