diff --git a/TOC-tidb-cloud.md b/TOC-tidb-cloud.md index 3aec338353b31..4088234c17a15 100644 --- a/TOC-tidb-cloud.md +++ b/TOC-tidb-cloud.md @@ -89,13 +89,26 @@ - [Select Your Cluster Tier](/tidb-cloud/select-cluster-tier.md) - [Determine Your TiDB Size](/tidb-cloud/size-your-cluster.md) - [TiDB Cloud Performance Reference](/tidb-cloud/tidb-cloud-performance-reference.md) - - [Create a TiDB Cluster](/tidb-cloud/create-tidb-cluster.md) - - Connect to Your TiDB Cluster - - [Connection Method Overview](/tidb-cloud/connect-to-tidb-cluster.md) - - [Connect via Standard Connection](/tidb-cloud/connect-via-standard-connection.md) - - [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md) - - [Connect via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) - - [Connect via SQL Shell](/tidb-cloud/connect-via-sql-shell.md) + - Manage TiDB Serverless Clusters + - [Create a TiDB Serverless Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) + - Connect to Your TiDB Serverless Cluster + - [Connection Method Overview](/tidb-cloud/connect-to-tidb-cluster-serverless.md) + - [Connect via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) + - [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) + - [Manage Spend Limit](/tidb-cloud/manage-serverless-spend-limit.md) + - [Back Up and Restore TiDB Serverless Data](/tidb-cloud/backup-and-restore-serverless.md) + - Manage TiDB Dedicated Clusters + - [Create a TiDB Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md) + - Connect to Your TiDB Dedicated Cluster + - [Connection Method Overview](/tidb-cloud/connect-to-tidb-cluster.md) + - [Connect via Standard Connection](/tidb-cloud/connect-via-standard-connection.md) + - [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md) + - [Connect via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) + - [Connect via SQL Shell](/tidb-cloud/connect-via-sql-shell.md) + - [Scale a TiDB Dedicated Cluster](/tidb-cloud/scale-tidb-cluster.md) + - [Back Up and Restore TiDB Dedicated Data](/tidb-cloud/backup-and-restore.md) + - [Pause or Resume a TiDB Dedicated Cluster](/tidb-cloud/pause-or-resume-tidb-cluster.md) + - [Configure Maintenance Window](/tidb-cloud/configure-maintenance-window.md) - Use an HTAP Cluster with TiFlash - [TiFlash Overview](/tiflash/tiflash-overview.md) - [Create TiFlash Replicas](/tiflash/create-tiflash-replicas.md) @@ -104,10 +117,63 @@ - [Supported Push-down Calculations](/tiflash/tiflash-supported-pushdown-calculations.md) - [TiFlash Query Result Materialization](/tiflash/tiflash-results-materialization.md) - [Compatibility](/tiflash/tiflash-compatibility.md) - - [Manage Spend Limit](/tidb-cloud/manage-serverless-spend-limit.md) - - [Scale a TiDB Cluster](/tidb-cloud/scale-tidb-cluster.md) - - [Pause or Resume a TiDB Cluster](/tidb-cloud/pause-or-resume-tidb-cluster.md) - - [Configure Maintenance Window](/tidb-cloud/configure-maintenance-window.md) + - Monitor and Alert + - [Overview](/tidb-cloud/monitor-tidb-cluster.md) + - [Built-in Metrics](/tidb-cloud/built-in-monitoring.md) + - [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md) + - [Cluster Events](/tidb-cloud/tidb-cloud-events.md) + - [Third-Party Metrics Integrations](/tidb-cloud/third-party-monitoring-integrations.md) + - Tune Performance + - [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md) + - Analyze Performance + - [Use the Diagnosis Tab](/tidb-cloud/tune-performance.md) + - [Use Index Insight (Beta)](/tidb-cloud/index-insight.md) + - [Use Statement Summary Tables](/statement-summary-tables.md) + - SQL Tuning + - [Overview](/tidb-cloud/tidb-cloud-sql-tuning-overview.md) + - Understanding the Query Execution Plan + - [Overview](/explain-overview.md) + - [`EXPLAIN` Walkthrough](/explain-walkthrough.md) + - [Indexes](/explain-indexes.md) + - [Joins](/explain-joins.md) + - [MPP Queries](/explain-mpp.md) + - [Subqueries](/explain-subqueries.md) + - [Aggregation](/explain-aggregation.md) + - [Views](/explain-views.md) + - [Partitions](/explain-partitions.md) + - [Index Merge](/explain-index-merge.md) + - SQL Optimization Process + - [Overview](/sql-optimization-concepts.md) + - Logic Optimization + - [Overview](/sql-logical-optimization.md) + - [Subquery Related Optimizations](/subquery-optimization.md) + - [Column Pruning](/column-pruning.md) + - [Decorrelation of Correlated Subquery](/correlated-subquery-optimization.md) + - [Eliminate Max/Min](/max-min-eliminate.md) + - [Predicates Push Down](/predicate-push-down.md) + - [Partition Pruning](/partition-pruning.md) + - [TopN and Limit Push Down](/topn-limit-push-down.md) + - [Join Reorder](/join-reorder.md) + - Physical Optimization + - [Overview](/sql-physical-optimization.md) + - [Index Selection](/choose-index.md) + - [Statistics](/statistics.md) + - [Extended Statistics](/extended-statistics.md) + - [Wrong Index Solution](/wrong-index-solution.md) + - [Distinct Optimization](/agg-distinct-optimization.md) + - [Cost Model](/cost-model.md) + - [Prepare Execution Plan Cache](/sql-prepared-plan-cache.md) + - Control Execution Plans + - [Overview](/control-execution-plan.md) + - [Optimizer Hints](/optimizer-hints.md) + - [SQL Plan Management](/sql-plan-management.md) + - [The Blocklist of Optimization Rules and Expression Pushdown](/blocklist-control-plan.md) + - [TiKV Follower Read](/follower-read.md) + - [Coprocessor Cache](/coprocessor-cache.md) + - Garbage Collection (GC) + - [Overview](/garbage-collection-overview.md) + - [Configuration](/garbage-collection-configuration.md) + - [Tune TiFlash Performance](/tiflash/tune-tiflash-performance.md) - [Upgrade a TiDB Cluster](/tidb-cloud/upgrade-tidb-cluster.md) - [Delete a TiDB Cluster](/tidb-cloud/delete-tidb-cluster.md) - Migrate or Import Data @@ -148,78 +214,20 @@ - [To MySQL Sink](/tidb-cloud/changefeed-sink-to-mysql.md) - [To Kafka Sink (Beta)](/tidb-cloud/changefeed-sink-to-apache-kafka.md) - [To TiDB Cloud Sink](/tidb-cloud/changefeed-sink-to-tidb-cloud.md) -- Back Up and Restore - - [Automatic Backup](/tidb-cloud/backup-and-restore.md) - - [Manual Backup](/tidb-cloud/backup-and-restore.md#manual-backup) - - [Restore](/tidb-cloud/backup-and-restore.md#restore) -- Monitor and Alert - - [Overview](/tidb-cloud/monitor-tidb-cluster.md) - - [Built-in Metrics](/tidb-cloud/built-in-monitoring.md) - - [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md) - - [Cluster Events](/tidb-cloud/tidb-cloud-events.md)  - - [Third-Party Metrics Integrations](/tidb-cloud/third-party-monitoring-integrations.md) -- Tune Performance - - [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md) - - Analyze Performance - - [Use the Diagnosis Tab](/tidb-cloud/tune-performance.md) - - [Use Index Insight (Beta)](/tidb-cloud/index-insight.md) - - [Use Statement Summary Tables](/statement-summary-tables.md) - - SQL Tuning - - [Overview](/tidb-cloud/tidb-cloud-sql-tuning-overview.md) - - Understanding the Query Execution Plan - - [Overview](/explain-overview.md) - - [`EXPLAIN` Walkthrough](/explain-walkthrough.md) - - [Indexes](/explain-indexes.md) - - [Joins](/explain-joins.md) - - [MPP Queries](/explain-mpp.md) - - [Subqueries](/explain-subqueries.md) - - [Aggregation](/explain-aggregation.md) - - [Views](/explain-views.md) - - [Partitions](/explain-partitions.md) - - [Index Merge](/explain-index-merge.md) - - SQL Optimization Process - - [Overview](/sql-optimization-concepts.md) - - Logic Optimization - - [Overview](/sql-logical-optimization.md) - - [Subquery Related Optimizations](/subquery-optimization.md) - - [Column Pruning](/column-pruning.md) - - [Decorrelation of Correlated Subquery](/correlated-subquery-optimization.md) - - [Eliminate Max/Min](/max-min-eliminate.md) - - [Predicates Push Down](/predicate-push-down.md) - - [Partition Pruning](/partition-pruning.md) - - [TopN and Limit Push Down](/topn-limit-push-down.md) - - [Join Reorder](/join-reorder.md) - - Physical Optimization - - [Overview](/sql-physical-optimization.md) - - [Index Selection](/choose-index.md) - - [Statistics](/statistics.md) - - [Extended Statistics](/extended-statistics.md) - - [Wrong Index Solution](/wrong-index-solution.md) - - [Distinct Optimization](/agg-distinct-optimization.md) - - [Cost Model](/cost-model.md) - - [Prepare Execution Plan Cache](/sql-prepared-plan-cache.md) - - Control Execution Plans - - [Overview](/control-execution-plan.md) - - [Optimizer Hints](/optimizer-hints.md) - - [SQL Plan Management](/sql-plan-management.md) - - [The Blocklist of Optimization Rules and Expression Pushdown](/blocklist-control-plan.md) - - [TiKV Follower Read](/follower-read.md) - - [Coprocessor Cache](/coprocessor-cache.md) - - Garbage Collection (GC) - - [Overview](/garbage-collection-overview.md) - - [Configuration](/garbage-collection-configuration.md) - - [Tune TiFlash Performance](/tiflash/tune-tiflash-performance.md) - Security - Identity Access Control - [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md) - [SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md) - [Identity Access Management](/tidb-cloud/manage-user-access.md) - Network Access Control - - [Configure an IP Access List](/tidb-cloud/configure-ip-access-list.md) - - [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md) - - [Connect via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) - - [TLS Connections to Serverless Tier](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md) - - [TLS Connections to Dedicated Tier](/tidb-cloud/tidb-cloud-tls-connect-to-dedicated-tier.md) + - TiDB Serverless + - [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) + - [TLS Connections to TiDB Serverless](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md) + - TiDB Dedicated + - [Configure an IP Access List](/tidb-cloud/configure-ip-access-list.md) + - [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md) + - [Connect via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) + - [TLS Connections to TiDB Dedicated](/tidb-cloud/tidb-cloud-tls-connect-to-dedicated-tier.md) - Database Access Control - [Configure Cluster Security Settings](/tidb-cloud/configure-security-settings.md) - Audit Management @@ -540,6 +548,8 @@ - [Dumpling](/dumpling-overview.md) - [Table Filter](/table-filter.md) - [Troubleshoot Inconsistency Between Data and Indexes](/troubleshoot-data-inconsistency-errors.md) + - [Support](/tidb-cloud/tidb-cloud-support.md) + - [Glossary](/tidb-cloud/tidb-cloud-glossary.md) - FAQs - [TiDB Cloud FAQs](/tidb-cloud/tidb-cloud-faq.md) - [Serverless Tier FAQs](/tidb-cloud/serverless-tier-faqs.md) @@ -548,5 +558,3 @@ - [2022](/tidb-cloud/release-notes-2022.md) - [2021](/tidb-cloud/release-notes-2021.md) - [2020](/tidb-cloud/release-notes-2020.md) -- [Support](/tidb-cloud/tidb-cloud-support.md) -- [Glossary](/tidb-cloud/tidb-cloud-glossary.md) diff --git a/develop/dev-guide-get-data-from-single-table.md b/develop/dev-guide-get-data-from-single-table.md index 2f3f6bf6f3e57..db7072c275d24 100644 --- a/develop/dev-guide-get-data-from-single-table.md +++ b/develop/dev-guide-get-data-from-single-table.md @@ -37,7 +37,7 @@ Before querying data, make sure that you have completed the following steps: -3. [Connect to TiDB](/tidb-cloud/connect-to-tidb-cluster.md). +3. [Connect to TiDB](/tidb-cloud/connect-to-tidb-cluster-serverless.md). diff --git a/tidb-cloud/backup-and-restore-serverless.md b/tidb-cloud/backup-and-restore-serverless.md new file mode 100644 index 0000000000000..f168ba72ffb68 --- /dev/null +++ b/tidb-cloud/backup-and-restore-serverless.md @@ -0,0 +1,64 @@ +--- +title: Back Up and Restore TiDB Serverless Data +summary: Learn how to back up and restore your TiDB Serverless cluster. +aliases: ['/tidbcloud/restore-deleted-tidb-cluster'] +--- + +# Back Up and Restore TiDB Serverless Data + +This document describes how to back up and restore your TiDB Serverless cluster data on TiDB Cloud. + +> **Tip:** +> +> To learn how to back up and restore TiDB Dedicated cluster data, see [Back Up and Restore TiDB Dedicated Data](/tidb-cloud/backup-and-restore.md). + +## Limitations + +- It is important to note that TiDB Serverless clusters only support in-place restoring from backups. When a restore is performed, tables in the `mysql` schema are also impacted. Hence, any changes made to user credentials and permissions or system variables will be rolled back to the state when the backup was taken. +- Manual backup is not yet supported. +- PITR (Point-in-time Recovery) is not yet supported. +- The cluster will be unavailable during the restore process, and existing connections will be terminated. You can establish new connections once the restore is complete. +- If any TiFlash replica is enabled, the replica will be unavailable for a while after the restore because data needs to be rebuilt in TiFlash. + +## Backup + +Automatic backups are scheduled for your TiDB Serverless clusters according to the backup setting, which can reduce your loss in extreme disaster situations. + +### Automatic backup + +By the automatic backup, you can back up the TiDB Serverless cluster data every day at the backup time you have set. To set the backup time, perform the following steps: + +1. Navigate to the **Backup** page of a TiDB Serverless cluster. + +2. Click **Backup Settings**. This will open the **Backup Settings** window, where you can configure the automatic backup settings according to your requirements. + + - In **Backup Time**, schedule a start time for the daily cluster backup. + + If you do not specify a preferred backup time, TiDB Cloud assigns a default backup time, which is 2:00 AM in the time zone of the region where the cluster is located. + + - In **Backup Retention**, configure the minimum backup data retention period. + + The backup retention period must be set within a range of 7 to 90 days. + +3. Click **Confirm**. + +### Delete backup files + +To delete an existing backup file, perform the following steps: + +1. Navigate to the **Backup** tab of a cluster. + +2. Click **Delete** for the backup file that you want to delete. + +## Restore + +TiDB Serverless only supports in-place restoration. To restore your TiDB Serverless cluster from a backup, follow these steps: + +1. Navigate to the **Backup** page of a cluster. + +2. Click **Restore**. This will open the **Restore** window. + + 1. Choose a backup from the **Backup Time** drop-down list. + 2. Click **Confirm** to begin the restoration process. + + After initiating the restore process, the cluster status changes to **Restoring**. The cluster will be unavailable during the restore process and existing connections will be terminated. Once the restore process completes successfully, you can access the cluster as usual. \ No newline at end of file diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index a92e641cc9b5e..7dee1619fb13e 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -1,69 +1,29 @@ --- -title: Back Up and Restore TiDB Cluster Data -summary: Learn how to back up and restore your TiDB Cloud cluster. +title: Back Up and Restore TiDB Dedicated Data +summary: Learn how to back up and restore your TiDB Dedicated cluster. aliases: ['/tidbcloud/restore-deleted-tidb-cluster'] --- -# Back Up and Restore TiDB Cluster Data +# Back Up and Restore TiDB Dedicated Data -This document describes how to back up and restore your TiDB cluster data on TiDB Cloud. +This document describes how to back up and restore your TiDB Dedicated cluster data on TiDB Cloud. -## Limitations +> **Tip:** +> +> To learn how to back up and restore TiDB Serverless cluster data, see [Back Up and Restore TiDB Serverless Data](/tidb-cloud/backup-and-restore-serverless.md). -### TiDB Dedicated +## Limitations - TiDB Cloud does not support restoring tables in the `mysql` schema, including user permissions and system variables. - If you turn on and off PITR (Point-in-time Recovery) multiple times, you can only choose a time point within the recoverable range after the most recent PITR is enabled. The earlier recoverable range is not accessible. -### TiDB Serverless - -- It is important to note that TiDB Serverless clusters only support in-place restoring from backups. When a restore is performed, tables in the `mysql` schema are also impacted. Hence, any changes made to user credentials and permissions or system variables will be rolled back to the state when the backup was taken. -- Manual backup is not yet supported. -- PITR (Point-in-time Recovery) is not yet supported. -- The cluster will be unavailable during the restore process, and existing connections will be terminated. You can establish new connections once the restore is complete. -- If any TiFlash replica is enabled, the replica will be unavailable for a while after the restore because data needs to be rebuilt in TiFlash. - ## Backup -You can back up data for both [TiDB Serverless](#tidb-serverless) and [TiDB Dedicated](#tidb-dedicated). - -### TiDB Serverless - -Automatic backups are scheduled for your TiDB Serverless clusters according to the backup setting, which can reduce your loss in extreme disaster situations. - -#### Automatic backup - -By the automatic backup, you can back up the TiDB Serverless cluster data every day at the backup time you have set. To set the backup time, perform the following steps: - -1. Navigate to the **Backup** page of a TiDB Serverless cluster. - -2. Click **Backup Settings**. This will open the **Backup Settings** window, where you can configure the automatic backup settings according to your requirements. - - - In **Backup Time**, schedule a start time for the daily cluster backup. - - If you do not specify a preferred backup time, TiDB Cloud assigns a default backup time, which is 2:00 AM in the time zone of the region where the cluster is located. - - - In **Backup Retention**, configure the minimum backup data retention period. - - The backup retention period must be set within a range of 7 to 90 days. - -3. Click **Confirm**. - -#### Delete backup files - -To delete an existing backup file, perform the following steps: - -1. Navigate to the **Backup** tab of a cluster. - -2. Click **Delete** for the backup file that you want to delete. - -### TiDB Dedicated - TiDB Dedicated supports automatic backup and manual backup. -Automatic backups are scheduled for your TiDB Dedicated clusters according to the backup setting, which can reduce your loss in extreme disaster situations. You can also pick a backup snapshot and restore it into a new TiDB cluster at any time. +Automatic backups are scheduled for your TiDB Dedicated clusters according to the backup setting, which can reduce your loss in extreme disaster situations. You can also pick a backup snapshot and restore it into a new TiDB Dedicated cluster at any time. -#### Automatic backup +### Automatic backup By the automatic backup, you can back up the TiDB Dedicated cluster data every day at the backup time you have set. To set the backup time, perform the following steps: @@ -89,7 +49,7 @@ By the automatic backup, you can back up the TiDB Dedicated cluster data every d - Resolve cases of data write errors by restoring point-in-time that is before the error event. - Audit the historical data of the business. - If you have one of the preceding needs and want to use the PITR feature, make sure that your TiDB cluster version is at least v6.4.0 and the TiKV node size is at least 8 vCPU and 16 GiB. + If you have one of the preceding needs and want to use the PITR feature, make sure that your TiDB Dedicated cluster version is at least v6.4.0 and the TiKV node size is at least 8 vCPU and 16 GiB. - In **Backup Storage Region**, select the regions where you want to store your backup data. @@ -101,7 +61,7 @@ By the automatic backup, you can back up the TiDB Dedicated cluster data every d 5. Click **Confirm**. -#### Backup storage region support +### Backup storage region support Currently, you cannot select an arbitrary remote region for backup data storage. The regions already supported are as follows: @@ -113,11 +73,11 @@ Currently, you cannot select an arbitrary remote region for backup data storage. > > If you select multiple backup storage regions, you will be charged for multiple backup storage and inter-region backup data replication out from the cluster region to each destination region. The cost is on a per-region basis and varies with the backup regions selected. For more information, see [Data Backup Cost](https://www.pingcap.com/tidb-cloud-pricing-details/#backup-storage-cost). -#### Manual backup +### Manual backup Manual backups are user-initiated backups that enable you to back up your data to a known state as needed, and then restore to that state at any time. -To apply a manual backup to your TiDB cluster, perform the following steps: +To apply a manual backup to your TiDB Dedicated cluster, perform the following steps: 1. Navigate to the **Backup** tab of a cluster. @@ -127,7 +87,7 @@ To apply a manual backup to your TiDB cluster, perform the following steps: 4. Click **Confirm**. Then your cluster data is backed up. -#### Delete backup files +### Delete backup files To delete an existing backup file, perform the following steps: @@ -135,7 +95,7 @@ To delete an existing backup file, perform the following steps: 2. Click **Delete** for the backup file that you want to delete. -#### Delete a running backup job +### Delete a running backup job To delete a running backup job, it is similar as [**Delete backup files**](#delete-backup-files). @@ -143,7 +103,7 @@ To delete a running backup job, it is similar as [**Delete backup files**](#dele 2. Click **Delete** for the backup file that is in the **Pending** or **Running** state. -#### Best practices for backup +### Best practices for backup - It is recommended that you perform backup operations at cluster idle time to minimize the impact on business. - Do not run the manual backup while importing data, or during cluster scaling. @@ -151,29 +111,14 @@ To delete a running backup job, it is similar as [**Delete backup files**](#dele ## Restore -### TiDB Serverless - -TiDB Serverless only supports in-place restoration. To restore your TiDB Serverless cluster from a backup, follow these steps: - -1. Navigate to the **Backup** page of a cluster. - -2. Click **Restore**. This will open the **Restore** window. - - 1. Choose a backup from the **Backup Time** drop-down list. - 2. Click **Confirm** to begin the restoration process. - - After initiating the restore process, the cluster status changes to **Restoring**. The cluster will be unavailable during the restore process and existing connections will be terminated. Once the restore process completes successfully, you can access the cluster as usual. - -### TiDB Dedicated - TiDB Dedicated provides two types of data restoration: - Restore backup data to a new cluster - Restore a deleted cluster from the recycle bin -#### Restore data to a new cluster +### Restore data to a new cluster -To restore your TiDB cluster data from a backup to a new cluster, take the following steps: +To restore your TiDB Dedicated cluster data from a backup to a new cluster, take the following steps: 1. Navigate to the **Backup** tab of a cluster. @@ -215,7 +160,7 @@ To restore your TiDB cluster data from a backup to a new cluster, take the follo 7. In the **Security Settings** dialog box, set the root password and allowed IP addresses to connect to your cluster, and then click **Apply**. -#### Restore a deleted cluster +### Restore a deleted cluster To restore a deleted cluster from recycle bin, take the following steps: diff --git a/tidb-cloud/changefeed-overview.md b/tidb-cloud/changefeed-overview.md index 7d390ea57e452..8fb213992bf8b 100644 --- a/tidb-cloud/changefeed-overview.md +++ b/tidb-cloud/changefeed-overview.md @@ -1,5 +1,6 @@ --- title: Changefeed +summary: TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data services. --- # Changefeed @@ -8,11 +9,9 @@ TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data servic > **Note:** > -> To use the changefeed feature, make sure that your TiDB cluster version is v6.4.0 or later. -> -> Currently, TiDB Cloud only allows up to 10 changefeeds per cluster. -> -> For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable. +> - To use the changefeed feature, make sure that your TiDB Dedicated cluster version is v6.4.0 or later. +> - Currently, TiDB Cloud only allows up to 5 changefeeds per cluster. +> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable. To access the changefeed feature, navigate to the cluster overview page of your TiDB cluster, and then click **Changefeed** in the left navigation pane. The changefeed page is displayed. diff --git a/tidb-cloud/changefeed-sink-to-apache-kafka.md b/tidb-cloud/changefeed-sink-to-apache-kafka.md index a785973ee37a1..1375a453819a5 100644 --- a/tidb-cloud/changefeed-sink-to-apache-kafka.md +++ b/tidb-cloud/changefeed-sink-to-apache-kafka.md @@ -9,9 +9,8 @@ This document describes how to create a changefeed to stream data from TiDB Clou > **Note:** > -> Currently, Kafka sink is in **beta**. To use the changefeed feature, make sure that your TiDB cluster version is v6.4.0 or later and the TiKV node size is at least 8 vCPU and 16 GiB. -> -> For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable. +> - Currently, Kafka sink is in **beta**. To use the changefeed feature, make sure that your TiDB Dedicated cluster version is v6.4.0 or later and the TiKV node size is at least 8 vCPU and 16 GiB. +> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable. ## Restrictions diff --git a/tidb-cloud/changefeed-sink-to-mysql.md b/tidb-cloud/changefeed-sink-to-mysql.md index a7ddcc655f5fe..6897a7a783a15 100644 --- a/tidb-cloud/changefeed-sink-to-mysql.md +++ b/tidb-cloud/changefeed-sink-to-mysql.md @@ -9,11 +9,9 @@ This document describes how to stream data from TiDB Cloud to MySQL using the ** > **Note:** > -> To use the changefeed feature, make sure that your TiDB cluster version is v6.4.0 or later and the TiKV node size is at least 8 vCPU and 16 GiB. -> -> Currently, TiDB Cloud only allows up to 5 changefeeds per cluster. -> -> For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable. +> - To use the changefeed feature, make sure that your TiDB Dedicated cluster version is v6.4.0 or later and the TiKV node size is at least 8 vCPU and 16 GiB. +> - Currently, TiDB Cloud only allows up to 5 changefeeds per cluster. +> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable. ## Restrictions diff --git a/tidb-cloud/changefeed-sink-to-tidb-cloud.md b/tidb-cloud/changefeed-sink-to-tidb-cloud.md index aa89b0d4d638e..d32014304e4b7 100644 --- a/tidb-cloud/changefeed-sink-to-tidb-cloud.md +++ b/tidb-cloud/changefeed-sink-to-tidb-cloud.md @@ -9,7 +9,7 @@ This document describes how to stream data from a TiDB Dedicated cluster to a Ti > **Note:** > -> To use the Changefeed feature, make sure that your TiDB cluster version is v6.4.0 or later. +> To use the Changefeed feature, make sure that your TiDB Dedicated cluster version is v6.4.0 or later. ## Restrictions diff --git a/tidb-cloud/configure-maintenance-window.md b/tidb-cloud/configure-maintenance-window.md index bd913e5e49b25..2d8473444713a 100644 --- a/tidb-cloud/configure-maintenance-window.md +++ b/tidb-cloud/configure-maintenance-window.md @@ -7,7 +7,7 @@ summary: Learn how to configure maintenance window for your cluster. A maintenance window is a designated timeframe during which planned maintenance activities, such as operating system updates, security patches, and infrastructure upgrades, are performed automatically to ensure the reliability, security, and performance of the TiDB Cloud service. -During a maintenance window, the maintenance is executed on TiDB clusters one by one so the overall impact is minimal. Although there might be temporary connection disruptions or QPS fluctuations, the clusters remain available, and the existing data import, backup, restore, migration, and replication tasks can still run normally. +During a maintenance window, the maintenance is executed on TiDB Dedicated clusters one by one so the overall impact is minimal. Although there might be temporary connection disruptions or QPS fluctuations, the clusters remain available, and the existing data import, backup, restore, migration, and replication tasks can still run normally. By configuring the maintenance window, you can easily schedule and manage maintenance activities to minimize the maintenance impact. For example, you can set the start time of the maintenance window to avoid peak hours of your application workloads. diff --git a/tidb-cloud/connect-to-tidb-cluster-serverless.md b/tidb-cloud/connect-to-tidb-cluster-serverless.md new file mode 100644 index 0000000000000..5a7ccf00c4079 --- /dev/null +++ b/tidb-cloud/connect-to-tidb-cluster-serverless.md @@ -0,0 +1,34 @@ +--- +title: Connect to Your TiDB Serverless Cluster +summary: Learn how to connect to your TiDB Serverless cluster via different methods. +--- + +# Connect to Your TiDB Serverless Cluster + +This document introduces the methods to connect to your TiDB Serverless cluster. + +> **Tip:** +> +> To learn how to connect to a TiDB Dedicated cluster, see [Connect to Your TiDB Dedicated Cluster](/tidb-cloud/connect-to-tidb-cluster.md). + +After your TiDB Serverless cluster is created on TiDB Cloud, you can connect to it via one of the following methods: + +- [Connect via private endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) (recommended) + + Private endpoint connection provides a private endpoint to allow SQL clients in your VPC to securely access services over AWS PrivateLink, which provides highly secure and one-way access to database services with simplified network management. + +- [Connect via public endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) + + The standard connection exposes a public endpoint with traffic filters, so you can connect to your TiDB cluster via a SQL client from your laptop. + + TiDB Serverless supports [TLS connections](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md), which ensures the security of data transmission from your applications to TiDB clusters. + +- [Connect via Chat2Query (beta)](/tidb-cloud/explore-data-with-chat2query.md) + + TiDB Cloud is powered by artificial intelligence (AI). You can use Chat2Query (beta), an AI-powered SQL editor in the [TiDB Cloud console](https://tidbcloud.com/), to maximize your data value. + + In Chat2Query, you can either simply type `--` followed by your instructions to let AI generate SQL queries automatically or write SQL queries manually, and then run SQL queries against databases without a terminal. You can find the query results in tables intuitively and check the query logs easily. + +## What's next + +After you have successfully connected to your TiDB cluster, you can [explore SQL statements with TiDB](/basic-sql-operations.md). diff --git a/tidb-cloud/connect-to-tidb-cluster.md b/tidb-cloud/connect-to-tidb-cluster.md index b88291a94b4f0..128c807426f89 100644 --- a/tidb-cloud/connect-to-tidb-cluster.md +++ b/tidb-cloud/connect-to-tidb-cluster.md @@ -1,37 +1,19 @@ --- -title: Connect to Your TiDB Cluster -summary: Learn how to connect to your TiDB cluster via different methods. +title: Connect to Your TiDB Dedicated Cluster +summary: Learn how to connect to your TiDB Dedicated cluster via different methods. --- -# Connect to Your TiDB Cluster +# Connect to Your TiDB Dedicated Cluster -After your TiDB cluster is created on TiDB Cloud, you can connect to your TiDB cluster. Depending on whether you are using a TiDB Serverless cluster or a TiDB Dedicated cluster, you can find the available connection methods as follows: +This document introduces the methods to connect to your TiDB Dedicated cluster. -## TiDB Serverless +> **Tip:** +> +> To learn how to connect to a TiDB Serverless cluster, see [Connect to Your TiDB Serverless Cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). -For TiDB Serverless clusters, you can connect to your cluster via one of the following methods: +After your TiDB Dedicated cluster is created on TiDB Cloud, you can connect to it via one of the following methods: -- [Connect via private endpoint](/tidb-cloud/set-up-private-endpoint-connections.md) (recommended) - - Private endpoint connection provides a private endpoint to allow SQL clients in your VPC to securely access services over AWS PrivateLink, which provides highly secure and one-way access to database services with simplified network management. - -- [Connect via standard connection](/tidb-cloud/connect-via-standard-connection.md#tidb-serverless) - - The standard connection exposes a public endpoint with traffic filters, so you can connect to your TiDB cluster via a SQL client from your laptop. - - TiDB Serverless supports [TLS connections](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md), which ensures the security of data transmission from your applications to TiDB clusters. - -- [Connect via Chat2Query (beta)](/tidb-cloud/explore-data-with-chat2query.md) - - TiDB Cloud is powered by artificial intelligence (AI). You can use Chat2Query (beta), an AI-powered SQL editor in the [TiDB Cloud console](https://tidbcloud.com/), to maximize your data value. - - In Chat2Query, you can either simply type `--` followed by your instructions to let AI generate SQL queries automatically or write SQL queries manually, and then run SQL queries against databases without a terminal. You can find the query results in tables intuitively and check the query logs easily. - -## TiDB Dedicated - -For TiDB Dedicated clusters, you can connect to your cluster via one of the following methods: - -- [Connect via standard connection](/tidb-cloud/connect-via-standard-connection.md#tidb-dedicated) +- [Connect via standard connection](/tidb-cloud/connect-via-standard-connection.md) The standard connection exposes a public endpoint with traffic filters, so you can connect to your TiDB cluster via a SQL client from your laptop. You can connect to your TiDB clusters using TLS, which ensures the security of data transmission from your applications to TiDB clusters. diff --git a/tidb-cloud/connect-via-sql-shell.md b/tidb-cloud/connect-via-sql-shell.md index 76a22b50aa8dd..4e042477c6a44 100644 --- a/tidb-cloud/connect-via-sql-shell.md +++ b/tidb-cloud/connect-via-sql-shell.md @@ -9,7 +9,7 @@ In TiDB Cloud SQL Shell, you can try TiDB SQL, test out TiDB's compatibility wit > **Note:** > -> You cannot connect to [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) using SQL Shell. To connect to your TiDB Serverless cluster, see [Connect to TiDB Serverless clusters](/tidb-cloud/connect-to-tidb-cluster.md#tidb-serverless). +> You cannot connect to [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) using SQL Shell. To connect to your TiDB Serverless cluster, see [Connect to TiDB Serverless clusters](/tidb-cloud/connect-to-tidb-cluster-serverless.md). To connect to your TiDB cluster using SQL shell, perform the following steps: diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md new file mode 100644 index 0000000000000..f55c618eecbda --- /dev/null +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -0,0 +1,37 @@ +--- +title: Connect to TiDB Serverless via Public Endpoint +summary: Learn how to connect to your TiDB Serverless cluster via public endpoint. +--- + +# Connect to TiDB Serverless via Public Endpoint + +This document describes how to connect to your TiDB Serverless cluster via public endpoint. With the public endpoint, you can connect to your TiDB Serverless cluster via a SQL client from your laptop. + +> **Tip:** +> +> To learn how to connect to a TiDB Dedicated cluster via public endpoint, see [Connect to TiDB Dedicated via Standard Connection](/tidb-cloud/connect-via-standard-connection.md). + +To connect to a TiDB Serverless cluster via public endpoint, take the following steps: + +1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. + +2. Click **Connect** in the upper-right corner. A connection dialog is displayed. + +3. In the dialog, keep the default setting of the endpoint type as `Public`, and select your preferred connection method and operating system to get the corresponding connection string. + + > **Note:** + > + > - Keeping the endpoint type as `Public` means the connection is via standard TLS connection. For more information, see [TLS Connection to TiDB Serverless](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md). + > - If you choose **Private** in the **Endpoint Type** drop-down list, it means that the connection is via private endpoint. For more information, see [Connect to TiDB Serverless via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). + +4. If you have not set a password yet, click **Create password** to generate a random password. The generated password will not show again, so save your password in a secure location. + +5. Connect to your cluster with the connection string. + + > **Note:** + > + > When you connect to a TiDB Serverless cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). + +## What's next + +After you have successfully connected to your TiDB cluster, you can [explore SQL statements with TiDB](/basic-sql-operations.md). diff --git a/tidb-cloud/connect-via-standard-connection.md b/tidb-cloud/connect-via-standard-connection.md index d624c09b137dd..0514719d120f0 100644 --- a/tidb-cloud/connect-via-standard-connection.md +++ b/tidb-cloud/connect-via-standard-connection.md @@ -1,40 +1,17 @@ --- -title: Connect via Standard Connection +title: Connect to TiDB Dedicated via Standard Connection summary: Learn how to connect to your TiDB Cloud cluster via standard connection. --- -# Connect via Standard Connection +# Connect to TiDB Dedicated via Standard Connection -This document describes how to connect to your TiDB Cloud cluster via standard connection. The standard connection exposes a public endpoint with traffic filters, so you can connect to your TiDB cluster via a SQL client from your laptop. +This document describes how to connect to your TiDB Dedicated cluster via standard connection. The standard connection exposes a public endpoint with traffic filters, so you can connect to your TiDB Dedicated cluster via a SQL client from your laptop. -The standard connection is available to both TiDB Serverless and TiDB Dedicated. +> **Tip:** +> +> To learn how to connect to a TiDB Serverless cluster via standard connection, see [Connect to TiDB Serverless via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md). -## TiDB Serverless - -To connect to a TiDB Serverless cluster via standard connection, perform the following steps: - -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. - -2. Click **Connect** in the upper-right corner. A connection dialog is displayed. - -3. In the dialog, keep the default setting of the endpoint type as `Public`, and select your preferred connection method and operating system to get the corresponding connection string. - - > **Note:** - > - > - Keeping the endpoint type as `Public` means the connection is via standard TLS connection. For more information, see [TLS Connection to TiDB Serverless](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md). - > - If you choose **Private** in the **Endpoint Type** drop-down list, it means that the connection is via private endpoint. For more information, see [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md#tidb-serverless). - -4. If you have not set a password yet, click **Create password** to generate a random password. The generated password will not show again, so save your password in a secure location. - -5. Connect to your cluster with the connection string. - - > **Note:** - > - > When you connect to a TiDB Serverless cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). - -## TiDB Dedicated - -To connect to a TiDB Dedicated cluster via standard connection, perform the following steps: +To connect to a TiDB Dedicated cluster via standard connection, take the following steps: 1. Open the overview page of the target cluster. diff --git a/tidb-cloud/create-tidb-cluster-serverless.md b/tidb-cloud/create-tidb-cluster-serverless.md new file mode 100644 index 0000000000000..c5c25a7467724 --- /dev/null +++ b/tidb-cloud/create-tidb-cluster-serverless.md @@ -0,0 +1,50 @@ +--- +title: Create a TiDB Serverless Cluster +summary: Learn how to create your TiDB Serverless cluster. +--- + +# Create a TiDB Serverless Cluster + +This document describes how to create a TiDB Serverless cluster in the [TiDB Cloud console](https://tidbcloud.com/). + +> **Tip:** +> +> To learn how to create a TiDB Dedicated cluster, see [Create a TiDB Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md). + +## Before you begin + +If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/signup) to sign up for an account. + +- You can either sign up with email and password so that you can manage your password using TiDB Cloud, or sign up with your Google, GitHub, or Microsoft account. +- For AWS Marketplace users, you can also sign up through AWS Marketplace. To do that, search for `TiDB Cloud` in [AWS Marketplace](https://aws.amazon.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. +- For Google Cloud Marketplace users, you can also sign up through Google Cloud Marketplace. To do that, search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. + +## Steps + +To create a TiDB Serverless cluster, take the following steps: + +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/), and then navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page. + +2. Click **Create Cluster**. + +3. On the **Create Cluster** page, **Serverless** is selected by default. + +4. The cloud provider of TiDB Serverless is AWS. You can select an AWS region where you want to host your cluster. + +5. (Optional) Change the spend limit if you plan to use more storage and compute resources than the [free quota](/tidb-cloud/select-cluster-tier.md#usage-quota). If you have not added a payment method, you need to add a credit card after editing the limit. + + > **Note:** + > + > For each organization in TiDB Cloud, you can create a maximum of five TiDB Serverless clusters by default. To create more TiDB Serverless clusters, you need to add a credit card and set a [spend limit](/tidb-cloud/tidb-cloud-glossary.md#spend-limit) for the usage. + +6. Update the default cluster name if necessary, and then click **Create**. + + The cluster creation process starts and your TiDB Cloud cluster will be created in approximately 30 seconds. + +## What's next + +After your cluster is created, follow the instructions in [Connect to TiDB Serverless via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) to create a password for your cluster. + +> **Note:** +> +> If you do not set a password, you cannot connect to the cluster. \ No newline at end of file diff --git a/tidb-cloud/create-tidb-cluster.md b/tidb-cloud/create-tidb-cluster.md index 2b3257c0fbbc7..f2a5837bda93c 100644 --- a/tidb-cloud/create-tidb-cluster.md +++ b/tidb-cloud/create-tidb-cluster.md @@ -1,44 +1,31 @@ --- -title: Create a TiDB Cluster -summary: Learn how to create your TiDB cluster. +title: Create a TiDB Dedicated Cluster +summary: Learn how to create your TiDB Dedicated cluster. --- -# Create a TiDB Cluster +# Create a TiDB Dedicated Cluster -This tutorial guides you through signing up and creating a TiDB cluster. +This tutorial guides you through signing up and creating a TiDB Dedicated cluster. -## Step 1. Create a TiDB Cloud account +> **Tip:** +> +> To learn how to create a TiDB Serverless cluster, see [Create a TiDB Serverless Cluster](/tidb-cloud/create-tidb-cluster-serverless.md). -1. If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/signup) to sign up for an account. +## Before you begin - - You can either sign up with email and password so that you can manage your password using TiDB Cloud, or sign up with your Google, GitHub, or Microsoft account. - - For AWS Marketplace users, you can also sign up through AWS Marketplace. To do that, search for `TiDB Cloud` in [AWS Marketplace](https://aws.amazon.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. - - For Google Cloud Marketplace users, you can also sign up through Google Cloud Marketplace. To do that, search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. +If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/signup) to sign up for an account. -2. [Log in](https://tidbcloud.com/) to your TiDB Cloud account. +- You can either sign up with email and password so that you can manage your password using TiDB Cloud, or sign up with your Google, GitHub, or Microsoft account. +- For AWS Marketplace users, you can also sign up through AWS Marketplace. To do that, search for `TiDB Cloud` in [AWS Marketplace](https://aws.amazon.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. +- For Google Cloud Marketplace users, you can also sign up through Google Cloud Marketplace. To do that, search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. -## Step 2. Select a cluster option +## (Optional) Step 1. Use your default project or create a new project -TiDB Cloud provides the following two options. Before creating a TiDB cluster, consider which option suits your need better: +Once you log in to the [TiDB Cloud console](https://tidbcloud.com/), you have a default [project](/tidb-cloud/tidb-cloud-glossary.md#project). When there is only one project in your organization, your cluster will be created in that project. For more information about projects, see [Organizations and projects](/tidb-cloud/manage-user-access.md#organizations-and-projects). -- TiDB Serverless (Beta) +If you are an organization owner, you can rename the default project or create a new project for the cluster according to your need as follows: - TiDB Serverless is a fully managed service of TiDB. It is still in the beta phase and cannot be used in production. However, you can use TiDB Serverless clusters for non-production workloads such as prototype applications, hackathons, academic courses, or to provide a temporary data service for your datasets. - -- TiDB Dedicated - - TiDB Dedicated is dedicated for production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing). - -For more information about the two options, see [Select Your Cluster Option](/tidb-cloud/select-cluster-tier.md). - -## Step 3. Use your default project or create a new project - -If you are an organization owner, once you log in to TiDB Cloud, you have a default project. For more information about projects, see [Organizations and projects](/tidb-cloud/manage-user-access.md#organizations-and-projects). - -- For free trial users, you can rename the default project if needed. -- For TiDB Dedicated users, you can either rename the default project or create a new project if needed. - -1. Click **Organization** in the upper-right corner of the TiDB Cloud console. +1. Log in to the [TiDB Cloud console](https://tidbcloud.com/), and then click **Organization** in the upper-right corner. 2. Click **Organization Settings**. @@ -51,50 +38,7 @@ If you are an organization owner, once you log in to TiDB Cloud, you have a defa 4. To return to the cluster page, click the TiDB Cloud logo in the upper-left corner of the window. -If you are a project member, you can access only the specific projects to which your organization owner invited you, and you cannot create new projects. To check which project you belong to, take the following steps: - -1. Click **Organization** in the upper-right corner of the TiDB Cloud console. - -2. Click **Organization Settings**. - - The **Projects** tab is displayed by default. - -3. To return to the cluster page, click the TiDB Cloud logo in the upper-left corner of the window. - -## Step 4. Create a TiDB cluster - - -
- -To create a TiDB Serverless cluster, take the following steps: - -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page. - -2. Click **Create Cluster**. - -3. On the **Create Cluster** page, **Serverless** is selected by default. - -4. The cloud provider of TiDB Serverless is AWS. You can select an AWS region where you want to host your cluster. - -5. (Optional) Change the spend limit if you plan to use more storage and compute resources than the [free quota](/tidb-cloud/select-cluster-tier.md#usage-quota). If you have not added a payment method, you need to add a credit card after editing the limit. - - > **Note:** - > - > For each organization in TiDB Cloud, you can create a maximum of five TiDB Serverless clusters by default. To create more TiDB Serverless clusters, you need to add a credit card and set a [spend limit](/tidb-cloud/tidb-cloud-glossary.md#spend-limit) for the usage. - -6. Update the default cluster name if necessary, and then click **Create**. - - The cluster creation process starts and your TiDB Cloud cluster will be created in approximately 30 seconds. - -7. After the cluster is created, follow the instructions in [Connect via Standard Connection](/tidb-cloud/connect-via-standard-connection.md#tidb-serverless) to create a password for your cluster. - - > **Note:** - > - > If you do not set a password, you cannot connect to the cluster. - -
- -
+## Step 2. Create a TiDB Dedicated cluster To create a TiDB Dedicated cluster, take the following steps: @@ -135,9 +79,14 @@ To create a TiDB Dedicated cluster, take the following steps: Your TiDB Cloud cluster will be created in approximately 20 to 30 minutes. -7. In the upper-right corner of your cluster overview page, click **...** and select **Security Settings**. +## Step 3. Configure secure settings + +After your cluster is created, take the following steps to configure the security settings: + +1. In the upper-right corner of your cluster overview page, click **...** and select **Security Settings**. + +2. Set the root password and allowed IP addresses to connect to your cluster, and then click **Apply**. -8. Set the root password and allowed IP addresses to connect to your cluster, and then click **Apply**. +## What's next -
-
+After your cluster is created on TiDB Cloud, you can connect to it via the methods provided in [Connect to Your TiDB Dedicated Cluster](/tidb-cloud/connect-via-standard-connection-serverless.md). \ No newline at end of file diff --git a/tidb-cloud/data-service-get-started.md b/tidb-cloud/data-service-get-started.md index ead279a80456e..1c4719365bdbe 100644 --- a/tidb-cloud/data-service-get-started.md +++ b/tidb-cloud/data-service-get-started.md @@ -17,7 +17,7 @@ This document introduces how to quickly get started with TiDB Cloud Data Service ## Before you begin -Before creating a Data App, make sure that you have created a [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster. If you do not have one, follow the steps in [Create a cluster](/tidb-cloud/create-tidb-cluster.md) to create one. +Before creating a Data App, make sure that you have created a [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster. If you do not have one, follow the steps in [Create a TiDB Serverless cluster](/tidb-cloud/create-tidb-cluster-serverless.md) to create one. ## Step 1. Create a Data App diff --git a/tidb-cloud/data-service-manage-endpoint.md b/tidb-cloud/data-service-manage-endpoint.md index 89d4dcff0637f..4baf8ed9158ac 100644 --- a/tidb-cloud/data-service-manage-endpoint.md +++ b/tidb-cloud/data-service-manage-endpoint.md @@ -11,7 +11,7 @@ This document describes how to manage your endpoints in a Data App in the TiDB C ## Before you begin -Before you manage an endpoint, make sure that you have created a cluster and a Data App. For more information, see [Create a TiDB cluster](/tidb-cloud/create-tidb-cluster.md) and [Create a Data App](/tidb-cloud/data-service-manage-data-app.md#create-a-data-app). +Before you manage an endpoint, make sure that you have created a cluster and a Data App. For more information, see [Create a TiDB Serverless cluster](/tidb-cloud/create-tidb-cluster-serverless.md) and [Create a Data App](/tidb-cloud/data-service-manage-data-app.md#create-a-data-app). Before you call an endpoint, make sure that you have created an API key in the Data App. For more information, see [Create an API key](/tidb-cloud/data-service-api-key.md#create-an-api-key). diff --git a/tidb-cloud/delete-tidb-cluster.md b/tidb-cloud/delete-tidb-cluster.md index 8c7c8be26aa0c..204d8ae6647aa 100644 --- a/tidb-cloud/delete-tidb-cluster.md +++ b/tidb-cloud/delete-tidb-cluster.md @@ -19,11 +19,11 @@ You can delete a cluster at any time by performing the following steps: 3. Click **Delete** in the drop-down menu. 4. In the cluster deleting window, enter the cluster name. - If you want to restore the cluster sometime in the future, make sure that you have a backup of the cluster. Otherwise, you cannot restore it anymore. For more information about how to back up TiDB Dedicated clusters, see [Back up and Restore TiDB Cluster Data](/tidb-cloud/backup-and-restore.md). + If you want to restore the cluster sometime in the future, make sure that you have a backup of the cluster. Otherwise, you cannot restore it anymore. For more information about how to back up TiDB Dedicated clusters, see [Back Up and Restore TiDB Dedicated Data](/tidb-cloud/backup-and-restore.md). > **Note:** > - > For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the backup and restore feature is unavailable. You can use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export your data as a backup. + > [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) only support [in-place restoring from backups](/tidb-cloud/backup-and-restore-serverless.md#restore) and do not support restoring data after the deletion. If you want to delete a TiDB Serverless cluster and restore its data in the future, you can use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export your data as a backup. 5. Click **I understand the consequences. Delete this cluster**. @@ -32,4 +32,4 @@ You can delete a cluster at any time by performing the following steps: - For backup files from an automatic backup, the recycle bin can retain them for 7 days. - For backup files from a manual backup, there is no expiration date. - If you want to restore a cluster from recycle bin, see [Restore a deleted cluster](/tidb-cloud/backup-and-restore.md#restore-a-deleted-cluster). + If you want to restore a TiDB Dedicated cluster from recycle bin, see [Restore a deleted cluster](/tidb-cloud/backup-and-restore.md#restore-a-deleted-cluster). diff --git a/tidb-cloud/export-data-from-tidb-cloud.md b/tidb-cloud/export-data-from-tidb-cloud.md index 9f8098cedee38..8c2552c05253b 100644 --- a/tidb-cloud/export-data-from-tidb-cloud.md +++ b/tidb-cloud/export-data-from-tidb-cloud.md @@ -41,12 +41,12 @@ You can use the tool [Dumpling](/dumpling-overview.md) for data export. 4. Export your data using Dumpling from TiDB. - You can get the following connection parameters `${tidb_endpoint}`, `${port}`, and `${user}` from the connection string in the [**Connect**](/tidb-cloud/connect-via-standard-connection.md) dialog. -
+ You can get the following connection parameters `${tidb_endpoint}`, `${port}`, and `${user}` from the connection string in the [**Connect**](/tidb-cloud/connect-via-standard-connection-serverless.md) dialog. + ```shell tiup dumpling -h ${tidb_endpoint} -P 4000 -u ${user} -p ${password} -F 67108864MiB -t 4 -o ${export_dir} --filetype sql --consistency none ``` @@ -58,6 +58,8 @@ You can use the tool [Dumpling](/dumpling-overview.md) for data export.
+ You can get the following connection parameters `${tidb_endpoint}`, `${port}`, and `${user}` from the connection string in the [**Connect**](/tidb-cloud/connect-via-standard-connection.md) dialog. + ```shell tiup dumpling:v6.5.2 -h ${tidb_endpoint} -P ${port} -u ${user} -p ${password} -F 67108864MiB -t 4 -o ${export_dir} --filetype sql ``` diff --git a/tidb-cloud/index-insight.md b/tidb-cloud/index-insight.md index 29197e86100e9..5557e1e51f107 100644 --- a/tidb-cloud/index-insight.md +++ b/tidb-cloud/index-insight.md @@ -26,7 +26,7 @@ This section introduces how to enable the Index Insight feature and obtain recom ### Before you begin -Before enabling the Index Insight feature, make sure that you have created a TiDB Dedicated cluster. If you do not have one, follow the steps in [Create a cluster](/tidb-cloud/create-tidb-cluster.md) to create one. +Before enabling the Index Insight feature, make sure that you have created a TiDB Dedicated cluster. If you do not have one, follow the steps in [Create a TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) to create one. ### Step 1: Enable Index Insight @@ -46,7 +46,7 @@ Before enabling the Index Insight feature, make sure that you have created a TiD > **Note:** > - > To connect to your TiDB Dedicated cluster, see [Connect to a TiDB cluster](/tidb-cloud/connect-to-tidb-cluster.md). + > To connect to your TiDB Dedicated cluster, see [Connect to a TiDB Dedicated cluster](/tidb-cloud/connect-to-tidb-cluster.md). 4. Enter the username and password of the SQL user created in the preceding step. Then, click **Activate** to initiate the activation process. diff --git a/tidb-cloud/integrate-tidbcloud-with-airbyte.md b/tidb-cloud/integrate-tidbcloud-with-airbyte.md index d1ec06d29f54f..13860d51f29a5 100644 --- a/tidb-cloud/integrate-tidbcloud-with-airbyte.md +++ b/tidb-cloud/integrate-tidbcloud-with-airbyte.md @@ -46,7 +46,7 @@ Conveniently, the steps are the same for setting TiDB as the source and the dest 1. Click **Sources** or **Destinations** in the sidebar and choose TiDB type to create a new TiDB connector. -2. Fill in the following parameters. See [Connect via standard connection](/tidb-cloud/connect-via-standard-connection.md) to get the connection information from the connection string. +2. Fill in the following parameters. - Host: The endpoint of your TiDB Cloud cluster - Port: The port of the database @@ -54,6 +54,8 @@ Conveniently, the steps are the same for setting TiDB as the source and the dest - Username: The username to access the database - Password: The password of the username + You can get the parameter values from the connection dialog of your cluster. To open the dialog, click the ☰ hover menu in the upper-left corner of the [TiDB Cloud console](https://tidbcloud.com/), click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. + 3. Enable **SSL Connection**, and set TLS protocols to **TLSv1.2** or **TLSv1.3** in **JDBC URL Params**. > Note: diff --git a/tidb-cloud/integrate-tidbcloud-with-dbt.md b/tidb-cloud/integrate-tidbcloud-with-dbt.md index 3946c22a39339..8f17611e79ae3 100644 --- a/tidb-cloud/integrate-tidbcloud-with-dbt.md +++ b/tidb-cloud/integrate-tidbcloud-with-dbt.md @@ -90,7 +90,7 @@ To configure the project, take the following steps: password: "your_password" # The password to use for authenticating to the TiDB Cloud clusters ``` - You can get the values of `server`, `port`, and `username` from the [**Connect**](/tidb-cloud/connect-via-standard-connection.md) dialog in TiDB Cloud console. + You can get the values of `server`, `port`, and `username` from the connection dialog of your cluster. To open this dialog, click the ☰ hover menu in the upper-left corner of the [TiDB Cloud console](https://tidbcloud.com/), click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. 2. Complete the project configuration. diff --git a/tidb-cloud/integrate-tidbcloud-with-netlify.md b/tidb-cloud/integrate-tidbcloud-with-netlify.md index 22d63b8feb81e..60314a8090082 100644 --- a/tidb-cloud/integrate-tidbcloud-with-netlify.md +++ b/tidb-cloud/integrate-tidbcloud-with-netlify.md @@ -22,7 +22,10 @@ You are expected to have a Netlify account and CLI. If you do not have any, refe ### A TiDB Cloud account and a TiDB cluster -You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to [Create a TiDB cluster](/tidb-cloud/create-tidb-cluster.md). +You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to the following to create one: + +- [Create a TiDB Serverless cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) One TiDB Cloud cluster can connect to multiple Netlify sites. @@ -96,7 +99,7 @@ For a TiDB Dedicated cluster, you can get the connection string only from the Ti
-1. Navigate to the [TiDB Cloud console](https://tidbcloud.com/), and get the following connection parameters from the connection string in the [**Connect**](/tidb-cloud/connect-via-standard-connection.md) dialog. +1. In the [TiDB Cloud console](https://tidbcloud.com/), click the ☰ hover menu in the upper-left corner, click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. In the displayed dialog, you can get the following connection parameters from the connection string. - `${host}` - `${port}` diff --git a/tidb-cloud/integrate-tidbcloud-with-vercel.md b/tidb-cloud/integrate-tidbcloud-with-vercel.md index 8b041351ee60b..bff6e23dca2d2 100644 --- a/tidb-cloud/integrate-tidbcloud-with-vercel.md +++ b/tidb-cloud/integrate-tidbcloud-with-vercel.md @@ -31,7 +31,10 @@ One Vercel project can only connect to one TiDB Cloud cluster. To change the int ### A TiDB Cloud account and a TiDB cluster -You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to [Create a TiDB cluster](/tidb-cloud/create-tidb-cluster.md). +You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to the following to create one: + +- [Create a TiDB Serverless cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) To [integrate with Vercel via the TiDB Cloud Vercel Integration](#connect-via-the-tidb-cloud-vercel-integration), you are expected to have the "Owner" access to your organization or the "Member" access to the target project in TiDB Cloud. For more information, see [Manage role access](/tidb-cloud/manage-user-access.md#manage-role-access). @@ -88,7 +91,9 @@ DATABASE_URL ## Connect via manually setting environment variables -1. Follow the steps in [Connect to a TiDB Cloud cluster via standard connection](/tidb-cloud/connect-via-standard-connection.md) to get the connection information of your TiDB cluster. +1. Get the connection information of your TiDB cluster. + + You can get the connection information from the connection dialog of your cluster. To open the dialog, click the ☰ hover menu in the upper-left corner of the [TiDB Cloud console](https://tidbcloud.com/), click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. > **Note:** > diff --git a/tidb-cloud/manage-serverless-spend-limit.md b/tidb-cloud/manage-serverless-spend-limit.md index 92a9b88ea86c7..ea385e31ac05a 100644 --- a/tidb-cloud/manage-serverless-spend-limit.md +++ b/tidb-cloud/manage-serverless-spend-limit.md @@ -24,7 +24,7 @@ Once the free quota of a cluster is reached, the read and write operations on th To learn more about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [TiDB Serverless Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). -If you want to create a TiDB Serverless cluster with an additional quota, you can edit the spend limit on the cluster creation page. For more information, see [Create a TiDB cluster](/tidb-cloud/create-tidb-cluster.md#step-4-create-a-tidb-cluster). +If you want to create a TiDB Serverless cluster with an additional quota, you can edit the spend limit on the cluster creation page. For more information, see [Create a TiDB Serverless cluster](/tidb-cloud/create-tidb-cluster-serverless.md). ## Update spend limit diff --git a/tidb-cloud/migrate-from-mysql-using-data-migration.md b/tidb-cloud/migrate-from-mysql-using-data-migration.md index cbb9012705d97..e9423824153bb 100644 --- a/tidb-cloud/migrate-from-mysql-using-data-migration.md +++ b/tidb-cloud/migrate-from-mysql-using-data-migration.md @@ -104,11 +104,11 @@ To quickly test a migration job, you can use the `root` account of the TiDB Clou ### Set up network connection -Before creating a migration job, set up the network connection according to your connection methods. See [Connect to Your TiDB Cluster](/tidb-cloud/connect-to-tidb-cluster.md). +Before creating a migration job, set up the network connection according to your connection methods. See [Connect to Your TiDB Dedicated Cluster](/tidb-cloud/connect-to-tidb-cluster.md). - If you use public IP (this is, standard connection) for network connection, make sure that the upstream database can be connected through the public network. -- If you use AWS PrivateLink, set it up according to [Set Up Private Endpoint Connections](/tidb-cloud/set-up-private-endpoint-connections.md). +- If you use AWS PrivateLink, set it up according to [Connect to TiDB Dedicated via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md). - If you use AWS VPC Peering or GCP VPC Network Peering, see the following instructions to configure the network. diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index b31f770411dc5..c5cee33aba3b7 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -1,11 +1,11 @@ --- -title: Pause or Resume a TiDB Cluster -summary: Learn how to pause or resume a TiDB cluster. +title: Pause or Resume a TiDB Dedicated Cluster +summary: Learn how to pause or resume a TiDB Dedicated cluster. --- -# Pause or Resume a TiDB Cluster +# Pause or Resume a TiDB Dedicated Cluster -You can easily pause and resume a cluster that is not in operation at all times in TiDB Cloud. +You can easily pause and resume a TiDB Dedicated cluster that is not in operation at all times in TiDB Cloud. The pause does not affect your data stored in the cluster but only stops the collection of monitoring information and the consumption of computing resources. After the pause, you can resume your cluster at any time. @@ -70,6 +70,6 @@ To resume a paused cluster, take the following steps: 3. In the dialog, click **Resume** to confirm your choice. The cluster status becomes **RESUMING**. -Depending on your cluster size, it can take several minutes to resume the cluster. After the cluster is resumed, the cluster state changes from **RESUMING**to **AVAILABLE**. +Depending on your cluster size, it can take several minutes to resume the cluster. After the cluster is resumed, the cluster state changes from **RESUMING** to **AVAILABLE**. You can also resume a cluster using TiDB Cloud API. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). diff --git a/tidb-cloud/release-notes-2022.md b/tidb-cloud/release-notes-2022.md index 7ca10c3e6ae00..972e344b54c3e 100644 --- a/tidb-cloud/release-notes-2022.md +++ b/tidb-cloud/release-notes-2022.md @@ -92,7 +92,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - Introduce the left navigation bar to maximize screen usage efficiency. - Adopt a flatter navigation hierarchy. -- Improve the [**Connect**](/tidb-cloud/connect-to-tidb-cluster.md) experience for Serverless Tier users. +- Improve the [**Connect**](/tidb-cloud/connect-to-tidb-cluster-serverless.md) experience for Serverless Tier users. Now developers can connect to SQL editor or with their preferred tools in just a few clicks without context switching. diff --git a/tidb-cloud/serverless-tier-limitations.md b/tidb-cloud/serverless-tier-limitations.md index d3fff1b7c2348..90f4214cbd9b4 100644 --- a/tidb-cloud/serverless-tier-limitations.md +++ b/tidb-cloud/serverless-tier-limitations.md @@ -29,7 +29,7 @@ We are constantly filling in the feature gaps between TiDB Serverless and TiDB D ### Connection -- Only [Standard Connection](/tidb-cloud/connect-via-standard-connection.md) and [Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md) can be used. You cannot use [VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) to connect to TiDB Serverless clusters.  +- Only [Standard Connection](/tidb-cloud/connect-via-standard-connection-serverless.md) and [Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) can be used. You cannot use [VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) to connect to TiDB Serverless clusters.  - No "IP Access List" support. ### Monitoring @@ -66,6 +66,6 @@ Once the free quota of a cluster is reached, the read and write operations on th To learn more about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [TiDB Serverless Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). -If you want to create a TiDB Serverless cluster with an additional quota, you can edit the spend limit on the cluster creation page. For more information, see [Create a TiDB cluster](/tidb-cloud/create-tidb-cluster.md#step-4-create-a-tidb-cluster). +If you want to create a TiDB Serverless cluster with an additional quota, you can edit the spend limit on the cluster creation page. For more information, see [Create a TiDB Serverless cluster](/tidb-cloud/create-tidb-cluster-serverless.md). After creating a TiDB Serverless, you can still check and edit the spend limit on your cluster overview page. For more information, see [Manage Spend Limit for TiDB Serverless Clusters](/tidb-cloud/manage-serverless-spend-limit.md). diff --git a/tidb-cloud/set-up-private-endpoint-connections-serverless.md b/tidb-cloud/set-up-private-endpoint-connections-serverless.md new file mode 100644 index 0000000000000..293bc3d7c8a29 --- /dev/null +++ b/tidb-cloud/set-up-private-endpoint-connections-serverless.md @@ -0,0 +1,125 @@ +--- +title: Connect to TiDB Serverless via Private Endpoint +summary: Learn how to connect to your TiDB Cloud cluster via private endpoint. +--- + +# Connect to TiDB Serverless via Private Endpoint + +This document describes how to connect to your TiDB Serverless cluster via private endpoint. + +> **Tip:** +> +> To learn how to connect to a TiDB Dedicated cluster via private endpoint, see [Connect to TiDB Dedicated via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md). + +TiDB Cloud supports highly secure and one-way access to the TiDB Cloud service hosted in an AWS VPC via the [AWS PrivateLink](https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc), as if the service were in your own VPC. A private endpoint is exposed in your VPC and you can create a connection to the TiDB Cloud service via the endpoint with permission. + +Powered by AWS PrivateLink, the endpoint connection is secure and private, and does not expose your data to the public internet. In addition, the endpoint connection supports CIDR overlap and is easier for network management. + +The architecture of the private endpoint is as follows: + +![Private endpoint architecture](/media/tidb-cloud/aws-private-endpoint-arch.png) + +For more detailed definitions of the private endpoint and endpoint service, see the following AWS documents: + +- [What is AWS PrivateLink?](https://docs.aws.amazon.com/vpc/latest/privatelink/what-is-privatelink.html) +- [AWS PrivateLink concepts](https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html) + +## Restrictions + +- Currently, TiDB Cloud supports private endpoint connection only when the endpoint service is hosted in AWS. If the service is hosted in Google Cloud Platform (GCP), the private endpoint is not applicable. +- Private endpoint connection across regions is not supported. + +## Set up a private endpoint with AWS + +To connect to your TiDB Serverless cluster via a private endpoint, follow these steps: + +1. [Choose a TiDB cluster](#step-1-choose-a-tidb-cluster) +2. [Create an AWS interface endpoint](#step-2-create-an-aws-interface-endpoint) +3. [Connect to your TiDB cluster](#step-3-connect-to-your-tidb-cluster) + +### Step 1. Choose a TiDB cluster + +1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target TiDB Serverless cluster to go to its overview page. +2. Click **Connect** in the upper-right corner. A connection dialog is displayed. +3. In the **Endpoint Type** drop-down list, select **Private**. +4. Take a note of **Service Name**, **Availability Zone ID**, and **Region ID**. + + > **Note:** + > + > You only need to create one private endpoint per AWS region, which can be shared by all TiDB Serverless clusters located in the same region. + +### Step 2. Create an AWS interface endpoint + + +
+ +To use the AWS Management Console to create a VPC interface endpoint, perform the following steps: + +1. Sign in to the [AWS Management Console](https://aws.amazon.com/console/) and open the Amazon VPC console at . +2. Click **Endpoints** in the navigation pane, and then click **Create Endpoint** in the upper-right corner. + + The **Create endpoint** page is displayed. + + ![Verify endpoint service](/media/tidb-cloud/private-endpoint/create-endpoint-2.png) + +3. Select **Other endpoint services**. +4. Enter the service name that you found in [step 1](#step-1-choose-a-tidb-cluster). +5. Click **Verify service**. +6. Select your VPC in the drop-down list. Expand **Additional settings** and select the **Enable DNS name** checkbox. +7. In the **Subnets** area, select the availability zone where your TiDB cluster is located, and select the Subnet ID. +8. Select your security group properly in the **Security groups** area. + + > **Note:** + > + > Make sure the selected security group allows inbound access from your EC2 instances on port 4000. + +9. Click **Create endpoint**. + +
+
+ +To use the AWS CLI to create a VPC interface endpoint, perform the following steps: + +1. To get the **VPC ID** and **Subnet ID**, navigate to your AWS Management Console, and locate them in the relevant sections. Make sure that you fill in the **Availability Zone ID** that you found in [step 1](#step-1-choose-a-tidb-cluster). +2. Copy the command provided below, replace the relevant arguments with the information you obtained, and then execute it in your terminal. + +```bash +aws ec2 create-vpc-endpoint --vpc-id ${your_vpc_id} --region ${region_id} --service-name ${service_name} --vpc-endpoint-type Interface --subnet-ids ${your_subnet_id} +``` + +> **Tip:** +> +> Before running the command, you need to have AWS CLI installed and configured. See [AWS CLI configuration basics](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html) for details. + +
+
+ +Then you can connect to the endpoint service with the private DNS name. + +### Step 3: Connect to your TiDB cluster + +After you have created the interface endpoint, go back to the TiDB Cloud console and take the following steps: + +1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target cluster to go to its overview page. +2. Click **Connect** in the upper-right corner. A connection dialog is displayed. +3. In the **Endpoint Type** drop-down list, select **Private**. +4. In the **Connect With** drop-down list, select your preferred connection method. The corresponding connection string is displayed at the bottom of the dialog. +5. Connect to your cluster with the connection string. + +> **Tip:** +> +> If you cannot connect to the cluster, the reason might be that the security group of your VPC endpoint in AWS is not properly set. See [this FAQ](#troubleshooting) for solutions. +> +> 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`, it is due to that a private endpoint has already been created, and creating a new one is unnecessary. + +## Troubleshooting + +### I cannot connect to a TiDB cluster via a private endpoint after enabling private DNS. Why? + +You might need to properly set the security group for your VPC endpoint in the AWS Management Console. Go to **VPC** > **Endpoints**. Right-click your VPC endpoint and select the proper **Manage security groups**. A proper security group within your VPC that allows inbound access from your EC2 instances on Port 4000 or a customer-defined port. + +![Manage security groups](/media/tidb-cloud/private-endpoint/manage-security-groups.png) + +### I cannot enable private DNS. An error is reported indicating that the `enableDnsSupport` and `enableDnsHostnames` VPC attributes are not enabled + +Make sure that DNS hostname and DNS resolution are both enabled in your VPC setting. They are disabled by default when you create a VPC in the AWS Management Console. diff --git a/tidb-cloud/set-up-private-endpoint-connections.md b/tidb-cloud/set-up-private-endpoint-connections.md index 1460056542958..81f025f18e22c 100644 --- a/tidb-cloud/set-up-private-endpoint-connections.md +++ b/tidb-cloud/set-up-private-endpoint-connections.md @@ -1,9 +1,15 @@ --- -title: Connect via Private Endpoint +title: Connect to TiDB Dedicated via Private Endpoint summary: Learn how to connect to your TiDB Cloud cluster via private endpoint. --- -# Connect via Private Endpoint +# Connect to TiDB Dedicated via Private Endpoint + +This document describes how to connect to your TiDB Dedicated cluster via private endpoint. + +> **Tip:** +> +> To learn how to connect to a TiDB Serverless cluster via private endpoint, see [Connect to TiDB Serverless via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). TiDB Cloud supports highly secure and one-way access to the TiDB Cloud service hosted in an AWS VPC via the [AWS PrivateLink](https://aws.amazon.com/privatelink/?privatelink-blogs.sort-by=item.additionalFields.createdDate&privatelink-blogs.sort-order=desc), as if the service were in your own VPC. A private endpoint is exposed in your VPC and you can create a connection to the TiDB Cloud service via the endpoint with permission. @@ -31,93 +37,6 @@ In most scenarios, you are recommended to use private endpoint connection over V ## Set up a private endpoint with AWS -This section describes how to set up a private endpoint with AWS PrivateLink for a TiDB Serverless cluster and a TiDB Dedicated cluster. - -### TiDB Serverless - -To connect to your TiDB Serverless cluster via a private endpoint, follow these steps: - -1. [Choose a TiDB cluster](#step-1-choose-a-tidb-cluster) -2. [Create an AWS interface endpoint](#step-2-create-an-aws-interface-endpoint) -3. [Connect to your TiDB cluster](#step-3-connect-to-your-tidb-cluster) - -#### Step 1. Choose a TiDB cluster - -1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target TiDB Serverless cluster to go to its overview page. -2. Click **Connect** in the upper-right corner. A connection dialog is displayed. -3. In the **Endpoint Type** drop-down list, select **Private**. -4. Take a note of **Service Name**, **Availability Zone ID**, and **Region ID**. - - > **Note:** - > - > You only need to create one private endpoint per AWS region, which can be shared by all TiDB Serverless clusters located in the same region. - -#### Step 2. Create an AWS interface endpoint - - -
- -To use the AWS Management Console to create a VPC interface endpoint, perform the following steps: - -1. Sign in to the [AWS Management Console](https://aws.amazon.com/console/) and open the Amazon VPC console at . -2. Click **Endpoints** in the navigation pane, and then click **Create Endpoint** in the upper-right corner. - - The **Create endpoint** page is displayed. - - ![Verify endpoint service](/media/tidb-cloud/private-endpoint/create-endpoint-2.png) - -3. Select **Other endpoint services**. -4. Enter the service name that you found in [step 1](#step-1-choose-a-tidb-cluster). -5. Click **Verify service**. -6. Select your VPC in the drop-down list. Expand **Additional settings** and select the **Enable DNS name** checkbox. -7. In the **Subnets** area, select the availability zone where your TiDB cluster is located, and select the Subnet ID. -8. Select your security group properly in the **Security groups** area. - - > **Note:** - > - > Make sure the selected security group allows inbound access from your EC2 instances on port 4000. - -9. Click **Create endpoint**. - -
-
- -To use the AWS CLI to create a VPC interface endpoint, perform the following steps: - -1. To get the **VPC ID** and **Subnet ID**, navigate to your AWS Management Console, and locate them in the relevant sections. Make sure that you fill in the **Availability Zone ID** that you found in [step 1](#step-1-choose-a-tidb-cluster). -2. Copy the command provided below, replace the relevant arguments with the information you obtained, and then execute it in your terminal. - -```bash -aws ec2 create-vpc-endpoint --vpc-id ${your_vpc_id} --region ${region_id} --service-name ${service_name} --vpc-endpoint-type Interface --subnet-ids ${your_subnet_id} -``` - -> **Tip:** -> -> Before running the command, you need to have AWS CLI installed and configured. See [AWS CLI configuration basics](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html) for details. - -
-
- -Then you can connect to the endpoint service with the private DNS name. - -#### Step 3: Connect to your TiDB cluster - -After you have created the interface endpoint, go back to the TiDB Cloud console and take the following steps: - -1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target cluster to go to its overview page. -2. Click **Connect** in the upper-right corner. A connection dialog is displayed. -3. In the **Endpoint Type** drop-down list, select **Private**. -4. In the **Connect With** drop-down list, select your preferred connection method. The corresponding connection string is displayed at the bottom of the dialog. -5. Connect to your cluster with the connection string. - -> **Tip:** -> -> If you cannot connect to the cluster, the reason might be that the security group of your VPC endpoint in AWS is not properly set. See [this FAQ](#troubleshooting) for solutions. -> -> 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`, it is due to that a private endpoint has already been created, and creating a new one is unnecessary. - -### TiDB Dedicated - To connect to your TiDB Dedicated cluster via a private endpoint, complete the [prerequisites](#prerequisites) and follow these steps: 1. [Choose a TiDB cluster](#step-1-choose-a-tidb-cluster) @@ -129,7 +48,7 @@ To connect to your TiDB Dedicated cluster via a private endpoint, complete the [ If you have multiple clusters, you need to repeat these steps for each cluster that you want to connect to using AWS PrivateLink. -#### Prerequisites +### Prerequisites 1. Log in to the [TiDB Cloud console](https://tidbcloud.com). 2. In the left navigation pane of the [**Clusters**](https://tidbcloud.com/console/clusters) page, do one of the following: @@ -140,12 +59,12 @@ If you have multiple clusters, you need to repeat these steps for each cluster t 3. Click the **Private Endpoint** tab. 4. Click **Add** in the upper-right corner. -#### Step 1. Choose a TiDB cluster +### Step 1. Choose a TiDB cluster 1. Click the drop-down list and choose an available TiDB Dedicated cluster. 2. Click **Next**. -#### Step 2. Check the service endpoint region +### Step 2. Check the service endpoint region Your service endpoint region is selected by default. Have a quick check and click **Next**. @@ -153,7 +72,7 @@ Your service endpoint region is selected by default. Have a quick check and clic > > The default region is where your cluster is located. Do not change it. Cross-region private endpoint is currently not supported. -#### Step 3. Create an AWS interface endpoint +### Step 3. Create an AWS interface endpoint > **Note:** > @@ -216,13 +135,13 @@ To use the AWS CLI to create a VPC interface endpoint, perform the following ste
-#### Step 4. Accept the endpoint connection +### Step 4. Accept the endpoint connection 1. Go back to the TiDB Cloud console. 2. Fill in the box with your VPC endpoint ID on the **Create Private Endpoint** page. 3. Click **Next**. -#### Step 5. Enable private DNS +### Step 5. Enable private DNS Enable private DNS in AWS. You can either use the AWS Management Console or the AWS CLI. @@ -254,7 +173,7 @@ Click **Create** in the TiDB Cloud console to finalize the creation of the priva Then you can connect to the endpoint service. -#### Step 6: Connect to your TiDB cluster +### Step 6: Connect to your TiDB cluster After you have enabled the private DNS, go back to the TiDB Cloud console and take the following steps: @@ -267,7 +186,7 @@ After you have enabled the private DNS, go back to the TiDB Cloud console and ta > > If you cannot connect to the cluster, the reason might be that the security group of your VPC endpoint in AWS is not properly set. See [this FAQ](#troubleshooting) for solutions. -#### Private endpoint status reference +### Private endpoint status reference When you use private endpoint connections, the statuses of private endpoints or private endpoint services are displayed on the [**Private Endpoint** page](#prerequisites). diff --git a/tidb-cloud/set-up-vpc-peering-connections.md b/tidb-cloud/set-up-vpc-peering-connections.md index 67356921b8d3b..de2cd0718458b 100644 --- a/tidb-cloud/set-up-vpc-peering-connections.md +++ b/tidb-cloud/set-up-vpc-peering-connections.md @@ -1,9 +1,9 @@ --- -title: Connect via VPC Peering -summary: Learn how to connect to TiDB Cloud via VPC peering. +title: Connect to TiDB Dedicated via VPC Peering +summary: Learn how to connect to TiDB Dedicated via VPC peering. --- -# Connect via VPC Peering +# Connect to TiDB Dedicated via VPC Peering > **Note:** > diff --git a/tidb-cloud/terraform-use-import-resource.md b/tidb-cloud/terraform-use-import-resource.md index 1087d884589ae..333b805ef5c29 100644 --- a/tidb-cloud/terraform-use-import-resource.md +++ b/tidb-cloud/terraform-use-import-resource.md @@ -16,7 +16,7 @@ The features of the `tidbcloud_import` resource include the following: ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). -- [Create a TiDB Serverless or TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). +- [Create a TiDB Serverless cluster](/tidb-cloud/create-tidb-cluster-serverless.md) or [Create a TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). ## Create and run an import task diff --git a/tidb-cloud/tidb-cloud-billing.md b/tidb-cloud/tidb-cloud-billing.md index 47ea19381c1e6..4f8e241384ca2 100644 --- a/tidb-cloud/tidb-cloud-billing.md +++ b/tidb-cloud/tidb-cloud-billing.md @@ -214,7 +214,10 @@ To learn more about contracts, feel free to [contact our sales](https://www.ping If you are the owner or billing administrator of your organization, you can link your TiDB Cloud account to an AWS billing account or Google Cloud billing account. Otherwise, skip this section. -If you are new to TiDB Cloud and do not have a TiDB Cloud account, you can sign up for a TiDB Cloud account through [AWS Marketplace](https://aws.amazon.com/marketplace) or [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), and pay for the usage via the AWS or GCP billing account. For more details, refer to [Create a TiDB Cloud account](/tidb-cloud/create-tidb-cluster.md#step-1-create-a-tidb-cloud-account). +If you are new to TiDB Cloud and do not have a TiDB Cloud account, you can sign up for a TiDB Cloud account through [AWS Marketplace](https://aws.amazon.com/marketplace) or [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), and pay for the usage via the AWS or GCP billing account. + +- To sign up through AWS Marketplace, search for `TiDB Cloud` in [AWS Marketplace](https://aws.amazon.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. +- To sign up through Google Cloud Marketplace, search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. If you already have a TiDB Cloud account and you want to pay for the usage via your AWS or GCP billing account, you can link your TiDB Cloud account to your AWS or GCP billing account. diff --git a/tidb-cloud/tidb-cloud-faq.md b/tidb-cloud/tidb-cloud-faq.md index ab12866721547..637f9eed418b4 100644 --- a/tidb-cloud/tidb-cloud-faq.md +++ b/tidb-cloud/tidb-cloud-faq.md @@ -57,7 +57,7 @@ The best way to learn about TiDB Cloud is to follow our step-by-step tutorial. C - [TiDB Cloud Introduction](/tidb-cloud/tidb-cloud-intro.md) - [Get Started](/tidb-cloud/tidb-cloud-quickstart.md) -- [Create a TiDB Cluster](/tidb-cloud/create-tidb-cluster.md) +- [Create a TiDB Serverless Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) ## Architecture FAQs @@ -159,6 +159,9 @@ For TiDB Serverless clusters, TiDB Cloud ensures cluster security with the follo ### How do I connect to my database in a TiDB cluster? + +
+ For a TiDB Dedicated cluster, the steps to connect to your cluster are simplified as follows: 1. Authorize your network. @@ -166,12 +169,21 @@ For a TiDB Dedicated cluster, the steps to connect to your cluster are simplifie 3. Download and configure TLS for your cluster server. 4. Choose a SQL client, get an auto-generated connection string displayed on the TiDB Cloud UI, and then connect to your cluster through the SQL client using the string. +For more information, see [Connect to Your TiDB Dedicated Cluster](/tidb-cloud/connect-to-tidb-cluster.md). + +
+ +
+ For a TiDB Serverless cluster, the steps to connect to your cluster are simplified as follows: 1. Set a database user and login credential. 2. Choose a SQL client, get an auto-generated connection string displayed on the TiDB Cloud UI, and then connect to your cluster through the SQL client using the string. -For more information, see [Connect to Your TiDB Cluster](/tidb-cloud/connect-to-tidb-cluster.md). +For more information, see [Connect to Your TiDB Serverless Cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). + +
+
## Support FAQ diff --git a/tidb-cloud/tidb-cloud-poc.md b/tidb-cloud/tidb-cloud-poc.md index a0d1cceefe573..6fb429c8d2899 100644 --- a/tidb-cloud/tidb-cloud-poc.md +++ b/tidb-cloud/tidb-cloud-poc.md @@ -58,7 +58,7 @@ You might also be interested in using [TiFlash](https://docs.pingcap.com/tidb/st ## Step 3. Sign up and create a TiDB Dedicated cluster for the PoC -To create a TiDB Dedicated cluster for the PoC, take the following steps: +To create a [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster for the PoC, take the following steps: 1. Fill in the PoC application form by doing one of the following: @@ -67,16 +67,16 @@ To create a TiDB Dedicated cluster for the PoC, take the following steps: Once you submit the form, the TiDB Cloud Support team will review your application, contact you, and transfer credits to your account once the application is approved. You can also contact a PingCAP support engineer to assist with your PoC procedures to ensure the PoC runs as smoothly as possible. -2. Refer to [Quick Start](/tidb-cloud/tidb-cloud-quickstart.md) to create a [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster for the PoC. +2. Refer to [Create a TiDB Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md) to create a TiDB Dedicated cluster for the PoC. Capacity planning is recommended for cluster sizing before you create a cluster. You can start with estimated numbers of TiDB, TiKV, or TiFlash nodes, and scale out the cluster later to meet performance requirements. You can find more details in the following documents or consult our support team. - For more information about estimation practice, see [Size Your TiDB](/tidb-cloud/size-your-cluster.md). -- For configurations of the TiDB Dedicated cluster, see [Create a TiDB Cluster](/tidb-cloud/create-tidb-cluster.md). Configure the cluster size for TiDB, TiKV, and TiFlash (optional) respectively. +- For configurations of the TiDB Dedicated cluster, see [Create a TiDB Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md). Configure the cluster size for TiDB, TiKV, and TiFlash (optional) respectively. - For how to plan and optimize your PoC credits consumption effectively, see [FAQ](#faq) in this document. - For more information about scaling, see [Scale Your TiDB Cluster](/tidb-cloud/scale-tidb-cluster.md). -Once a dedicated PoC cluster is created, you are ready to load data and perform a series of tests. For how to connect to a TiDB cluster, see [Connect to Your TiDB Cluster](/tidb-cloud/connect-to-tidb-cluster.md). +Once a dedicated PoC cluster is created, you are ready to load data and perform a series of tests. For how to connect to a TiDB cluster, see [Connect to Your TiDB Dedicated Cluster](/tidb-cloud/connect-to-tidb-cluster.md). For a newly created cluster, note the following configurations: diff --git a/tidb-cloud/tidb-cloud-quickstart.md b/tidb-cloud/tidb-cloud-quickstart.md index 9d69844132596..f83a53db62cbc 100644 --- a/tidb-cloud/tidb-cloud-quickstart.md +++ b/tidb-cloud/tidb-cloud-quickstart.md @@ -89,7 +89,7 @@ TiDB Cloud offers interactive tutorials with crafted sample datasets to help you ## What's next -- For how to connect to your cluster via different methods, see [Connect to a TiDB cluster](/tidb-cloud/connect-to-tidb-cluster.md). +- For how to connect to your cluster via different methods, see [Connect to a TiDB Serverless cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). - For more information about how to use Chat2Query to explore your data, see [Chat2Query](/tidb-cloud/explore-data-with-chat2query.md). - For TiDB SQL usage, see [Explore SQL with TiDB](/basic-sql-operations.md). -- For production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing), see [Create a TiDB cluster](/tidb-cloud/create-tidb-cluster.md) to create a TiDB Dedicated cluster. +- For production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing), see [Create a TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). diff --git a/tidb-cloud/tidb-cloud-release-notes.md b/tidb-cloud/tidb-cloud-release-notes.md index 742ee60610a51..1dd087df4e4d7 100644 --- a/tidb-cloud/tidb-cloud-release-notes.md +++ b/tidb-cloud/tidb-cloud-release-notes.md @@ -164,7 +164,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - Support backup and restore for TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. - For more information, see [Back up and Restore TiDB Cluster Data](/tidb-cloud/backup-and-restore.md#tidb-serverless). + For more information, see [Back up and Restore TiDB Cluster Data](/tidb-cloud/backup-and-restore-serverless.md). - Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters from [v6.5.1](https://docs.pingcap.com/tidb/v6.5/release-6.5.1) to [v6.5.2](https://docs.pingcap.com/tidb/v6.5/release-6.5.2). diff --git a/tidb-cloud/use-chat2query-api.md b/tidb-cloud/use-chat2query-api.md index 85bc984d8fb27..c7e3897a97c2d 100644 --- a/tidb-cloud/use-chat2query-api.md +++ b/tidb-cloud/use-chat2query-api.md @@ -15,7 +15,7 @@ Chat2Query API can only be accessed through HTTPS, ensuring that all data transm ## Before you begin -Before using the Chat2Query API, make sure that you have created a [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster and enabled [AI to generate SQL queries](/tidb-cloud/explore-data-with-chat2query.md). If you do not have a TiDB Serverless cluster, follow the steps in [Create a cluster](/tidb-cloud/create-tidb-cluster.md) to create one. +Before using the Chat2Query API, make sure that you have created a [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster and enabled [AI to generate SQL queries](/tidb-cloud/explore-data-with-chat2query.md). If you do not have a TiDB Serverless cluster, follow the steps in [Create a TiDB Serverless cluster](/tidb-cloud/create-tidb-cluster-serverless.md) to create one. ## Step 1. Enable the Chat2Query API diff --git a/tidb-cloud/v7.1.0-performance-benchmarking-with-sysbench.md b/tidb-cloud/v7.1.0-performance-benchmarking-with-sysbench.md index 54c28272e4da1..bbdc0d38335cc 100644 --- a/tidb-cloud/v7.1.0-performance-benchmarking-with-sysbench.md +++ b/tidb-cloud/v7.1.0-performance-benchmarking-with-sysbench.md @@ -61,11 +61,11 @@ This section introduces how to perform the Sysbench performance test step by ste 1. In the [TiDB Cloud console](https://tidbcloud.com/), create a TiDB Dedicated cluster that meets the [test environment](#tidb-cluster) requirements. - For more information, see [Create a TiDB cluster](/tidb-cloud/create-tidb-cluster.md). + For more information, see [Create a TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). 2. On the benchmark executor, connect to the newly created cluster and create a database named `sbtest`. - To connect to the cluster, see [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md). + To connect to the cluster, see [Connect to TiDB Dedicated via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md). To create the `sbtest` database, execute the following SQL statement: diff --git a/tidb-cloud/v7.1.0-performance-benchmarking-with-tpcc.md b/tidb-cloud/v7.1.0-performance-benchmarking-with-tpcc.md index 041c7bdc676ac..1d3fc2b4bcb94 100644 --- a/tidb-cloud/v7.1.0-performance-benchmarking-with-tpcc.md +++ b/tidb-cloud/v7.1.0-performance-benchmarking-with-tpcc.md @@ -40,11 +40,11 @@ This section introduces how to perform the TPC-C performance test step by step. 1. In the [TiDB Cloud console](https://tidbcloud.com/), create a TiDB Dedicated cluster that meets the [test environment](#tidb-cluster) requirements. - For more information, see [Create a TiDB cluster](/tidb-cloud/create-tidb-cluster.md). + For more information, see [Create a TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). 2. On the benchmark executor, connect to the newly created cluster and create a database named `tpcc`. - To connect to the cluster, see [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md). + To connect to the cluster, see [Connect to TiDB Dedicated via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections.md). To create the `tpcc` database, execute the following SQL statement: