diff --git a/TOC.md b/TOC.md index 7f26d8eefeae1..bed7f30e69c63 100644 --- a/TOC.md +++ b/TOC.md @@ -19,7 +19,7 @@ - Develop - [Overview](/develop/dev-guide-overview.md) - Quick Start - - [Build a TiDB Cluster in TiDB Cloud (Serverless Tier)](/develop/dev-guide-build-cluster-in-cloud.md) + - [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md) - [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md) - Example Applications - Java diff --git a/_docHome.md b/_docHome.md index 3d9a36079c623..665d6764677c5 100644 --- a/_docHome.md +++ b/_docHome.md @@ -49,7 +49,7 @@ Get the power of a cloud-native, distributed SQL database built for real-time an --> -TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability. You can deploy TiDB on premises or in the cloud. +TiDB is an open-source distributed SQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability. You can deploy TiDB in a self-hosted environment or in the cloud. diff --git a/br/backup-and-restore-overview.md b/br/backup-and-restore-overview.md index 1464612144567..2fc8e8cc097b1 100644 --- a/br/backup-and-restore-overview.md +++ b/br/backup-and-restore-overview.md @@ -45,7 +45,7 @@ Backup storage and network configuration: ## Use backup and restore -The way to use BR varies with the deployment method of TiDB. This document introduces how to use the br command-line tool to back up and restore TiDB cluster data in an on-premise deployment. +The way to use BR varies with the deployment method of TiDB. This document introduces how to use the br command-line tool to back up and restore TiDB cluster data in a self-hosted deployment. For information about how to use this feature in other deployment scenarios, see the following documents: diff --git a/br/br-pitr-guide.md b/br/br-pitr-guide.md index 325d1c0d983c7..8a9284718d421 100644 --- a/br/br-pitr-guide.md +++ b/br/br-pitr-guide.md @@ -130,7 +130,7 @@ Testing scenario 1 (on [TiDB Cloud](https://tidbcloud.com)): - New log data created in the cluster: 10 GB/h - Write (INSERT/UPDATE/DELETE) QPS: 10,000 -Testing scenario 2 (on-premises): +Testing scenario 2 (on TiDB Self-Hosted): - The number of TiKV nodes (8 core, 64 GB memory): 6 - TiKV configuration item `import.num-threads`: 8 diff --git a/clinic/clinic-introduction.md b/clinic/clinic-introduction.md index d355a71dde8eb..b3b977ac829d0 100644 --- a/clinic/clinic-introduction.md +++ b/clinic/clinic-introduction.md @@ -74,7 +74,7 @@ First, Diag gets cluster topology information from the deployment tool TiUP (tiu ## Next step -- Use PingCAP Clinic in an on-premise environment +- Use PingCAP Clinic in a self-hosted environment - [Quick Start with PingCAP Clinic](/clinic/quick-start-with-clinic.md) - [Troubleshoot Clusters using PingCAP Clinic](/clinic/clinic-user-guide-for-tiup.md) - [PingCAP Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md) diff --git a/clinic/clinic-user-guide-for-tiup.md b/clinic/clinic-user-guide-for-tiup.md index 7652a5ffffea5..7ac8b6f56205e 100644 --- a/clinic/clinic-user-guide-for-tiup.md +++ b/clinic/clinic-user-guide-for-tiup.md @@ -9,7 +9,7 @@ For TiDB clusters and DM clusters deployed using TiUP, you can use PingCAP Clini > **Note:** > -> - This document **only** applies to clusters deployed using TiUP in an on-premises environment. For clusters deployed using TiDB Operator on Kubernetes, see [PingCAP Clinic for TiDB Operator environments](https://docs.pingcap.com/tidb-in-kubernetes/stable/clinic-user-guide). +> - This document **only** applies to clusters deployed using TiUP in a self-hosted environment. For clusters deployed using TiDB Operator on Kubernetes, see [PingCAP Clinic for TiDB Operator environments](https://docs.pingcap.com/tidb-in-kubernetes/stable/clinic-user-guide). > > - PingCAP Clinic **does not support** collecting data from clusters deployed using TiDB Ansible. diff --git a/develop/dev-guide-aws-appflow-integration.md b/develop/dev-guide-aws-appflow-integration.md index 608a3c30781ba..1b2ff2a604b4c 100644 --- a/develop/dev-guide-aws-appflow-integration.md +++ b/develop/dev-guide-aws-appflow-integration.md @@ -7,9 +7,9 @@ summary: Introduce how to integrate TiDB with Amazon AppFlow step by step. [Amazon AppFlow](https://aws.amazon.com/appflow/) is a fully managed API integration service that you use to connect your software as a service (SaaS) applications to AWS services, and securely transfer data. With Amazon AppFlow, you can import and export data from and to TiDB into many types of data providers, such as Salesforce, Amazon S3, LinkedIn, and GitHub. For more information, see [Supported source and destination applications](https://docs.aws.amazon.com/appflow/latest/userguide/app-specific.html) in AWS documentation. -This document describes how to integrate TiDB with Amazon AppFlow and takes integrating a TiDB Cloud Serverless Tier cluster as an example. +This document describes how to integrate TiDB with Amazon AppFlow and takes integrating a TiDB Serverless cluster as an example. -If you do not have a TiDB cluster, you can create a [Serverless Tier](https://tidbcloud.com/console/clusters) cluster, which is free and can be created in approximately 30 seconds. +If you do not have a TiDB cluster, you can create a [TiDB Serverless](https://tidbcloud.com/console/clusters) cluster, which is free and can be created in approximately 30 seconds. ## Prerequisites @@ -66,7 +66,7 @@ git clone https://github.com/pingcap-inc/tidb-appflow-integration > > - The `--guided` option uses prompts to guide you through the deployment. Your input will be stored in a configuration file, which is `samconfig.toml` by default. > - `stack_name` specifies the name of AWS Lambda that you are deploying. - > - This prompted guide uses AWS as the cloud provider of TiDB Cloud Serverless Tier. To use Amazon S3 as the source or destination, you need to set the `region` of AWS Lambda as the same as that of Amazon S3. + > - This prompted guide uses AWS as the cloud provider of TiDB Serverless. To use Amazon S3 as the source or destination, you need to set the `region` of AWS Lambda as the same as that of Amazon S3. > - If you have already run `sam deploy --guided` before, you can just run `sam deploy` instead, and SAM CLI will use the configuration file `samconfig.toml` to simplify the interaction. If you see a similar output as follows, this Lambda is successfully deployed. @@ -148,7 +148,7 @@ Choose the **Source details** and **Destination details**. TiDB connector can be ``` 5. After the `sf_account` table is created, click **Connect**. A connection dialog is displayed. -6. In the **Connect to TiDB-Connector** dialog, enter the connection properties of the TiDB cluster. If you use a TiDB Cloud Serverless Tier cluster, you need to set the **TLS** option to `Yes`, which lets the TiDB connector use the TLS connection. Then, click **Connect**. +6. In the **Connect to TiDB-Connector** dialog, enter the connection properties of the TiDB cluster. If you use a TiDB Serverless cluster, you need to set the **TLS** option to `Yes`, which lets the TiDB connector use the TLS connection. Then, click **Connect**. ![tidb connection message](/media/develop/aws-appflow-step-tidb-connection-message.png) @@ -244,5 +244,5 @@ test> SELECT * FROM sf_account; - If anything goes wrong, you can navigate to the [CloudWatch](https://console.aws.amazon.com/cloudwatch/home) page on the AWS Management Console to get logs. - The steps in this document are based on [Building custom connectors using the Amazon AppFlow Custom Connector SDK](https://aws.amazon.com/blogs/compute/building-custom-connectors-using-the-amazon-appflow-custom-connector-sdk/). -- [TiDB Cloud Serverless Tier](https://docs.pingcap.com/tidbcloud/select-cluster-tier#serverless-tier-beta) is **NOT** a production environment. +- [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless-beta) is **NOT** a production environment. - To prevent excessive length, the examples in this document only show the `Insert` strategy, but `Update` and `Upsert` strategies are also tested and can be used. \ No newline at end of file diff --git a/develop/dev-guide-build-cluster-in-cloud.md b/develop/dev-guide-build-cluster-in-cloud.md index 683f66000894a..bcbe7a0ff177d 100644 --- a/develop/dev-guide-build-cluster-in-cloud.md +++ b/develop/dev-guide-build-cluster-in-cloud.md @@ -1,15 +1,15 @@ --- -title: Build a TiDB Cluster in TiDB Cloud (Serverless Tier) -summary: Learn how to build a TiDB cluster in TiDB Cloud (Serverless Tier) and connect to a TiDB Cloud cluster. +title: Build a TiDB Serverless Cluster +summary: Learn how to build a TiDB Serverless cluster in TiDB Cloud and connect to it. --- -# Build a TiDB Cluster in TiDB Cloud (Serverless Tier) +# Build a TiDB Serverless Cluster -This document walks you through the quickest way to get started with TiDB. You will use [TiDB Cloud](https://en.pingcap.com/tidb-cloud) to create a Serverless Tier cluster, connect to it, and run a sample application on it. +This document walks you through the quickest way to get started with TiDB. You will use [TiDB Cloud](https://en.pingcap.com/tidb-cloud) to create a TiDB Serverless cluster, connect to it, and run a sample application on it. If you need to run TiDB on your local machine, see [Starting TiDB Locally](/quick-start-with-tidb.md). @@ -21,7 +21,7 @@ This document walks you through the quickest way to get started with TiDB Cloud. -## Step 1. Create a Serverless Tier cluster +## Step 1. Create a TiDB Serverless cluster 1. If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up for an account. @@ -29,12 +29,12 @@ This document walks you through the quickest way to get started with TiDB Cloud. The [**Clusters**](https://tidbcloud.com/console/clusters) list page is displayed by default. -3. For new sign-up users, TiDB Cloud creates a default Serverless Tier cluster `Cluster0` for you automatically. You can either use this default cluster for the subsequent steps or create a new Serverless Tier cluster on your own. +3. For new sign-up users, TiDB Cloud creates a default TiDB Serverless cluster `Cluster0` for you automatically. You can either use this default cluster for the subsequent steps or create a new TiDB Serverless cluster on your own. - To create a new Serverless Tier cluster on your own, take the following operations: + To create a new TiDB Serverless cluster on your own, take the following operations: 1. Click **Create Cluster**. - 2. On the **Create Cluster** page, **Serverless** is selected by default. Select a target region of your cluster, update the default cluster name if necessary, and then click **Create**. Your Serverless Tier cluster will be created in approximately 30 seconds. + 2. On the **Create Cluster** page, **Serverless** is selected by default. Select a target region of your cluster, update the default cluster name if necessary, and then click **Create**. Your TiDB Serverless cluster will be created in approximately 30 seconds. 4. On the cluster overview page, click **Connect** in the upper-right corner. A connection dialog box is displayed. @@ -46,7 +46,7 @@ This document walks you through the quickest way to get started with TiDB Cloud. > **Note:** > -> For [Serverless Tier clusters](https://docs.pingcap.com/tidbcloud/select-cluster-tier#serverless-tier), when you connect to your 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](https://docs.pingcap.com/tidbcloud/select-cluster-tier#user-name-prefix). +> For [TiDB Serverless clusters](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless-beta), when you connect to your 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](https://docs.pingcap.com/tidbcloud/select-cluster-tier#user-name-prefix). @@ -54,7 +54,7 @@ This document walks you through the quickest way to get started with TiDB Cloud. > **Note:** > -> For [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta), when you connect to your 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). +> For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), when you connect to your 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). @@ -131,7 +131,7 @@ mysql Ver 15.1 Distrib 5.5.68-MariaDB, for Linux (x86_64) using readline 5.1 -2. Run the connection string obtained in [Step 1](#step-1-create-a-serverless-tier-cluster). +2. Run the connection string obtained in [Step 1](#step-1-create-a-tidb-serverless-cluster). {{< copyable "shell-regular" >}} @@ -143,8 +143,8 @@ mysql Ver 15.1 Distrib 5.5.68-MariaDB, for Linux (x86_64) using readline 5.1 > **Note:** > -> - When you connect to a Serverless Tier cluster, you must [use the TLS connection](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters). -> - If you encounter problems when connecting to a Serverless Tier cluster, you can read [Secure Connections to Serverless Tier Clusters](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters) for more information. +> - When you connect to a TiDB Serverless cluster, you must [use the TLS connection](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters). +> - If you encounter problems when connecting to a TiDB Serverless cluster, you can read [Secure Connections to TiDB Serverless Clusters](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters) for more information. @@ -152,8 +152,8 @@ mysql Ver 15.1 Distrib 5.5.68-MariaDB, for Linux (x86_64) using readline 5.1 > **Note:** > -> - When you connect to a Serverless Tier cluster, you must [use the TLS connection](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md). -> - If you encounter problems when connecting to a Serverless Tier cluster, you can read [Secure Connections to Serverless Tier Clusters](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md) for more information. +> - When you connect to a TiDB Serverless cluster, you must [use the TLS connection](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md). +> - If you encounter problems when connecting to a TiDB Serverless cluster, you can read [Secure Connections to TiDB Serverless Clusters](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md) for more information. diff --git a/develop/dev-guide-create-database.md b/develop/dev-guide-create-database.md index d79fbbb44462f..c9ef93d081af3 100644 --- a/develop/dev-guide-create-database.md +++ b/develop/dev-guide-create-database.md @@ -11,7 +11,7 @@ This document describes how to create a database using SQL and various programmi Before creating a database, do the following: -- [Build a TiDB Cluster in TiDB Cloud (Serverless Tier)](/develop/dev-guide-build-cluster-in-cloud.md). +- [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md). ## What is database diff --git a/develop/dev-guide-create-secondary-indexes.md b/develop/dev-guide-create-secondary-indexes.md index 486cc168af422..0e57fd3c6f4a9 100644 --- a/develop/dev-guide-create-secondary-indexes.md +++ b/develop/dev-guide-create-secondary-indexes.md @@ -11,7 +11,7 @@ This document describes how to create a secondary index using SQL and various pr Before creating a secondary index, do the following: -- [Build a TiDB Cluster in TiDB Cloud (Serverless Tier)](/develop/dev-guide-build-cluster-in-cloud.md). +- [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md). - [Create a Database](/develop/dev-guide-create-database.md). - [Create a Table](/develop/dev-guide-create-table.md). diff --git a/develop/dev-guide-create-table.md b/develop/dev-guide-create-table.md index 4fc1bc58ba275..1ad1b6dbf7ff4 100644 --- a/develop/dev-guide-create-table.md +++ b/develop/dev-guide-create-table.md @@ -11,7 +11,7 @@ This document introduces how to create tables using the SQL statement and the re Before reading this document, make sure that the following tasks are completed: -- [Build a TiDB Cluster in TiDB Cloud (Serverless Tier)](/develop/dev-guide-build-cluster-in-cloud.md). +- [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md). - [Create a Database](/develop/dev-guide-create-database.md). @@ -290,7 +290,7 @@ ALTER TABLE `bookshop`.`ratings` SET TIFLASH REPLICA 1; > **Note:** > -> If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Build a TiDB Cluster in TiDB Cloud (Serverless Tier)](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster) to create a Serverless Tier cluster that includes **TiFlash**. +> If your cluster does not contain **TiFlash** nodes, this SQL statement will report an error: `1105 - the tiflash replica count: 1 should be less than the total tiflash server count: 0`. You can use [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster) to create a TiDB Serverless cluster that includes **TiFlash**. Then you can go on to perform the following query: diff --git a/develop/dev-guide-delete-data.md b/develop/dev-guide-delete-data.md index 5dfb874bc7566..96278a73313a5 100644 --- a/develop/dev-guide-delete-data.md +++ b/develop/dev-guide-delete-data.md @@ -11,7 +11,7 @@ This document describes how to use the [DELETE](/sql-statements/sql-statement-de Before reading this document, you need to prepare the following: -- [Build a TiDB Cluster in TiDB Cloud (Serverless Tier)](/develop/dev-guide-build-cluster-in-cloud.md) +- [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md) - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md), [Create a Database](/develop/dev-guide-create-database.md), [Create a Table](/develop/dev-guide-create-table.md), and [Create Secondary Indexes](/develop/dev-guide-create-secondary-indexes.md) - [Insert Data](/develop/dev-guide-insert-data.md) diff --git a/develop/dev-guide-insert-data.md b/develop/dev-guide-insert-data.md index c75bdc44ce133..cab09a938df78 100644 --- a/develop/dev-guide-insert-data.md +++ b/develop/dev-guide-insert-data.md @@ -13,7 +13,7 @@ This document describes how to insert data into TiDB by using the SQL language w Before reading this document, you need to prepare the following: -- [Build a TiDB Cluster in TiDB Cloud (Serverless Tier)](/develop/dev-guide-build-cluster-in-cloud.md). +- [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md), [Create a Database](/develop/dev-guide-create-database.md), [Create a Table](/develop/dev-guide-create-table.md), and [Create Secondary Indexes](/develop/dev-guide-create-secondary-indexes.md) ## Insert rows diff --git a/develop/dev-guide-outdated-for-django.md b/develop/dev-guide-outdated-for-django.md index 7a0f8240cb80e..632acb1ce1759 100644 --- a/develop/dev-guide-outdated-for-django.md +++ b/develop/dev-guide-outdated-for-django.md @@ -25,7 +25,7 @@ The above command starts a temporary and single-node cluster with mock TiKV. The > > To deploy a "real" TiDB cluster for production, see the following guides: > -> + [Deploy TiDB using TiUP for On-Premises](https://docs.pingcap.com/tidb/v5.1/production-deployment-using-tiup) +> + [Deploy TiDB using TiUP for Self-Hosted Environment](https://docs.pingcap.com/tidb/v5.1/production-deployment-using-tiup) > + [Deploy TiDB on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable) > > You can also [use TiDB Cloud](https://pingcap.com/products/tidbcloud/), a fully-managed Database-as-a-Service (DBaaS) of TiDB. diff --git a/develop/dev-guide-proxysql-integration.md b/develop/dev-guide-proxysql-integration.md index b89fd24ce7d84..e0465d329a0b4 100644 --- a/develop/dev-guide-proxysql-integration.md +++ b/develop/dev-guide-proxysql-integration.md @@ -119,11 +119,11 @@ systemctl start docker ### Option 1: Integrate TiDB Cloud with ProxySQL -For this integration, you will be using the [ProxySQL Docker image](https://hub.docker.com/r/proxysql/proxysql) along with a TiDB Serverless Tier cluster. The following steps will set up ProxySQL on port `16033`, so make sure this port is available. +For this integration, you will be using the [ProxySQL Docker image](https://hub.docker.com/r/proxysql/proxysql) along with a TiDB Serverless cluster. The following steps will set up ProxySQL on port `16033`, so make sure this port is available. -#### Step 1. Create a TiDB Cloud Serverless Tier cluster +#### Step 1. Create a TiDB Serverless cluster -1. [Create a free TiDB Serverless Tier cluster](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart#step-1-create-a-tidb-cluster). Remember the root password that you set for your cluster. +1. [Create a free TiDB Serverless cluster](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart#step-1-create-a-tidb-cluster). Remember the root password that you set for your cluster. 2. Get your cluster hostname, port, and username for later use. 1. On the [Clusters](https://tidbcloud.com/console/clusters) page, click your cluster name to go to the cluster overview page. @@ -327,12 +327,12 @@ For this integration, you will be using the [ProxySQL Docker image](https://hub. > > 1. Adds a user using the username and password of your cluster. > 2. Assigns the user to the monitoring account. - > 3. Adds your TiDB Serverless Tier cluster to the list of hosts. - > 4. Enables a secure connection between ProxySQL and the TiDB Serverless Tier cluster. + > 3. Adds your TiDB Serverless cluster to the list of hosts. + > 4. Enables a secure connection between ProxySQL and the TiDB Serverless cluster. > > To have a better understanding, it is strongly recommended that you check the `proxysql-prepare.sql` file. To learn more about ProxySQL configuration, see [ProxySQL documentation](https://proxysql.com/documentation/proxysql-configuration/). - The following is an example output. You will see that the hostname of your cluster is shown in the output, which means that the connectivity between ProxySQL and the TiDB Serverless Tier cluster is established. + The following is an example output. You will see that the hostname of your cluster is shown in the output, which means that the connectivity between ProxySQL and the TiDB Serverless cluster is established. ``` *************************** 1. row *************************** @@ -388,7 +388,7 @@ For this integration, you will be using the [ProxySQL Docker image](https://hub. SELECT VERSION(); ``` - If the TiDB version is displayed, you are successfully connected to your TiDB Serverless Tier cluster through ProxySQL. To exit from the MySQL client anytime, enter `quit` and press enter. + If the TiDB version is displayed, you are successfully connected to your TiDB Serverless cluster through ProxySQL. To exit from the MySQL client anytime, enter `quit` and press enter. > **Note:** > @@ -636,7 +636,7 @@ ProxySQL can be installed on many different platforms. The following takes CentO For a full list of supported platforms and the corresponding version requirements, see [ProxySQL documentation](https://proxysql.com/documentation/installing-proxysql/). -#### Step 1. Create a TiDB Cloud Dedicated Tier cluster +#### Step 1. Create a TiDB Dedicated cluster For detailed steps, see [Create a TiDB Cluster](https://docs.pingcap.com/tidbcloud/create-tidb-cluster). @@ -687,7 +687,7 @@ To use ProxySQL as a proxy for TiDB, you need to configure ProxySQL. To do so, y The above step will take you to the ProxySQL admin prompt. -2. Configure the TiDB clusters to be used, where you can add one or multiple TiDB clusters to ProxySQL. The following statement will add one TiDB Cloud Dedicated Tier cluster for example. You need to replace `` and `` with your TiDB Cloud endpoint and port (the default port is `4000`). +2. Configure the TiDB clusters to be used, where you can add one or multiple TiDB clusters to ProxySQL. The following statement will add one TiDB Dedicated cluster for example. You need to replace `` and `` with your TiDB Cloud endpoint and port (the default port is `4000`). ```sql INSERT INTO mysql_servers(hostgroup_id, hostname, port) diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index ae8157657e73e..95bb8e9d0dfda 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -22,9 +22,9 @@ This document describes how to use TiDB and GORM to build a simple CRUD applicat The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -34,7 +34,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -280,7 +280,7 @@ The following content introduces how to run the code step by step. ### Step 3.1 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, modify the value of the `dsn` in `gorm.go`: +If you are using a TiDB Serverless cluster, modify the value of the `dsn` in `gorm.go`: ```go dsn := "root:@tcp(127.0.0.1:4000)/test?charset=utf8mb4" diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index 6420b2c7e1a18..795cb4148bb80 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -21,9 +21,9 @@ This document describes how to use TiDB and [Go-MySQL-Driver](https://github.com The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -33,7 +33,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -509,7 +509,7 @@ When using go-sql-driver/mysql, you need to connect to your cluster and run the ### Step 3.2 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, modify the value of the `dsn` in `sqldriver.go`: +If you are using a TiDB Serverless cluster, modify the value of the `dsn` in `sqldriver.go`: ```go dsn := "root:@tcp(127.0.0.1:4000)/test?charset=utf8mb4" diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index 1f0432264d850..ef346f9c3150d 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -20,9 +20,9 @@ This document describes how to use TiDB and Hibernate to build a simple CRUD app The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -32,7 +32,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -341,7 +341,7 @@ No need to initialize tables manually. ### Step 3.2 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, modify the `hibernate.connection.url`, `hibernate.connection.username`, `hibernate.connection.password` in `hibernate.cfg.xml`. +If you are using a TiDB Serverless cluster, modify the `hibernate.connection.url`, `hibernate.connection.username`, `hibernate.connection.password` in `hibernate.cfg.xml`. ```xml diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index 34d75cb95925a..02ba214c71e0c 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -20,9 +20,9 @@ This document describes how to use TiDB and JDBC to build a simple CRUD applicat The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -32,7 +32,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -540,7 +540,7 @@ When using JDBC, you need to connect to your cluster and run the statement in th ### Step 3.2 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, modify the parameters of the host, port, user, and password in `JDBCExample.java`: +If you are using a TiDB Serverless cluster, modify the parameters of the host, port, user, and password in `JDBCExample.java`: ```java mysqlDataSource.setServerName("localhost"); diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index ac746e4495c52..36290ccb29789 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -20,9 +20,9 @@ This document describes how to use TiDB and Mybatis to build a simple CRUD appli The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -32,7 +32,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -629,7 +629,7 @@ If you are using a non-local cluster or MySQL client has not been installed, con ### Step 3.2 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, modify the `dataSource.url`, `dataSource.username`, `dataSource.password` in `mybatis-config.xml`. +If you are using a TiDB Serverless cluster, modify the `dataSource.url`, `dataSource.username`, `dataSource.password` in `mybatis-config.xml`. ```xml diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index df23c8d2c0d25..5c472fa715303 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -22,9 +22,9 @@ You can build your own application based on this example. The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -34,7 +34,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -98,7 +98,7 @@ If you want to learn more about the code of this application, refer to [Implemen ### Step 5.1 Change parameters -If you are using a TiDB Cloud Serverless Tier cluster, change the `spring.datasource.url`, `spring.datasource.username`, `spring.datasource.password` parameters in the `application.yml` (located in `src/main/resources`). +If you are using a TiDB Serverless cluster, change the `spring.datasource.url`, `spring.datasource.username`, `spring.datasource.password` parameters in the `application.yml` (located in `src/main/resources`). ```yaml spring: diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index 6d7a2c30a070a..4f23ea511d32a 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -23,9 +23,9 @@ This document describes how to use TiDB and MySQL Connector/Python to build a si The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -35,7 +35,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -233,9 +233,9 @@ If you are not using a local cluster, or have not installed a MySQL client, conn ### Step 3.2 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system).> +If you are using a TiDB Serverless cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system).> -If you are using a TiDB Cloud Serverless Tier cluster, change the `get_connection` function in `mysql_connector_python_example.py`: +If you are using a TiDB Serverless cluster, change the `get_connection` function in `mysql_connector_python_example.py`: ```python def get_connection(autocommit: bool = True) -> MySQLConnection: diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index 2feaf5b4142f7..2e993a66b891e 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -22,9 +22,9 @@ This document describes how to use TiDB and mysqlclient to build a simple CRUD a The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -34,7 +34,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -233,9 +233,9 @@ If you are not using a local cluster, or have not installed a MySQL client, conn ### Step 3.2 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system). +If you are using a TiDB Serverless cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system). -If you are using a TiDB Cloud Serverless Tier cluster, change the `get_connection` function in `mysqlclient_example.py`: +If you are using a TiDB Serverless cluster, change the `get_connection` function in `mysqlclient_example.py`: ```python def get_connection(autocommit: bool = True) -> MySQLdb.Connection: diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index 9c2d78d117f78..96f116188d14f 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -22,9 +22,9 @@ This document describes how to use TiDB and peewee to build a simple CRUD applic The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -34,7 +34,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -204,9 +204,9 @@ If you are not using a local cluster, or have not installed a MySQL client, conn ### Step 3.2 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system). +If you are using a TiDB Serverless cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system). -If you are using a TiDB Cloud Serverless Tier cluster, modify the parameters of the `connect` function in `peewee_example.py`: +If you are using a TiDB Serverless cluster, modify the parameters of the `connect` function in `peewee_example.py`: ```python db = connect('mysql://root:@127.0.0.1:4000/test') diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index 1bc9e39c3b81c..bac670caf7fe4 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -22,9 +22,9 @@ This document describes how to use TiDB and PyMySQL to build a simple CRUD appli The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -34,7 +34,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -231,9 +231,9 @@ If you are not using a local cluster, or have not installed a MySQL client, conn ### Step 3.2 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system). +If you are using a TiDB Serverless cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system). -If you are using a TiDB Cloud Serverless Tier cluster, change the `get_connection` function in `pymysql_example.py`: +If you are using a TiDB Serverless cluster, change the `get_connection` function in `pymysql_example.py`: ```python def get_connection(autocommit: bool = False) -> Connection: diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index 39a3f04990f4f..668f3071a17c7 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -23,9 +23,9 @@ This document describes how to use TiDB and SQLAlchemy to build a simple CRUD ap The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). **Use a local cluster** @@ -35,7 +35,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -205,9 +205,9 @@ If you are not using a local cluster, or have not installed a MySQL client, conn ### Step 3.2 Modify parameters for TiDB Cloud -If you are using a TiDB Cloud Serverless Tier cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system). +If you are using a TiDB Serverless cluster, you need to provide your CA root path and replace `` in the following examples with your CA path. To get the CA root path on your system, refer to [Where is the CA root path on my system?](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-tier-clusters#where-is-the-ca-root-path-on-my-system). -If you are using a TiDB Cloud Serverless Tier cluster, modify the parameters of the `create_engine` function in `sqlalchemy_example.py`: +If you are using a TiDB Serverless cluster, modify the parameters of the `create_engine` function in `sqlalchemy_example.py`: ```python engine = create_engine('mysql://root:@127.0.0.1:4000/test') diff --git a/develop/dev-guide-tidb-crud-sql.md b/develop/dev-guide-tidb-crud-sql.md index cdf1495f10d06..9e0ca6c900e99 100644 --- a/develop/dev-guide-tidb-crud-sql.md +++ b/develop/dev-guide-tidb-crud-sql.md @@ -9,7 +9,7 @@ This document briefly introduces how to use TiDB's CURD SQL. ## Before you start -Please make sure you are connected to a TiDB cluster. If not, refer to [Build a TiDB Cluster in TiDB Cloud (Serverless Tier)](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster) to create a Serverless Tier cluster. +Please make sure you are connected to a TiDB cluster. If not, refer to [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster) to create a TiDB Serverless cluster. ## Explore SQL with TiDB diff --git a/develop/dev-guide-update-data.md b/develop/dev-guide-update-data.md index b0a96d7f84c5d..2dcb69a80ccbb 100644 --- a/develop/dev-guide-update-data.md +++ b/develop/dev-guide-update-data.md @@ -14,7 +14,7 @@ This document describes how to use the following SQL statements to update the da Before reading this document, you need to prepare the following: -- [Build a TiDB Cluster in TiDB Cloud (Serverless Tier)](/develop/dev-guide-build-cluster-in-cloud.md). +- [Build a TiDB Serverless Cluster](/develop/dev-guide-build-cluster-in-cloud.md). - Read [Schema Design Overview](/develop/dev-guide-schema-design-overview.md), [Create a Database](/develop/dev-guide-create-database.md), [Create a Table](/develop/dev-guide-create-table.md), and [Create Secondary Indexes](/develop/dev-guide-create-secondary-indexes.md). - If you want to `UPDATE` data, you need to [insert data](/develop/dev-guide-insert-data.md) first. diff --git a/encryption-at-rest.md b/encryption-at-rest.md index 38b96b9276529..4438b8afeebc7 100644 --- a/encryption-at-rest.md +++ b/encryption-at-rest.md @@ -21,7 +21,7 @@ When a TiDB cluster is deployed, the majority of user data is stored on TiKV and TiKV supports encryption at rest. This feature allows TiKV to transparently encrypt data files using [AES](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) or [SM4](https://en.wikipedia.org/wiki/SM4_(cipher)) in [CTR](https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation) mode. To enable encryption at rest, an encryption key must be provided by the user and this key is called master key. TiKV automatically rotates data keys that it used to encrypt actual data files. Manually rotating the master key can be done occasionally. Note that encryption at rest only encrypts data at rest (namely, on disk) and not while data is transferred over network. It is advised to use TLS together with encryption at rest. -Optionally, you can use AWS KMS for both cloud and on-premises deployments. You can also supply the plaintext master key in a file. +Optionally, you can use AWS KMS for both cloud and self-hosted deployments. You can also supply the plaintext master key in a file. TiKV currently does not exclude encryption keys and user data from core dumps. It is advised to disable core dumps for the TiKV process when using encryption at rest. This is not currently handled by TiKV itself. diff --git a/explore-htap.md b/explore-htap.md index 5d32d5cb3d9a2..ec62e5e4be6f4 100644 --- a/explore-htap.md +++ b/explore-htap.md @@ -13,7 +13,7 @@ This guide describes how to explore and use the features of TiDB Hybrid Transact ## Use cases -TiDB HTAP can handle the massive data that increases rapidly, reduce the cost of DevOps, and be deployed in either on-premises or cloud environments easily, which brings the value of data assets in real time. +TiDB HTAP can handle the massive data that increases rapidly, reduce the cost of DevOps, and be deployed in either self-hosted or cloud environments easily, which brings the value of data assets in real time. The following are the typical use cases of HTAP: diff --git a/garbage-collection-configuration.md b/garbage-collection-configuration.md index f2857d6898d57..89e8beaacfcaf 100644 --- a/garbage-collection-configuration.md +++ b/garbage-collection-configuration.md @@ -20,7 +20,7 @@ Garbage collection is configured via the following system variables: > **Note:** > -> This section is only applicable to on-premises TiDB. TiDB Cloud does not have a GC I/O limit by default. +> This section is only applicable to TiDB Self-Hosted. TiDB Cloud does not have a GC I/O limit by default. @@ -58,7 +58,7 @@ Based on the `DISTRIBUTED` GC mode, the mechanism of GC in Compaction Filter use > **Note:** > -> The following examples of modifying TiKV configurations are only applicable to on-premises TiDB. For TiDB Cloud, the mechanism of GC in Compaction Filter is enabled by default. +> The following examples of modifying TiKV configurations are only applicable to TiDB Self-Hosted. For TiDB Cloud, the mechanism of GC in Compaction Filter is enabled by default. diff --git a/information-schema/information-schema-slow-query.md b/information-schema/information-schema-slow-query.md index 398039c9079b6..d47b6e5f1ff41 100644 --- a/information-schema/information-schema-slow-query.md +++ b/information-schema/information-schema-slow-query.md @@ -11,8 +11,8 @@ The `SLOW_QUERY` table provides the slow query information of the current node, > **Note:** > -> The `SLOW_QUERY` table is unavailable for [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). - +> The `SLOW_QUERY` table is unavailable for [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). + diff --git a/information-schema/information-schema-user-privileges.md b/information-schema/information-schema-user-privileges.md index 6fcca468aedda..06c8e1507a9d6 100644 --- a/information-schema/information-schema-user-privileges.md +++ b/information-schema/information-schema-user-privileges.md @@ -79,7 +79,7 @@ The output is as follows: - + ```sql +------------+---------------+-------------------------+--------------+ diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index 2c6729a298698..bbcd288ccc658 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -14,7 +14,7 @@ This guide walks you through the quickest way to get started with TiDB. For non- > > The deployment method provided in this guide is **ONLY FOR** quick start, **NOT FOR** production. > -> - To deploy an on-premises production cluster, see [production installation guide](/production-deployment-using-tiup.md). +> - To deploy a self-hosted production cluster, see [production installation guide](/production-deployment-using-tiup.md). > - To deploy TiDB on Kubernetes, see [Get Started with TiDB on Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/get-started). > - To manage TiDB in the cloud, see [TiDB Cloud Quick Start](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart). diff --git a/releases/release-5.2.0.md b/releases/release-5.2.0.md index 91d1c90240dba..ed6f6e0ebe14f 100644 --- a/releases/release-5.2.0.md +++ b/releases/release-5.2.0.md @@ -20,7 +20,7 @@ In v5.2, the key new features and improvements are as follows: - Add the TiFlash I/O traffic limit feature to improve the stability of read and write for TiFlash - TiKV introduces a new flow control mechanism to replace the previous RocksDB write stall mechanism to improve the stability of TiKV flow control - Simplify the operation and maintenance of Data Migration (DM) to reduce the management cost. -- TiCDC supports HTTP protocol OpenAPI to manage TiCDC tasks. It provides a more user-friendly operation method for both Kubernetes and on-premises environments. (Experimental feature) +- TiCDC supports HTTP protocol OpenAPI to manage TiCDC tasks. It provides a more user-friendly operation method for both Kubernetes and self-hosted environments. (Experimental feature) ## Compatibility changes @@ -165,7 +165,7 @@ In v5.2, the key new features and improvements are as follows: ### TiDB data share subscription -TiCDC supports using the HTTP protocol (OpenAPI) to manage TiCDC tasks, which is a more user-friendly operation method for both Kubernetes and on-premises environments. (Experimental feature) +TiCDC supports using the HTTP protocol (OpenAPI) to manage TiCDC tasks, which is a more user-friendly operation method for both Kubernetes and self-hosted environments. (Experimental feature) [#2411](https://github.com/pingcap/tiflow/issues/2411) @@ -210,7 +210,7 @@ Support running the `tiup playground` command on Mac computers with Apple M1 chi - Support completing the garbage collection automatically for the bindings in the "deleted" status [#26206](https://github.com/pingcap/tidb/pull/26206) - Support showing whether a binding is used for query optimization in the result of `EXPLAIN VERBOSE` [#26930](https://github.com/pingcap/tidb/pull/26930) - Add a new status variation `last_plan_binding_update_time` to view the timestamp corresponding to the binding cache in the current TiDB instance [#26340](https://github.com/pingcap/tidb/pull/26340) - - Support reporting an error when starting binding evolution or running `admin evolve bindings` to ban the baseline evolution (currently disabled in the on-premises TiDB version because it is an experimental feature) affecting other features [#26333](https://github.com/pingcap/tidb/pull/26333) + - Support reporting an error when starting binding evolution or running `admin evolve bindings` to ban the baseline evolution (currently disabled in the TiDB Self-Hosted version because it is an experimental feature) affecting other features [#26333](https://github.com/pingcap/tidb/pull/26333) + PD diff --git a/releases/release-6.0.0-dmr.md b/releases/release-6.0.0-dmr.md index 565324f36029e..9b8c8211fc528 100644 --- a/releases/release-6.0.0-dmr.md +++ b/releases/release-6.0.0-dmr.md @@ -41,7 +41,7 @@ Starting from TiDB v6.0.0, TiDB provides two types of releases: - Development Milestone Releases - Development Milestone Releases (DMR) are released approximately every two months. A DMR introduces new features and improvements, but does not accept patch releases. It is not recommended for on-premises users to use DMR in production environments. For example, v6.0.0-DMR is a DMR. + Development Milestone Releases (DMR) are released approximately every two months. A DMR introduces new features and improvements, but does not accept patch releases. It is not recommended for users to use DMR in production environments. For example, v6.0.0-DMR is a DMR. TiDB v6.0.0 is a DMR, and its version is 6.0.0-DMR. @@ -266,7 +266,7 @@ TiDB v6.0.0 is a DMR, and its version is 6.0.0-DMR. - An enterprise-level database management platform, TiDB Enterprise Manager - TiDB Enterprise Manager (TiEM) is an enterprise-level database management platform based on the TiDB database, which aims to help users manage TiDB clusters in on-premises or public cloud environments. + TiDB Enterprise Manager (TiEM) is an enterprise-level database management platform based on the TiDB database, which aims to help users manage TiDB clusters in self-hosted or public cloud environments. TiEM not only provides full lifecycle visual management for TiDB clusters, but also provides one-stop services: parameter management, version upgrades, cluster clone, active-standby cluster switching, data import and export, data replication, and data backup and restore services. TiEM can improve the efficiency of DevOps on TiDB and reduce the DevOps cost for enterprises. diff --git a/sql-statements/sql-statement-flashback-to-timestamp.md b/sql-statements/sql-statement-flashback-to-timestamp.md index 4d2bbce6573aa..4706a46a9d6a9 100644 --- a/sql-statements/sql-statement-flashback-to-timestamp.md +++ b/sql-statements/sql-statement-flashback-to-timestamp.md @@ -11,7 +11,7 @@ TiDB v6.4.0 introduces the `FLASHBACK CLUSTER TO TIMESTAMP` syntax. You can use > **Warning:** > -> The `FLASHBACK CLUSTER TO TIMESTAMP` syntax is not applicable to TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. Do not execute this statement on Serverless Tier clusters to avoid unexpected results. +> The `FLASHBACK CLUSTER TO TIMESTAMP` syntax is not applicable to [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. Do not execute this statement on TiDB Serverless clusters to avoid unexpected results. diff --git a/statement-summary-tables.md b/statement-summary-tables.md index fcebc3eb73ab7..dec45e63e3fac 100644 --- a/statement-summary-tables.md +++ b/statement-summary-tables.md @@ -19,8 +19,8 @@ Therefore, starting from v4.0.0-rc.1, TiDB provides system tables in `informatio > **Note:** > -> The following tables are unavailable for [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta): `statements_summary`, `statements_summary_history`, `cluster_statements_summary`, and `cluster_statements_summary_history`. - +> The following tables are unavailable for [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta): `statements_summary`, `statements_summary_history`, `cluster_statements_summary`, and `cluster_statements_summary_history`. + This document details these tables and introduces how to use them to troubleshoot SQL performance issues. diff --git a/statistics.md b/statistics.md index 2ae4f3c389127..cbbf4c0641e06 100644 --- a/statistics.md +++ b/statistics.md @@ -11,7 +11,7 @@ TiDB uses statistics to decide [which index to choose](/choose-index.md). The `tidb_analyze_version` variable controls the statistics collected by TiDB. Currently, two versions of statistics are supported: `tidb_analyze_version = 1` and `tidb_analyze_version = 2`. -- For on-premises TiDB, the default value of this variable is `1` before v5.1.0. In v5.3.0 and later versions, the default value of this variable is `2`. If your cluster is upgraded from a version earlier than v5.3.0 to v5.3.0 or later, the default value of `tidb_analyze_version` does not change. +- For TiDB Self-Hosted, the default value of this variable is `1` before v5.1.0. In v5.3.0 and later versions, the default value of this variable is `2`. If your cluster is upgraded from a version earlier than v5.3.0 to v5.3.0 or later, the default value of `tidb_analyze_version` does not change. - For TiDB Cloud, the default value of this variable is `1`. Compared to Version 1, Version 2 statistics avoids the potential inaccuracy caused by hash collision when the data volume is huge. It also maintains the estimate precision in most scenarios. diff --git a/system-variables.md b/system-variables.md index c61d497c320e1..8ec76e810ba5c 100644 --- a/system-variables.md +++ b/system-variables.md @@ -749,7 +749,7 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a - Scope: SESSION | GLOBAL - Persists to cluster: Yes - Type: Integer -- Default value: `2` for on-premises TiDB and `1` for TiDB Cloud +- Default value: `2` for TiDB Self-Hosted and `1` for TiDB Cloud - Range: `[1, 2]` - Controls how TiDB collects statistics. @@ -1116,7 +1116,7 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a > **Note:** > -> To improve the speed for index creation using this variable, make sure that your TiDB cluster is hosted on AWS and your TiDB node size is at least 8 vCPU. For [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters, this feature is unavailable. +> To improve the speed for index creation using this variable, make sure that your TiDB cluster is hosted on AWS and your TiDB node size is at least 8 vCPU. For [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters, this feature is unavailable. diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index c8bbe398ae520..a6b7213c9b2a2 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -10,14 +10,14 @@ This document describes how to back up and restore your TiDB cluster data on TiD ## Limitations -### Dedicated Tier +### TiDB Dedicated - TiDB Cloud does not support restoring tables in the `mysql` schema, including user permissions and system variables. You can use [Dumpling and Lightning](https://docs.pingcap.com/tidb/stable/backup-and-restore-using-dumpling-lightning) to manually back up and restore these data. - 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. -### Serverless Tier +### TiDB Serverless -- It is important to note that Serverless Tier 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. +- 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. @@ -25,17 +25,17 @@ This document describes how to back up and restore your TiDB cluster data on TiD ## Backup -You can back up data for both [Serverless Tier](#serverless-tier) and [Dedicated Tier](#dedicated-tier). +You can back up data for both [TiDB Serverless](#tidb-serverless) and [TiDB Dedicated](#tidb-dedicated). -### Serverless Tier +### TiDB Serverless -Automatic backups are scheduled for your Serverless Tier clusters according to the backup setting, which can reduce your loss in extreme disaster situations. +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 Serverless Tier cluster data every day at the backup time you have set. To set the backup time, perform the following steps: +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 Serverless Tier cluster. +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. @@ -57,17 +57,17 @@ To delete an existing backup file, perform the following steps: 2. Click **Delete** for the backup file that you want to delete. -### Dedicated Tier +### TiDB Dedicated -TiDB Cloud Dedicated Tier supports automatic backup and manual backup. +TiDB Dedicated supports automatic backup and manual backup. -Automatic backups are scheduled for your Dedicated Tier 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 cluster at any time. #### Automatic backup -By the automatic backup, you can back up the Dedicated Tier cluster data every day at the backup time you have set. To set the backup time, perform the following steps: +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: -1. Navigate to the **Backup** page of a Dedicated Tier cluster. +1. Navigate to the **Backup** page of a TiDB Dedicated cluster. 2. Click **Backup Settings**. The setting window displays. @@ -151,9 +151,9 @@ To delete a running backup job, it is similar as [**Delete backup files**](#dele ## Restore -### Serverless Tier +### TiDB Serverless -TiDB Cloud Serverless Tier only supports in-place restoration. To restore your Serverless Tier cluster from a backup, follow these steps: +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. @@ -164,9 +164,9 @@ TiDB Cloud Serverless Tier only supports in-place restoration. To restore your S 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. -### Dedicated Tier +### TiDB Dedicated -TiDB Cloud Dedicated Tier provides two types of data restoration: +TiDB Dedicated provides two types of data restoration: - Restore backup data to a new cluster - Restore a deleted cluster from the recycle bin diff --git a/tidb-cloud/built-in-monitoring.md b/tidb-cloud/built-in-monitoring.md index 9b7267f3bb5a5..a7d5b3bfab748 100644 --- a/tidb-cloud/built-in-monitoring.md +++ b/tidb-cloud/built-in-monitoring.md @@ -22,12 +22,12 @@ To view the metrics on the Metrics page, take the following steps: ## Metrics retention policy -- For Dedicated Tier clusters, the metrics data is kept for 7 days. -- For Serverless Tier clusters, the metrics data is kept for 3 days. +- For TiDB Dedicated clusters, the metrics data is kept for 7 days. +- For TiDB Serverless clusters, the metrics data is kept for 3 days. -## Metrics for Dedicated Tier clusters +## Metrics for TiDB Dedicated clusters -The following sections illustrate the metrics on the Metrics page for Dedicated Tier clusters. +The following sections illustrate the metrics on the Metrics page for TiDB Dedicated clusters. ### Overview @@ -81,12 +81,12 @@ The following sections illustrate the metrics on the Metrics page for Dedicated | TiFlash IO MBps | node-write, node-read | The total bytes of read and write in each TiFlash node. | | TiFlash Storage Usage | node | The storage usage statistics of each TiFlash node. | -## Metrics for Serverless Tier clusters +## Metrics for TiDB Serverless clusters -The Metrics page provides two tabs for metrics of Serverless Tier clusters: +The Metrics page provides two tabs for metrics of TiDB Serverless clusters: -- Cluster Status: displays the cluster-level main metrics. -- Database Status: displays the database-level main metrics. +- Cluster Status: displays the cluster-level main metrics. +- Database Status: displays the database-level main metrics. ### Cluster Status @@ -97,11 +97,11 @@ The following table illustrates the cluster-level main metrics under the **Clust | Request Units | RU per second | The Request Unit (RU) is a unit of measurement used to track the resource consumption of a query or transaction. In addition to queries that you run, Request Units can be consumed by background activities, so when the QPS is 0, the Request Units per second might not be zero. | | Used Storage Size | Row-based storage, Columnar storage | The size of the row store and the size of the column store. | | Query Per Second | All, {SQL type} | The number of SQL statements executed per second, which are collected by SQL types, such as `SELECT`, `INSERT`, and `UPDATE`. | -| Average Query Duration | All, {SQL type} | The duration from receiving a request from the client to the Serverless Tier cluster until the cluster executes the request and returns the result to the client. | +| Average Query Duration | All, {SQL type} | The duration from receiving a request from the client to the TiDB Serverless cluster until the cluster executes the request and returns the result to the client. | | Failed Query | All | The number of SQL statement execution errors per second. | | Transaction Per Second | All | The number of transactions executed per second. | | Average Transaction Duration | All | The average execution duration of transactions. | -| Total Connection | All | The number of connections to the Serverless Tier cluster. | +| Total Connection | All | The number of connections to the TiDB Serverless cluster. | ### Database Status diff --git a/tidb-cloud/changefeed-overview.md b/tidb-cloud/changefeed-overview.md index 8040d0a33caad..7d390ea57e452 100644 --- a/tidb-cloud/changefeed-overview.md +++ b/tidb-cloud/changefeed-overview.md @@ -12,7 +12,7 @@ TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data servic > > Currently, TiDB Cloud only allows up to 10 changefeeds per cluster. > -> For [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta), the changefeed feature is unavailable. +> 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. @@ -81,9 +81,9 @@ To learn the billing for changefeeds in TiDB Cloud, see [Changefeed billing](/ti ## Changefeed states -The state of a replication task represents the running state of the replication task. During the running process, replication tasks might fail with errors, be manually paused, resumed, or reach the specified `TargetTs`. These behaviors can lead to changes of the replication task state. +The state of a replication task represents the running state of the replication task. During the running process, replication tasks might fail with errors, be manually paused, resumed, or reach the specified `TargetTs`. These behaviors can lead to changes of the replication task state. -The states are described as follows: +The states are described as follows: - `CREATING`: the replication task is being created. - `RUNNING`: the replication task runs normally and the checkpoint-ts proceeds normally. diff --git a/tidb-cloud/changefeed-sink-to-apache-kafka.md b/tidb-cloud/changefeed-sink-to-apache-kafka.md index 9b9662403c55c..a785973ee37a1 100644 --- a/tidb-cloud/changefeed-sink-to-apache-kafka.md +++ b/tidb-cloud/changefeed-sink-to-apache-kafka.md @@ -11,7 +11,7 @@ This document describes how to create a changefeed to stream data from TiDB Clou > > 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 [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta), the changefeed feature is unavailable. +> 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 b109fd9fc6aa6..a7ddcc655f5fe 100644 --- a/tidb-cloud/changefeed-sink-to-mysql.md +++ b/tidb-cloud/changefeed-sink-to-mysql.md @@ -13,11 +13,11 @@ This document describes how to stream data from TiDB Cloud to MySQL using the ** > > Currently, TiDB Cloud only allows up to 5 changefeeds per cluster. > -> For [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta), the changefeed feature is unavailable. +> For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable. ## Restrictions -- For each TiDB Cloud cluster, you can create up to 5 changefeeds. +- For each TiDB Cloud cluster, you can create up to 5 changefeeds. - Because TiDB Cloud uses TiCDC to establish changefeeds, it has the same [restrictions as TiCDC](https://docs.pingcap.com/tidb/stable/ticdc-overview#unsupported-scenarios). - If the table to be replicated does not have a primary key or a non-null unique index, the absence of a unique constraint during replication could result in duplicated data being inserted downstream in some retry scenarios. @@ -36,11 +36,11 @@ Make sure that your TiDB Cluster can connect to the MySQL service. If your MySQL service is in an AWS VPC that has no public internet access, take the following steps: 1. [Set up a VPC peering connection](/tidb-cloud/set-up-vpc-peering-connections.md) between the VPC of the MySQL service and your TiDB cluster. -2. Modify the inbound rules of the security group that the MySQL service is associated with. +2. Modify the inbound rules of the security group that the MySQL service is associated with. You must add [the CIDR of the region where your TiDB Cloud cluster is located](/tidb-cloud/set-up-vpc-peering-connections.md#prerequisite-set-a-project-cidr) to the inbound rules. Doing so allows the traffic to flow from your TiDB Cluster to the MySQL instance. -3. If the MySQL URL contains a hostname, you need to allow TiDB Cloud to be able to resolve the DNS hostname of the MySQL service. +3. If the MySQL URL contains a hostname, you need to allow TiDB Cloud to be able to resolve the DNS hostname of the MySQL service. 1. Follow the steps in [Enable DNS resolution for a VPC peering connection](https://docs.aws.amazon.com/vpc/latest/peering/modify-peering-connections.html#vpc-peering-dns). 2. Enable the **Accepter DNS resolution** option. @@ -48,10 +48,10 @@ If your MySQL service is in an AWS VPC that has no public internet access, take If your MySQL service is in a GCP VPC that has no public internet access, take the following steps: 1. If your MySQL service is Google Cloud SQL, you must expose a MySQL endpoint in the associated VPC of the Google Cloud SQL instance. You may need to use the [**Cloud SQL Auth proxy**](https://cloud.google.com/sql/docs/mysql/sql-proxy) which is developed by Google. -2. [Set up a VPC peering connection](/tidb-cloud/set-up-vpc-peering-connections.md) between the VPC of the MySQL service and your TiDB cluster. +2. [Set up a VPC peering connection](/tidb-cloud/set-up-vpc-peering-connections.md) between the VPC of the MySQL service and your TiDB cluster. 3. Modify the ingress firewall rules of the VPC where MySQL is located. - You must add [the CIDR of the region where your TiDB Cloud cluster is located](/tidb-cloud/set-up-vpc-peering-connections.md#prerequisite-set-a-project-cidr) to the ingress firewall rules. Doing so allows the traffic to flow from your TiDB Cluster to the MySQL endpoint. + You must add [the CIDR of the region where your TiDB Cloud cluster is located](/tidb-cloud/set-up-vpc-peering-connections.md#prerequisite-set-a-project-cidr) to the ingress firewall rules. Doing so allows the traffic to flow from your TiDB Cluster to the MySQL endpoint. ### Load existing data (optional) @@ -84,7 +84,7 @@ To load the existing data: Log: tidb-binlog Pos: 420747102018863124 Finished dump at: 2020-11-10 10:40:20 - ``` + ``` ### Create target tables in MySQL diff --git a/tidb-cloud/changefeed-sink-to-tidb-cloud.md b/tidb-cloud/changefeed-sink-to-tidb-cloud.md index a0eccd3925194..aa89b0d4d638e 100644 --- a/tidb-cloud/changefeed-sink-to-tidb-cloud.md +++ b/tidb-cloud/changefeed-sink-to-tidb-cloud.md @@ -1,11 +1,11 @@ --- title: Sink to TiDB Cloud -Summary: Learn how to create a changefeed to stream data from a TiDB Cloud Dedicated Tier cluster to a TiDB Cloud Serverless Tier cluster. +Summary: Learn how to create a changefeed to stream data from a TiDB Dedicated cluster to a TiDB Serverless cluster. --- # Sink to TiDB Cloud -This document describes how to stream data from a TiDB Cloud Dedicated Tier cluster to a TiDB Cloud Serverless Tier cluster. +This document describes how to stream data from a TiDB Dedicated cluster to a TiDB Serverless cluster. > **Note:** > @@ -16,21 +16,21 @@ This document describes how to stream data from a TiDB Cloud Dedicated Tier clus - For each TiDB Cloud cluster, you can create up to 5 changefeeds. - Because TiDB Cloud uses TiCDC to establish changefeeds, it has the same [restrictions as TiCDC](https://docs.pingcap.com/tidb/stable/ticdc-overview#unsupported-scenarios). - If the table to be replicated does not have a primary key or a non-null unique index, the absence of a unique constraint during replication could result in duplicated data being inserted downstream in some retry scenarios. -- The **Sink to TiDB Cloud** feature is only available to TiDB Cloud Dedicated Tier clusters that are in the following AWS regions and created after November 9, 2022: +- The **Sink to TiDB Cloud** feature is only available to TiDB Dedicated clusters that are in the following AWS regions and created after November 9, 2022: - AWS Oregon (us-west-2) - AWS Frankfurt (eu-central-1) - AWS Singapore (ap-southeast-1) - AWS Tokyo (ap-northeast-1) -- The source Dedicated Tier cluster and the destination Serverless Tier cluster must be in the same project and the same region. -- The **Sink to TiDB Cloud** feature only supports network connection via private endpoints. When you create a changefeed to stream data from a TiDB Cloud Dedicated Tier cluster to a TiDB Cloud Serverless Tier cluster, TiDB Cloud will automatically set up the private endpoint connection between the two clusters. +- The source TiDB Dedicated cluster and the destination TiDB Serverless cluster must be in the same project and the same region. +- The **Sink to TiDB Cloud** feature only supports network connection via private endpoints. When you create a changefeed to stream data from a TiDB Dedicated cluster to a TiDB Serverless cluster, TiDB Cloud will automatically set up the private endpoint connection between the two clusters. ## Prerequisites -The **Sink to TiDB Cloud** connector can only sink incremental data from a TiDB Cloud Dedicated Tier cluster to a Serverless Tier cluster after a certain [TSO](https://docs.pingcap.com/tidb/stable/glossary#tso). +The **Sink to TiDB Cloud** connector can only sink incremental data from a TiDB Dedicated cluster to a TiDB Serverless cluster after a certain [TSO](https://docs.pingcap.com/tidb/stable/glossary#tso). -Before creating a changefeed, you need to export existing data from the source Dedicated Tier cluster and load the data to the destination Serverless Tier cluster. +Before creating a changefeed, you need to export existing data from the source TiDB Dedicated cluster and load the data to the destination TiDB Serverless cluster. 1. Extend the [tidb_gc_life_time](https://docs.pingcap.com/tidb/stable/system-variables#tidb_gc_life_time-new-in-v50) to be longer than the total time of the following two operations, so that historical data during the time is not garbage collected by TiDB. @@ -43,7 +43,7 @@ Before creating a changefeed, you need to export existing data from the source D SET GLOBAL tidb_gc_life_time = '720h'; ``` -2. [Export data](/tidb-cloud/export-data-from-tidb-cloud.md) from your TiDB Cloud Dedicated Tier cluster, then use community tools such as [mydumper/myloader](https://centminmod.com/mydumper.html) to load data to the destination Serverless Tier cluster. +2. [Export data](/tidb-cloud/export-data-from-tidb-cloud.md) from your TiDB Dedicated cluster, then use community tools such as [mydumper/myloader](https://centminmod.com/mydumper.html) to load data to the destination TiDB Serverless cluster. 3. From the [exported files of Dumpling](/dumpling-overview.md#format-of-exported-files), get the start position of TiDB Cloud sink from the metadata file: @@ -59,13 +59,13 @@ Before creating a changefeed, you need to export existing data from the source D ## Create a TiDB Cloud sink -After completing the prerequisites, you can sink your data to the destination Serverless Tier cluster. +After completing the prerequisites, you can sink your data to the destination TiDB Serverless cluster. 1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Changefeed** in the left navigation pane. 2. Click **Create Changefeed**, and select **TiDB Cloud** as the destination. -3. In the **TiDB Cloud Connection** area, select the destination Serverless Tier cluster, and then fill in the user name and password of the destination cluster. +3. In the **TiDB Cloud Connection** area, select the destination TiDB Serverless cluster, and then fill in the user name and password of the destination cluster. 4. Click **Next** to establish the connection between the two TiDB clusters and test whether the changefeed can connect them successfully: diff --git a/tidb-cloud/configure-ip-access-list.md b/tidb-cloud/configure-ip-access-list.md index e6b821a71ebb2..afec8122dbf26 100644 --- a/tidb-cloud/configure-ip-access-list.md +++ b/tidb-cloud/configure-ip-access-list.md @@ -1,17 +1,17 @@ --- title: Configure an IP Access List -summary: Learn how to configure IP addresses that are allowed to access your Dedicated Tier cluster. +summary: Learn how to configure IP addresses that are allowed to access your TiDB Dedicated cluster. --- # Configure an IP Access List -For each Dedicated Tier cluster in TiDB Cloud, you can configure an IP access list to filter internet traffic trying to access the cluster, which works similarly to a firewall access control list. After the configuration, only the clients and applications whose IP addresses are in the IP access list can connect to your Dedicated Tier cluster. +For each TiDB Dedicated cluster in TiDB Cloud, you can configure an IP access list to filter internet traffic trying to access the cluster, which works similarly to a firewall access control list. After the configuration, only the clients and applications whose IP addresses are in the IP access list can connect to your TiDB Dedicated cluster. > **Note:** > -> Configuring the IP access list is only available for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +> Configuring the IP access list is only available for [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. -For a Dedicated Tier cluster, you can configure its IP access list in either of the following ways: +For a TiDB Dedicated cluster, you can configure its IP access list in either of the following ways: - [Configure an IP access list in standard connection](#configure-an-ip-access-list-in-standard-connection) @@ -19,17 +19,17 @@ For a Dedicated Tier cluster, you can configure its IP access list in either of ## Configure an IP access list in standard connection -To configure an IP access list for your Dedicated Tier cluster in standard connection, take the following steps: +To configure an IP access list for your TiDB Dedicated cluster in standard connection, take the following steps: 1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. -2. In the row of your Dedicated Tier cluster, click **...** and select **Connect**. A dialog is displayed. +2. In the row of your TiDB Dedicated cluster, click **...** and select **Connect**. A dialog is displayed. 3. In the dialog, locate **Step 1: Create traffic filter** on the **Standard Connection** tab and configure the IP access list. - If the IP access list of your cluster has not been set, you can click **Add My Current IP Address** to add your current IP address to the IP access list, and then click **Add Item** to add more IP addresses if necessary. Next, click **Update Filter** to save the configuration. > **Note:** > - > For each Dedicated Tier cluster, you can add up to 7 IP addresses to the IP access list. To apply for a quota to add more IP addresses, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). + > For each TiDB Dedicated cluster, you can add up to 7 IP addresses to the IP access list. To apply for a quota to add more IP addresses, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). - If the IP access list of your cluster has been set, click **Edit** to add, edit, or remove IP addresses, and then click **Update Filter** to save the configuration. @@ -37,10 +37,10 @@ To configure an IP access list for your Dedicated Tier cluster in standard conne ## Configure an IP access list in security settings -To configure an IP access list for your Dedicated Tier cluster in security settings, take the following steps: +To configure an IP access list for your TiDB Dedicated cluster in security settings, take the following steps: 1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. -2. In the row of your Dedicated Tier cluster, click **...** and select **Security Settings**. A security setting dialog is displayed. +2. In the row of your TiDB Dedicated cluster, click **...** and select **Security Settings**. A security setting dialog is displayed. 3. In the dialog, configure the IP access list as follows: - To add your current IP address to the IP access list, click **Add My Current IP Address**. @@ -49,7 +49,7 @@ To configure an IP access list for your Dedicated Tier cluster in security setti > **Note:** > - > For each Dedicated Tier cluster, you can add up to 7 IP addresses to the IP access list. To apply for a quota to add more IP addresses, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). + > For each TiDB Dedicated cluster, you can add up to 7 IP addresses to the IP access list. To apply for a quota to add more IP addresses, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). - To allow any IP address to access your cluster (not recommended), click **Allow Access From Anywhere**. According to security best practices, it is NOT recommended that you allow any IP address to access your cluster, as this would expose your cluster to the internet completely, which is highly risky. diff --git a/tidb-cloud/configure-maintenance-window.md b/tidb-cloud/configure-maintenance-window.md index 32740644b7d4e..bd913e5e49b25 100644 --- a/tidb-cloud/configure-maintenance-window.md +++ b/tidb-cloud/configure-maintenance-window.md @@ -13,7 +13,7 @@ By configuring the maintenance window, you can easily schedule and manage mainte > **Note:** > -> The maintenance window feature is only available for [Dedicated Tier clusters](/tidb-cloud/select-cluster-tier.md#dedicated-tier). +> The maintenance window feature is only available for [TiDB Dedicated clusters](/tidb-cloud/select-cluster-tier.md#tidb-dedicated). ## Allowed and disallowed operations during a maintenance window diff --git a/tidb-cloud/configure-security-settings.md b/tidb-cloud/configure-security-settings.md index d190e7199d9b9..04dce968d1105 100644 --- a/tidb-cloud/configure-security-settings.md +++ b/tidb-cloud/configure-security-settings.md @@ -5,11 +5,11 @@ summary: Learn how to configure the root password and allowed IP addresses to co # Configure Cluster Security Settings -For Dedicated Tier clusters, you can configure the root password and allowed IP addresses to connect to your cluster. +For TiDB Dedicated clusters, you can configure the root password and allowed IP addresses to connect to your cluster. > **Note:** > -> For Serverless Tier clusters, this document is inapplicable and you can refer to [TLS Connection to Serverless Tier](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md) instead. +> For TiDB Serverless clusters, this document is inapplicable and you can refer to [TLS Connection to TiDB Serverless](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md) instead. 1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. diff --git a/tidb-cloud/connect-to-tidb-cluster.md b/tidb-cloud/connect-to-tidb-cluster.md index b73fb1948b375..b88291a94b4f0 100644 --- a/tidb-cloud/connect-to-tidb-cluster.md +++ b/tidb-cloud/connect-to-tidb-cluster.md @@ -5,21 +5,21 @@ summary: Learn how to connect to your TiDB cluster via different methods. # Connect to Your TiDB Cluster -After your TiDB cluster is created on TiDB Cloud, you can connect to your TiDB cluster. Depending on whether you are using a Serverless Tier cluster or a Dedicated Tier cluster, you can find the available connection methods as follows: +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: -## Serverless Tier +## TiDB Serverless -For Serverless Tier clusters, you can connect to your cluster via one of the following methods: +For TiDB Serverless clusters, you can connect to your cluster 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#serverless-tier) +- [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. - Serverless Tier 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. + 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) @@ -27,11 +27,11 @@ For Serverless Tier clusters, you can connect to your cluster via one of the fol 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. -## Dedicated Tier +## TiDB Dedicated -For Dedicated Tier clusters, you can connect to your cluster via one of the following methods: +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#dedicated-tier) +- [Connect via standard connection](/tidb-cloud/connect-via-standard-connection.md#tidb-dedicated) 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 b3c28968e598b..76a22b50aa8dd 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 [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) using SQL Shell. To connect to your Serverless Tier cluster, see [Connect to Serverless Tier clusters](/tidb-cloud/connect-to-tidb-cluster.md#serverless-tier). +> 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). To connect to your TiDB cluster using SQL shell, perform the following steps: diff --git a/tidb-cloud/connect-via-standard-connection.md b/tidb-cloud/connect-via-standard-connection.md index 014a1edc4f8dd..d624c09b137dd 100644 --- a/tidb-cloud/connect-via-standard-connection.md +++ b/tidb-cloud/connect-via-standard-connection.md @@ -7,11 +7,11 @@ summary: Learn how to connect to your TiDB Cloud cluster 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. -The standard connection is available to both Serverless Tier and Dedicated Tier. +The standard connection is available to both TiDB Serverless and TiDB Dedicated. -## Serverless Tier +## TiDB Serverless -To connect to a Serverless Tier cluster via standard connection, perform the following steps: +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. @@ -21,8 +21,8 @@ To connect to a Serverless Tier cluster via standard connection, perform the fol > **Note:** > - > - Keeping the endpoint type as `Public` means the connection is via standard TLS connection. For more information, see [TLS Connection to Serverless Tier](/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#serverless-tier). + > - 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. @@ -30,11 +30,11 @@ To connect to a Serverless Tier cluster via standard connection, perform the fol > **Note:** > - > When you connect to a Serverless Tier 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). + > 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). -## Dedicated Tier +## TiDB Dedicated -To connect to a Dedicated Tier cluster via standard connection, perform the following steps: +To connect to a TiDB Dedicated cluster via standard connection, perform the following steps: 1. Open the overview page of the target cluster. @@ -65,7 +65,7 @@ To connect to a Dedicated Tier cluster via standard connection, perform the foll > **Note:** > - > - The TiDB cluster CA is only available for Dedicated Tier clusters. + > - The TiDB cluster CA is only available for TiDB Dedicated clusters. > - Currently, TiDB Cloud only provides the connection strings and sample code for these connection methods: MySQL, MyCLI, JDBC, Python, Go, and Node.js. 5. Under **Step 3: Connect with a SQL client** in the dialog, click the tab of your preferred connection method, and then refer to the connection string and sample code on the tab to connect to your cluster. diff --git a/tidb-cloud/create-tidb-cluster.md b/tidb-cloud/create-tidb-cluster.md index 4face00039c06..2b3257c0fbbc7 100644 --- a/tidb-cloud/create-tidb-cluster.md +++ b/tidb-cloud/create-tidb-cluster.md @@ -17,26 +17,26 @@ This tutorial guides you through signing up and creating a TiDB cluster. 2. [Log in](https://tidbcloud.com/) to your TiDB Cloud account. -## Step 2. Select a cluster tier +## Step 2. Select a cluster option -TiDB Cloud provides the following two cluster tier options. Before creating a TiDB cluster, consider which option suits your need better: +TiDB Cloud provides the following two options. Before creating a TiDB cluster, consider which option suits your need better: -- Serverless Tier (Beta) +- TiDB Serverless (Beta) - The TiDB Cloud Serverless Tier is a fully managed service of TiDB. It is still in the beta phase and cannot be used in production. However, you can use Serverless Tier clusters for non-production workloads such as prototype applications, hackathons, academic courses, or to provide a temporary data service for your datasets. + 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. -- Dedicated Tier +- TiDB Dedicated - The TiDB Cloud Dedicated Tier 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). + 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 Tier](/tidb-cloud/select-cluster-tier.md). +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 Dedicated Tier users, you can either rename the default project or create a new 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. @@ -64,9 +64,9 @@ If you are a project member, you can access only the specific projects to which ## Step 4. Create a TiDB cluster -
+
-To create a Serverless Tier cluster, take the following steps: +To create a TiDB Serverless cluster, take the following steps: 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page. @@ -74,19 +74,19 @@ To create a Serverless Tier cluster, take the following steps: 3. On the **Create Cluster** page, **Serverless** is selected by default. -4. The cloud provider of Serverless Tier is AWS. You can select an AWS region where you want to host your cluster. +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 Serverless Tier clusters by default. To create more Serverless Tier clusters, you need to add a credit card and set a [spend limit](/tidb-cloud/tidb-cloud-glossary.md#spend-limit) for the usage. + > 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#serverless-tier) to create a password for your cluster. +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:** > @@ -94,9 +94,9 @@ To create a Serverless Tier cluster, take the following steps:
-
+
-To create a Dedicated Tier cluster, take the following steps: +To create a TiDB Dedicated cluster, take the following steps: 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project. diff --git a/tidb-cloud/data-service-get-started.md b/tidb-cloud/data-service-get-started.md index c119ec3398ae7..36a2acf7d0a60 100644 --- a/tidb-cloud/data-service-get-started.md +++ b/tidb-cloud/data-service-get-started.md @@ -9,7 +9,7 @@ Data Service (beta) enables you to access TiDB Cloud data via an HTTPS request u > **Tip:** > -> TiDB Cloud provides a Chat2Query API for Serverless Tier clusters. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. +> TiDB Cloud provides a Chat2Query API for TiDB Serverless clusters. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. > > For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.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 [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-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 cluster](/tidb-cloud/create-tidb-cluster.md) to create one. ## Step 1. Create a Data App diff --git a/tidb-cloud/data-service-overview.md b/tidb-cloud/data-service-overview.md index 808272193f95a..9e0f1eddafc21 100644 --- a/tidb-cloud/data-service-overview.md +++ b/tidb-cloud/data-service-overview.md @@ -9,7 +9,7 @@ TiDB Cloud provides a [Data Service (beta)](https://tidbcloud.com/console/data-s > **Note:** > -> Data Service is only available for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +> Data Service is only available for [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. An endpoint in Data Service is a web API that you can customize to execute SQL statements. You can specify parameters for your SQL statements, such as the value used in the `WHERE` clause. When a client calls an endpoint and provides values for the parameters in a request URL, the endpoint executes the corresponding SQL statement with the provided parameters and returns the results as part of the HTTP response. @@ -17,7 +17,7 @@ To manage endpoints more efficiently, you can use Data Apps. A Data App in Data > **Tip:** > -> TiDB Cloud provides a Chat2Query API for Serverless Tier clusters. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. +> TiDB Cloud provides a Chat2Query API for TiDB Serverless clusters. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. > > For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). diff --git a/tidb-cloud/delete-tidb-cluster.md b/tidb-cloud/delete-tidb-cluster.md index eb6c2a22848e8..8c7c8be26aa0c 100644 --- a/tidb-cloud/delete-tidb-cluster.md +++ b/tidb-cloud/delete-tidb-cluster.md @@ -19,15 +19,15 @@ 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 Dedicated Tier 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 Cluster Data](/tidb-cloud/backup-and-restore.md). > **Note:** > - > For [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-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. + > 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. 5. Click **I understand the consequences. Delete this cluster**. - Once a backed up Dedicated Tier cluster is deleted, the existing backup files of the cluster are moved to the recycle bin. + Once a backed up TiDB Dedicated cluster is deleted, the existing backup files of the cluster are moved to the recycle bin. - 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. diff --git a/tidb-cloud/explore-data-with-chat2query.md b/tidb-cloud/explore-data-with-chat2query.md index e961d2e9ea047..2cfdb27a10925 100644 --- a/tidb-cloud/explore-data-with-chat2query.md +++ b/tidb-cloud/explore-data-with-chat2query.md @@ -13,7 +13,7 @@ TiDB Cloud also provides the Chat2Query API, which is a RESTful interface. For m > **Note:** > -> Chat2Query is only available for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +> Chat2Query is only available for [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. ## Use cases diff --git a/tidb-cloud/export-data-from-tidb-cloud.md b/tidb-cloud/export-data-from-tidb-cloud.md index 1ad8a6a677a2c..9f8098cedee38 100644 --- a/tidb-cloud/export-data-from-tidb-cloud.md +++ b/tidb-cloud/export-data-from-tidb-cloud.md @@ -45,7 +45,7 @@ You can use the tool [Dumpling](/dumpling-overview.md) for data export. -
+
```shell tiup dumpling -h ${tidb_endpoint} -P 4000 -u ${user} -p ${password} -F 67108864MiB -t 4 -o ${export_dir} --filetype sql --consistency none @@ -53,10 +53,10 @@ You can use the tool [Dumpling](/dumpling-overview.md) for data export. > **Note:** > - > To export Serverless Tier cluster data, you must ensure that the Dumpling version is at least v6.5.0. If your Dumpling version is v6.5.0, you also need to set `--ca=${ca_path}` in the command. To find the CA root path on your system, see [TLS Connections to Serverless Tier](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md#root-certificate-default-path). + > To export TiDB Serverless cluster data, you must ensure that the Dumpling version is at least v6.5.0. If your Dumpling version is v6.5.0, you also need to set `--ca=${ca_path}` in the command. To find the CA root path on your system, see [TLS Connections to TiDB Serverless](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md#root-certificate-default-path).
-
+
```shell tiup dumpling:v6.5.2 -h ${tidb_endpoint} -P ${port} -u ${user} -p ${password} -F 67108864MiB -t 4 -o ${export_dir} --filetype sql @@ -74,7 +74,7 @@ You can use the tool [Dumpling](/dumpling-overview.md) for data export. - `-F`: The maximum size of a single file. - `-o`: The export directory. - `--filetype`: The exported file type. The default value is `sql`. You can choose from `sql` and `csv`. - - `--consistency`: The data consistency. The default value is `auto`. For Serverless Tier, you must set it to `none`. + - `--consistency`: The data consistency. The default value is `auto`. For TiDB Serverless, you must set it to `none`. For more information about Dumpling options, see [Dumpling option list](/dumpling-overview.md#option-list-of-dumpling). diff --git a/tidb-cloud/get-started-with-cli.md b/tidb-cloud/get-started-with-cli.md index eea829b34c490..16f2eca4af30c 100644 --- a/tidb-cloud/get-started-with-cli.md +++ b/tidb-cloud/get-started-with-cli.md @@ -103,7 +103,7 @@ tiup update cloud ## Quick start -TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) (Beta) is the best way to get started with TiDB Cloud. In this section, you will learn how to create a Serverless Tier cluster with TiDB Cloud CLI. +[TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) (Beta) is the best way to get started with TiDB Cloud. In this section, you will learn how to create a TiDB Serverless cluster with TiDB Cloud CLI. ### Create a user profile @@ -117,9 +117,9 @@ ticloud config create > > The profile name **MUST NOT** contain `.`. -### Create a Serverless Tier cluster +### Create a TiDB Serverless cluster -To create a Serverless Tier cluster, enter the following command, and then follow the CLI prompts to provide the required information and set the password: +To create a TiDB Serverless cluster, enter the following command, and then follow the CLI prompts to provide the required information and set the password: ```shell ticloud cluster create diff --git a/tidb-cloud/high-availability-with-multi-az.md b/tidb-cloud/high-availability-with-multi-az.md index 44462f78b153d..eb4b0ecb3987b 100644 --- a/tidb-cloud/high-availability-with-multi-az.md +++ b/tidb-cloud/high-availability-with-multi-az.md @@ -7,7 +7,7 @@ summary: TiDB Cloud supports high availability with Multi-AZ deployments. TiDB uses the Raft consensus algorithm to ensure that data is highly available and safely replicated throughout storage in Raft Groups. Data is redundantly copied between storage nodes and placed in different availability zones to protect against machine or data center failures. With automatic failover, TiDB ensures that your service is always on. -TiDB Cloud clusters consist of three major components: TiDB node, TiKV node, and TiFlash node. The highly availability implementation of each component for Dedicated Tier is as follows: +TiDB Cloud clusters consist of three major components: TiDB node, TiKV node, and TiFlash node. The highly availability implementation of each component for TiDB Dedicated is as follows: * **TiDB node** diff --git a/tidb-cloud/import-csv-files.md b/tidb-cloud/import-csv-files.md index 797983fb6cb9f..58c3c7d02fa47 100644 --- a/tidb-cloud/import-csv-files.md +++ b/tidb-cloud/import-csv-files.md @@ -10,7 +10,7 @@ This document describes how to import CSV files from Amazon Simple Storage Servi > **Note:** > > - To ensure data consistency, TiDB Cloud allows to import CSV files into empty tables only. To import data into an existing table that already contains data, you can use TiDB Cloud to import the data into a temporary empty table by following this document, and then use the `INSERT SELECT` statement to copy the data to the target existing table. -> - If there is a changefeed in a Dedicated Tier cluster, you cannot import data to the cluster (the **Import Data** button will be disabled), because the current import data feature uses the [physical import mode](https://docs.pingcap.com/tidb/stable/tidb-lightning-physical-import-mode). In this mode, the imported data does not generate change logs, so the changefeed cannot detect the imported data. +> - If there is a changefeed in a TiDB Dedicated cluster, you cannot import data to the cluster (the **Import Data** button will be disabled), because the current import data feature uses the [physical import mode](https://docs.pingcap.com/tidb/stable/tidb-lightning-physical-import-mode). In this mode, the imported data does not generate change logs, so the changefeed cannot detect the imported data. ## Step 1. Prepare the CSV files @@ -98,8 +98,8 @@ To import the CSV files to TiDB Cloud, take the following steps: 2. Click the name of your target cluster to go to its overview page, and then click **Import** in the left navigation pane. 2. On the **Import** page: - - For a Dedicated Tier cluster, click **Import Data** in the upper-right corner. - - For a Serverless Tier cluster, click the **import data from S3** link above the upload area. + - For a TiDB Dedicated cluster, click **Import Data** in the upper-right corner. + - For a TiDB Serverless cluster, click the **import data from S3** link above the upload area. 3. Provide the following information for the source CSV files: diff --git a/tidb-cloud/import-parquet-files.md b/tidb-cloud/import-parquet-files.md index cd2bb73b48db4..7c0c30172bcb4 100644 --- a/tidb-cloud/import-parquet-files.md +++ b/tidb-cloud/import-parquet-files.md @@ -10,7 +10,7 @@ You can import both uncompressed and Snappy compressed [Apache Parquet](https:// > **Note:** > > - TiDB Cloud only supports importing Parquet files into empty tables. To import data into an existing table that already contains data, you can use TiDB Cloud to import the data into a temporary empty table by following this document, and then use the `INSERT SELECT` statement to copy the data to the target existing table. -> - If there is a changefeed in a Dedicated Tier cluster, you cannot import data to the cluster (the **Import Data** button will be disabled), because the current import data feature uses the [physical import mode](https://docs.pingcap.com/tidb/stable/tidb-lightning-physical-import-mode). In this mode, the imported data does not generate change logs, so the changefeed cannot detect the imported data. +> - If there is a changefeed in a TiDB Dedicated cluster, you cannot import data to the cluster (the **Import Data** button will be disabled), because the current import data feature uses the [physical import mode](https://docs.pingcap.com/tidb/stable/tidb-lightning-physical-import-mode). In this mode, the imported data does not generate change logs, so the changefeed cannot detect the imported data. ## Step 1. Prepare the Parquet files @@ -105,8 +105,8 @@ To import the Parquet files to TiDB Cloud, take the following steps: 2. Click the name of your target cluster to go to its overview page, and then click **Import** in the left navigation pane. 2. On the **Import** page: - - For a Dedicated Tier cluster, click **Import Data** in the upper-right corner. - - For a Serverless Tier cluster, click the **import data from S3** link above the upload area. + - For a TiDB Dedicated cluster, click **Import Data** in the upper-right corner. + - For a TiDB Serverless cluster, click the **import data from S3** link above the upload area. 3. Provide the following information for the source Parquet files: diff --git a/tidb-cloud/import-sample-data.md b/tidb-cloud/import-sample-data.md index 60a5992f46a4a..7e360504cbf13 100644 --- a/tidb-cloud/import-sample-data.md +++ b/tidb-cloud/import-sample-data.md @@ -24,8 +24,8 @@ This document describes how to import the sample data into TiDB Cloud via the UI On the **Import** page: - - For a Dedicated Tier cluster, click **Import Data** in the upper-right corner. - - For a Serverless Tier cluster, click the **import data from S3** link above the upload area. + - For a TiDB Dedicated cluster, click **Import Data** in the upper-right corner. + - For a TiDB Serverless cluster, click the **import data from S3** link above the upload area. Fill in the following parameters: diff --git a/tidb-cloud/integrate-tidbcloud-with-airbyte.md b/tidb-cloud/integrate-tidbcloud-with-airbyte.md index 924efdb8205f0..d1ec06d29f54f 100644 --- a/tidb-cloud/integrate-tidbcloud-with-airbyte.md +++ b/tidb-cloud/integrate-tidbcloud-with-airbyte.md @@ -60,7 +60,7 @@ Conveniently, the steps are the same for setting TiDB as the source and the dest > > - TiDB Cloud supports TLS connection. You can choose your TLS protocols in **TLSv1.2** and **TLSv1.3**, for example, `enabledTLSProtocols=TLSv1.2`. > - If you want to disable TLS connection to TiDB Cloud via JDBC, you need to set useSSL to `false` in JDBC URL Params specifically and close SSL connection, for example, `useSSL=false`. - > - TiDB Serverless Tier only supports TLS connections. + > - TiDB Serverless only supports TLS connections. 4. Click **Set up source** or **destination** to complete creating the connector. The following screenshot shows the configuration of TiDB as the source. diff --git a/tidb-cloud/integrate-tidbcloud-with-cloudflare.md b/tidb-cloud/integrate-tidbcloud-with-cloudflare.md index 03dfc1d063354..195a561ff6c42 100644 --- a/tidb-cloud/integrate-tidbcloud-with-cloudflare.md +++ b/tidb-cloud/integrate-tidbcloud-with-cloudflare.md @@ -21,7 +21,7 @@ This document shows how to deploy Cloudflare Workers with TiDB Cloud and Prisma Before you try the steps in this article, you need to prepare the following things: -- A TiDB Cloud account and a Serverless Tier cluster on TiDB Cloud. For more details, see [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md#step-1-create-a-tidb-cluster). +- A TiDB Cloud account and a TiDB Serverless cluster on TiDB Cloud. For more details, see [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md#step-1-create-a-tidb-cluster). - A [Cloudflare Workers account](https://dash.cloudflare.com/login). - A [Prisma Data Platform account](https://cloud.prisma.io/). - A [GitHub account](https://github.com/login). @@ -106,7 +106,7 @@ With Cloudflare Workers, you cannot directly access your database because there 1. To get started, sign in to the [Prisma Data Platform](https://cloud.prisma.io/) and click **New Project**. 2. Fill in the **Connection string** with this pattern `mysql://USER:PASSWORD@HOST:PORT/DATABASE?sslaccept=strict`. You can find the connection information in your [TiDB Cloud console](https://tidbcloud.com/console/clusters). -3. Leave the **Static IPs** as disabled because TiDB Cloud Serverless Tier is accessible from any IP address. +3. Leave the **Static IPs** as disabled because TiDB Serverless is accessible from any IP address. 4. Select a Data Proxy region that is geographically close to your TiDB Cloud cluster location. Then click **Create project**. ![Configure project settings](/media/tidb-cloud/cloudflare/cloudflare-project.png) diff --git a/tidb-cloud/integrate-tidbcloud-with-n8n.md b/tidb-cloud/integrate-tidbcloud-with-n8n.md index 3c1d8f691463e..ae544d15be694 100644 --- a/tidb-cloud/integrate-tidbcloud-with-n8n.md +++ b/tidb-cloud/integrate-tidbcloud-with-n8n.md @@ -7,7 +7,7 @@ summary: Learn the use of TiDB Cloud node in n8n. [n8n](https://n8n.io/) is an extendable workflow automation tool. With a [fair-code](https://faircode.io/) distribution model, n8n will always have visible source code, be available to self-host, and allow you to add your custom functions, logic, and apps. -This document introduces how to build an auto-workflow: create a TiDB Cloud Serverless Tier cluster, gather Hacker News RSS, store it to TiDB and send a briefing email. +This document introduces how to build an auto-workflow: create a TiDB Serverless cluster, gather Hacker News RSS, store it to TiDB and send a briefing email. ## Prerequisites: Get TiDB Cloud API key @@ -76,9 +76,9 @@ The final workflow should look like the following image. ![img](/media/tidb-cloud/integration-n8n-workflow-rss.jpg) -### (Optional) Create a TiDB Cloud Serverless Tier cluster +### (Optional) Create a TiDB Serverless cluster -If you don't have a TiDB Cloud Serverless Tier cluster, you can use this node to create one. Otherwise, feel free to skip this operation. +If you don't have a TiDB Serverless cluster, you can use this node to create one. Otherwise, feel free to skip this operation. 1. Navigate to **Workflows** panel, and click **Add workflow**. 2. In new workflow workspace, click **+** in the top right corner and choose **All** field. @@ -203,7 +203,7 @@ This trigger will execute your workflow every morning at 8 AM. After building up the workflow, you can click **Execute Workflow** to test run it. -If the workflow runs as expected, you'll get Hacker News briefing emails. These news contents will be logged to your TiDB Cloud Serverless Tier cluster, so you don't have to worry about losing them. +If the workflow runs as expected, you'll get Hacker News briefing emails. These news contents will be logged to your TiDB Serverless cluster, so you don't have to worry about losing them. Now you can activate this workflow in the **Workflows** panel. This workflow will help you get the front-page articles on Hacker News every day. @@ -213,7 +213,7 @@ Now you can activate this workflow in the **Workflows** panel. This workflow wil TiDB Cloud node acts as a [regular node](https://docs.n8n.io/workflows/nodes/#regular-nodes) and only supports the following five operations: -- **Create Serverless Cluster**: creates a TiDB Cloud Serverless Tier cluster. +- **Create Serverless Cluster**: creates a TiDB Serverless cluster. - **Execute SQL**: executes an SQL statement in TiDB. - **Delete**: deletes rows in TiDB. - **Insert**: inserts rows in TiDB. diff --git a/tidb-cloud/integrate-tidbcloud-with-netlify.md b/tidb-cloud/integrate-tidbcloud-with-netlify.md index 589def30932c4..22d63b8feb81e 100644 --- a/tidb-cloud/integrate-tidbcloud-with-netlify.md +++ b/tidb-cloud/integrate-tidbcloud-with-netlify.md @@ -28,9 +28,9 @@ One TiDB Cloud cluster can connect to multiple Netlify sites. ### All IP addresses allowed for traffic filter in TiDB Cloud -For Dedicated Tier clusters, make sure that the traffic filter of the cluster allows all IP addresses (set to `0.0.0.0/0`) for connection. This is because Netlify deployments use dynamic IP addresses. +For TiDB Dedicated clusters, make sure that the traffic filter of the cluster allows all IP addresses (set to `0.0.0.0/0`) for connection. This is because Netlify deployments use dynamic IP addresses. -Serverless Tier clusters allow all IP addresses for connection by default, so you do not need to configure any traffic filter. +TiDB Serverless clusters allow all IP addresses for connection by default, so you do not need to configure any traffic filter. ## Step 1. Get the example project and the connection string @@ -49,9 +49,9 @@ To help you get started quickly, TiDB Cloud provides a fullstack example app in ### Get the TiDB Cloud connection string -For a Serverless Tier cluster, you can get the connection string either from [TiDB Cloud CLI](/tidb-cloud/cli-reference.md) or from [TiDB Cloud console](https://tidbcloud.com/). +For a TiDB Serverless cluster, you can get the connection string either from [TiDB Cloud CLI](/tidb-cloud/cli-reference.md) or from [TiDB Cloud console](https://tidbcloud.com/). -For a Dedicated Tier cluster, you can get the connection string only from the TiDB Cloud console. +For a TiDB Dedicated cluster, you can get the connection string only from the TiDB Cloud console.
diff --git a/tidb-cloud/integrate-tidbcloud-with-vercel.md b/tidb-cloud/integrate-tidbcloud-with-vercel.md index 4c48a7920d407..8b041351ee60b 100644 --- a/tidb-cloud/integrate-tidbcloud-with-vercel.md +++ b/tidb-cloud/integrate-tidbcloud-with-vercel.md @@ -39,9 +39,9 @@ One TiDB Cloud cluster can connect to multiple Vercel projects. ### All IP addresses allowed for traffic filter in TiDB Cloud -For Dedicated Tier clusters, make sure that the traffic filter of the cluster allows all IP addresses (set to `0.0.0.0/0`) for connection, this is because Vercel deployments use [dynamic IP addresses](https://vercel.com/guides/how-to-allowlist-deployment-ip-address). If you use the TiDB Cloud Vercel integration, TiDB Cloud automatically adds a `0.0.0.0/0` traffic filter to your cluster in the integration workflow if there is none. +For TiDB Dedicated clusters, make sure that the traffic filter of the cluster allows all IP addresses (set to `0.0.0.0/0`) for connection, this is because Vercel deployments use [dynamic IP addresses](https://vercel.com/guides/how-to-allowlist-deployment-ip-address). If you use the TiDB Cloud Vercel integration, TiDB Cloud automatically adds a `0.0.0.0/0` traffic filter to your cluster in the integration workflow if there is none. -Serverless Tier clusters allow all IP addresses for connection by default, so you do not need to configure any traffic filter. +TiDB Serverless clusters allow all IP addresses for connection by default, so you do not need to configure any traffic filter. ## Connect via the TiDB Cloud Vercel integration @@ -74,7 +74,7 @@ TIDB_USER TIDB_PASSWORD ``` -For Dedicated Tier clusters, the root CA is set in this variable: +For TiDB Dedicated clusters, the root CA is set in this variable: ``` TIDB_SSL_CA @@ -92,13 +92,13 @@ DATABASE_URL > **Note:** > - > For Dedicated Tier clusters, make sure that you have set the **Allow Access from Anywhere** traffic filter in this step. + > For TiDB Dedicated clusters, make sure that you have set the **Allow Access from Anywhere** traffic filter in this step. 2. Go to your Vercel dashboard > Vercel project > **Settings** > **Environment Variables**, and then [declare each environment variable value](https://vercel.com/docs/concepts/projects/environment-variables#declare-an-environment-variable) according to the connection information of your TiDB cluster. ![Vercel Environment Variables](/media/tidb-cloud/integration-vercel-environment-variables.png) -Here we use a Prisma application as an example. The following is a datasource setting in the Prisma schema file for a TiDB Cloud Serverless Tier cluster: +Here we use a Prisma application as an example. The following is a datasource setting in the Prisma schema file for a TiDB Serverless cluster: ``` datasource db { diff --git a/tidb-cloud/integrate-tidbcloud-with-zapier.md b/tidb-cloud/integrate-tidbcloud-with-zapier.md index ce6fc309673b5..57b107dc1548d 100644 --- a/tidb-cloud/integrate-tidbcloud-with-zapier.md +++ b/tidb-cloud/integrate-tidbcloud-with-zapier.md @@ -27,7 +27,7 @@ Before you start, you need: - A [Zapier account](https://zapier.com/app/login). - A [GitHub account](https://github.com/login). -- A [TiDB Cloud account](https://tidbcloud.com/signup) and a Serverless Tier cluster on TiDB Cloud. For more details, see [TiDB Cloud Quick Start](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart#step-1-create-a-tidb-cluster). +- A [TiDB Cloud account](https://tidbcloud.com/signup) and a TiDB Serverless cluster on TiDB Cloud. For more details, see [TiDB Cloud Quick Start](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart#step-1-create-a-tidb-cluster). ### Step 1: Get the template @@ -160,16 +160,16 @@ The following table lists the actions supported by TiDB Cloud App. Note that som | Action | Description | Resource | |---|---|---| -| Find Cluster | Finds an existing Serverless tier or Dedicated tier. | None | -| Create Cluster | Creates a new cluster. Only supports creating a Serverless Tier cluster. | None | -| Find Database | Finds an existing database. | A Serverless Tier cluster | -| Create Database | Creates a new database. | A Serverless Tier cluster | -| Find Table | Finds an existing Table. | A Serverless Tier cluster and a database | -| Create Table | Creates a new table. | A Serverless Tier cluster and a database | -| Create Row | Creates a new row. | A Serverless Tier cluster, a database, and a table | -| Update Row | Updates an existing row. | A Serverless Tier cluster, a database, and a table | -| Find Row | Finds a row in a table via a lookup column. | A Serverless Tier cluster, a database, and a table | -| Find Row (Custom Query) | Finds a row in a table via a custom query the you provide. | A Serverless Tier cluster, a database, and a table | +| Find Cluster | Finds an existing TiDB Serverless or TiDB Dedicated cluster. | None | +| Create Cluster | Creates a new cluster. Only supports creating a TiDB Serverless cluster. | None | +| Find Database | Finds an existing database. | A TiDB Serverless cluster | +| Create Database | Creates a new database. | A TiDB Serverless cluster | +| Find Table | Finds an existing Table. | A TiDB Serverless cluster and a database | +| Create Table | Creates a new table. | A TiDB Serverless cluster and a database | +| Create Row | Creates a new row. | A TiDB Serverless cluster, a database, and a table | +| Update Row | Updates an existing row. | A TiDB Serverless cluster, a database, and a table | +| Find Row | Finds a row in a table via a lookup column. | A TiDB Serverless cluster, a database, and a table | +| Find Row (Custom Query) | Finds a row in a table via a custom query the you provide. | A TiDB Serverless cluster, a database, and a table | ## TiDB Cloud App templates diff --git a/tidb-cloud/limitations-and-quotas.md b/tidb-cloud/limitations-and-quotas.md index 1850a15c8541d..77956a759c0e3 100644 --- a/tidb-cloud/limitations-and-quotas.md +++ b/tidb-cloud/limitations-and-quotas.md @@ -1,11 +1,11 @@ --- -title: Dedicated Tier Limitations and Quotas +title: TiDB Dedicated Limitations and Quotas summary: Learn the limitations and quotas in TiDB Cloud. --- -# Dedicated Tier Limitations and Quotas +# TiDB Dedicated Limitations and Quotas -TiDB Cloud limits how many of each kind of component you can create in a [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) cluster, and the common usage limitations of TiDB. In addition, there are some organization-level quotas to limit the amount of resources created by users to prevent from creating more resources than you actually need. These tables outline limits and quotas. +TiDB Cloud limits how many of each kind of component you can create in a [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster, and the common usage limitations of TiDB. In addition, there are some organization-level quotas to limit the amount of resources created by users to prevent from creating more resources than you actually need. These tables outline limits and quotas. > **Note:** > diff --git a/tidb-cloud/manage-serverless-spend-limit.md b/tidb-cloud/manage-serverless-spend-limit.md index bfcb1c9dd21b3..92a9b88ea86c7 100644 --- a/tidb-cloud/manage-serverless-spend-limit.md +++ b/tidb-cloud/manage-serverless-spend-limit.md @@ -1,34 +1,34 @@ --- -title: Manage Spend Limit for Serverless Tier clusters -summary: Learn how to manage spend limit for your Serverless Tier clusters. +title: Manage Spend Limit for TiDB Serverless clusters +summary: Learn how to manage spend limit for your TiDB Serverless clusters. --- -# Manage Spend Limit for Serverless Tier Clusters +# Manage Spend Limit for TiDB Serverless Clusters > **Note:** > -> The spend limit is only applicable to Serverless Tier clusters. +> The spend limit is only applicable to TiDB Serverless clusters. -Spend limit refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that allows you to set a budget for your Serverless Tier clusters. +Spend limit refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that allows you to set a budget for your TiDB Serverless clusters. -For each organization in TiDB Cloud, you can create a maximum of five Serverless Tier clusters by default. To create more Serverless Tier clusters, you need to add a credit card and set a spend limit for the usage. But if you delete some of your previous clusters before creating more, the new cluster can still be created without a credit card. +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 for the usage. But if you delete some of your previous clusters before creating more, the new cluster can still be created without a credit card. ## Usage quota -For the first five Serverless Tier clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: +For the first five TiDB Serverless clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: - Row storage: 5 GiB - [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit): 50 million RUs per month Once the free quota of a cluster is reached, the read and write operations on this cluster will be throttled until you [increase the quota](#update-spend-limit) or the usage is reset upon the start of a new month. For example, when the storage of a cluster exceeds 5 GiB, the maximum size limit of a single transaction is reduced from 10 MiB to 1 MiB. -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 Cloud Serverless Tier Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). +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 Serverless Tier 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 cluster](/tidb-cloud/create-tidb-cluster.md#step-4-create-a-tidb-cluster). ## Update spend limit -For an existing Serverless Tier cluster, you can increase the usage quota by updating the spend limit as follows: +For an existing TiDB Serverless cluster, you can increase the usage quota by updating the spend limit as follows: 1. In the TiDB Cloud console, click the ☰ hover menu in the upper-left corner, and then click the name of your target cluster to go to its overview page. diff --git a/tidb-cloud/migrate-from-mysql-using-aws-dms.md b/tidb-cloud/migrate-from-mysql-using-aws-dms.md index e28931ee63c86..70e14bce6bf53 100644 --- a/tidb-cloud/migrate-from-mysql-using-aws-dms.md +++ b/tidb-cloud/migrate-from-mysql-using-aws-dms.md @@ -11,7 +11,7 @@ AWS DMS is a cloud service that makes it easy to migrate relational databases, d This document uses Amazon RDS as an example to show how to migrate data to TiDB Cloud using AWS DMS. The procedure also applies to migrating data from self-hosted MySQL databases or Amazon Aurora to TiDB Cloud. -In this example, the data source is Amazon RDS, and the data destination is a Dedicated Tier cluster in TiDB Cloud. Both upstream and downstream databases are in the same region. +In this example, the data source is Amazon RDS, and the data destination is a TiDB Dedicated cluster in TiDB Cloud. Both upstream and downstream databases are in the same region. ## Prerequisites @@ -19,7 +19,7 @@ Before you start the migration, make sure you have read the following: - If the source database is Amazon RDS or Amazon Aurora, you need to set the `binlog_format` parameter to `ROW`. If the database uses the default parameter group, the `binlog_format` parameter is `MIXED` by default and cannot be modified. In this case, you need to [create a new parameter group](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_GettingStarted.Prerequisites.html#CHAP_GettingStarted.Prerequisites.params), for example `newset`, and set its `binlog_format` to `ROW`. Then, [modify the default parameter group](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithDBInstanceParamGroups.html#USER_WorkingWithParamGroups.Modifying) to `newset`. Note that modifying the parameter group will restart the database. - Check and ensure that the source database uses collations that are compatible with TiDB. The default collation for the utf8mb4 character set in TiDB is `utf8mb4_bin`. But in MySQL 8.0, the default collation is `utf8mb4_0900_ai_ci`. If the upstream MySQL uses the default collation, because TiDB is not compatible with `utf8mb4_0900_ai_ci`, AWS DMS cannot create the target tables in TiDB and cannot migrate the data. To resolve this problem, you need to modify the collation of the source database to `utf8mb4_bin` before the migration. For a complete list of TiDB supported character sets and collations, see [Character Set and Collation](https://docs.pingcap.com/tidb/stable/character-set-and-collation). -- TiDB contains the following system databases by default: `INFORMATION_SCHEMA`, `PERFORMANCE_SCHEMA`, `mysql`, `sys`, and `test`. When you create an AWS DMS migration task, you need to filter out these system databases instead of using the default `%` to select the migration object. Otherwise, AWS DMS will try to migrate these system databases from the source database to the target TiDB, which will cause the task to fail. To avoid this issue, it is recommended to fill in the specific database and table names. +- TiDB contains the following system databases by default: `INFORMATION_SCHEMA`, `PERFORMANCE_SCHEMA`, `mysql`, `sys`, and `test`. When you create an AWS DMS migration task, you need to filter out these system databases instead of using the default `%` to select the migration object. Otherwise, AWS DMS will try to migrate these system databases from the source database to the target TiDB, which will cause the task to fail. To avoid this issue, it is recommended to fill in the specific database and table names. - Add the public and private network IP addresses of AWS DMS to the IP access lists of both source and target databases. Otherwise, the network connection might fail in some scenarios. - Use [VPC Peerings](/tidb-cloud/set-up-vpc-peering-connections.md#set-up-vpc-peering-on-aws) or [Private Endpoint connections](/tidb-cloud/set-up-private-endpoint-connections.md) to connect AWS DMS and the TiDB cluster. - It is recommended to use the same region for AWS DMS and the TiDB cluster to get better data writing performance. @@ -38,7 +38,7 @@ AWS DMS does not support replicating `DROP TABLE`. ![Create replication instance](/media/tidb-cloud/aws-dms-tidb-cloud/aws-dms-to-tidb-cloud-create-instance.png) -3. Fill in an instance name, ARN, and description. +3. Fill in an instance name, ARN, and description. 4. Fill in the instance configuration: - **Instance class**: select an appropriate instance class. It is recommended to use `dms.t3.large` or a higher instance class to get better performance. @@ -48,9 +48,9 @@ AWS DMS does not support replicating `DROP TABLE`. 5. Configure the storage in the **Allocated storage (GiB)** field. Use the default configuration. 6. Configure connectivity and security. - - **Network type - new**: select **IPv4**. + - **Network type - new**: select **IPv4**. - **Virtual private cloud (VPC) for IPv4**: select the VPC that you need. It is recommended to use the same VPC as the upstream database to simplify the network configuration. - - **Replication subnet group**: choose a subnet group for your replication instance. + - **Replication subnet group**: choose a subnet group for your replication instance. - **Public accessible**: use the default configuration. 7. Configure the **Advanced settings**, **Maintenance**, and **Tags** if needed. Click **Create replication instance** to finish the instance creation. @@ -182,4 +182,4 @@ If you encounter any issues or failures during the migration, you can check the - If you want to migrate from MySQL-compatible databases, such as Aurora MySQL and Amazon Relational Database Service (RDS), to TiDB Cloud, it is recommended to use [Data Migration on TiDB Cloud](/tidb-cloud/migrate-from-mysql-using-data-migration.md). -- If you want to migrate from Amazon RDS for Oracle to TiDB Cloud Serverless Tier Using AWS DMS, see [Migrate from Amazon RDS for Oracle to TiDB Cloud Serverless Tier Using AWS DMS](/tidb-cloud/migrate-from-oracle-using-aws-dms.md). +- If you want to migrate from Amazon RDS for Oracle to TiDB Serverless Using AWS DMS, see [Migrate from Amazon RDS for Oracle to TiDB Serverless Using AWS DMS](/tidb-cloud/migrate-from-oracle-using-aws-dms.md). diff --git a/tidb-cloud/migrate-from-mysql-using-data-migration.md b/tidb-cloud/migrate-from-mysql-using-data-migration.md index ed813e26ff2ef..cbb9012705d97 100644 --- a/tidb-cloud/migrate-from-mysql-using-data-migration.md +++ b/tidb-cloud/migrate-from-mysql-using-data-migration.md @@ -13,7 +13,7 @@ If you want to migrate incremental data only, see [Migrate Incremental Data from ## Limitations -- The Data Migration feature is available only for **Dedicated Tier** clusters. +- The Data Migration feature is available only for **TiDB Dedicated** clusters. - The Data Migration feature is only available to clusters in the projects that are created in the following regions after November 9, 2022. If your **project** was created before the date or if your cluster is in another region, this feature is not available to your cluster and the **Data Migration** tab will not be displayed on the cluster overview page in the TiDB Cloud console. @@ -141,7 +141,7 @@ If your MySQL service is in an GCP VPC, take the following steps: 3. Modify the ingress firewall rules of the VPC where MySQL is located. - You must add [the CIDR of the region where your TiDB Cloud cluster is located](/tidb-cloud/set-up-vpc-peering-connections.md#prerequisite-set-a-project-cidr) to the ingress firewall rules. This allows the traffic to flow from your TiDB cluster to the MySQL endpoint. + You must add [the CIDR of the region where your TiDB Cloud cluster is located](/tidb-cloud/set-up-vpc-peering-connections.md#prerequisite-set-a-project-cidr) to the ingress firewall rules. This allows the traffic to flow from your TiDB cluster to the MySQL endpoint. @@ -282,7 +282,7 @@ When scaling a migration job specification, note the following: - You can only scale a migration job specification when the job is in the **Running** or **Paused** status. - TiDB Cloud does not support scaling a migration job specification during the existing data export stage. - Scaling a migration job specification will restart the job. If a source table of the job does not have a primary key, duplicate data might be inserted. -- During scaling, do not purge the binary log of the source database or increase `expire_logs_days` of the upstream database temporarily. Otherwise, the job might fail because it cannot get the continuous binary log position. +- During scaling, do not purge the binary log of the source database or increase `expire_logs_days` of the upstream database temporarily. Otherwise, the job might fail because it cannot get the continuous binary log position. ### Scaling procedure diff --git a/tidb-cloud/migrate-from-op-tidb.md b/tidb-cloud/migrate-from-op-tidb.md index bc06d99965f02..25b9c5b3df528 100644 --- a/tidb-cloud/migrate-from-op-tidb.md +++ b/tidb-cloud/migrate-from-op-tidb.md @@ -1,17 +1,17 @@ --- -title: Migrate from On-Premises TiDB to TiDB Cloud -summary: Learn how to migrate data from on-premises TiDB to TiDB Cloud. +title: Migrate from TiDB Self-Hosted to TiDB Cloud +summary: Learn how to migrate data from TiDB Self-Hosted to TiDB Cloud. --- -# Migrate from On-Premises TiDB to TiDB Cloud +# Migrate from TiDB Self-Hosted to TiDB Cloud -This document describes how to migrate data from your on-premises (OP) TiDB clusters to TiDB Cloud (AWS) through Dumpling and TiCDC. +This document describes how to migrate data from your TiDB Self-Hosted clusters to TiDB Cloud (AWS) through Dumpling and TiCDC. The overall procedure is as follows: 1. Build the environment and prepare the tools. 2. Migrate full data. The process is as follows: - 1. Export data from OP TiDB to Amazon S3 using Dumpling. + 1. Export data from TiDB Self-Hosted to Amazon S3 using Dumpling. 2. Import data from Amazon S3 to TiDB Cloud. 3. Replicate incremental data by using TiCDC. 4. Verify the migrated data. @@ -35,7 +35,7 @@ You need to prepare the following tools: ### Dumpling -[Dumpling](https://docs.pingcap.com/tidb/dev/dumpling-overview) is a tool that exports data from TiDB or MySQL into SQL or CSV files. You can use Dumpling to export full data from OP TiDB. +[Dumpling](https://docs.pingcap.com/tidb/dev/dumpling-overview) is a tool that exports data from TiDB or MySQL into SQL or CSV files. You can use Dumpling to export full data from TiDB Self-Hosted. Before you deploy Dumpling, note the following: @@ -102,18 +102,18 @@ You need to [deploy TiCDC](https://docs.pingcap.com/tidb/dev/deploy-ticdc) to re ## Migrate full data -To migrate data from the OP TiDB cluster to TiDB Cloud, perform a full data migration as follows: +To migrate data from the TiDB Self-Hosted cluster to TiDB Cloud, perform a full data migration as follows: -1. Migrate data from the OP TiDB cluster to Amazon S3. +1. Migrate data from the TiDB Self-Hosted cluster to Amazon S3. 2. Migrate data from Amazon S3 to TiDB Cloud. -### Migrate data from the OP TiDB cluster to Amazon S3 +### Migrate data from the TiDB Self-Hosted cluster to Amazon S3 -You need to migrate data from the OP TiDB cluster to Amazon S3 using Dumpling. +You need to migrate data from the TiDB Self-Hosted cluster to Amazon S3 using Dumpling. If your TiDB cluster is in a local IDC, or the network between the Dumpling server and Amazon S3 is not connected, you can export the files to the local storage first, and then upload them to Amazon S3 later. -#### Step 1. Disable the GC mechanism of the upstream OP TiDB cluster temporarily +#### Step 1. Disable the GC mechanism of the upstream TiDB Self-Hosted cluster temporarily To ensure that newly written data is not lost during incremental migration, you need to disable the upstream cluster's garbage collection (GC) mechanism before starting the migration to prevent the system from cleaning up historical data. @@ -199,7 +199,7 @@ Do the following to export data from the upstream TiDB cluster to Amazon S3 usin ### Migrate data from Amazon S3 to TiDB Cloud -After you export data from the OP TiDB cluster to Amazon S3, you need to migrate the data to TiDB Cloud. +After you export data from the TiDB Self-Hosted cluster to Amazon S3, you need to migrate the data to TiDB Cloud. 1. Get the Account ID and External ID of the cluster in the TiDB Cloud console. For more information, see [Step 2. Configure Amazon S3 access](/tidb-cloud/tidb-cloud-auditing.md#step-2-configure-amazon-s3-access). diff --git a/tidb-cloud/migrate-from-oracle-using-aws-dms.md b/tidb-cloud/migrate-from-oracle-using-aws-dms.md index 13f3a02d91dd9..5c5aa34e4bd26 100644 --- a/tidb-cloud/migrate-from-oracle-using-aws-dms.md +++ b/tidb-cloud/migrate-from-oracle-using-aws-dms.md @@ -1,11 +1,11 @@ --- title: Migrate from Amazon RDS for Oracle to TiDB Cloud Using AWS DMS -summary: Learn how to migrate data from Amazon RDS for Oracle into TiDB Cloud Serverless Tier using AWS Database Migration Service (AWS DMS). +summary: Learn how to migrate data from Amazon RDS for Oracle into TiDB Serverless using AWS Database Migration Service (AWS DMS). --- # Migrate from Amazon RDS for Oracle to TiDB Cloud Using AWS DMS -This document describes a step-by-step example of how to migrate data from Amazon RDS for Oracle to [TiDB Cloud Serverless Tier](https://tidbcloud.com/console/clusters/create-cluster) using AWS Database Migration Service (AWS DMS). +This document describes a step-by-step example of how to migrate data from Amazon RDS for Oracle to [TiDB Serverless](https://tidbcloud.com/console/clusters/create-cluster) using AWS Database Migration Service (AWS DMS). If you are interested in learning more about TiDB Cloud and AWS DMS, see the following: @@ -24,7 +24,7 @@ If you want to migrate data from heterogeneous databases, such as PostgreSQL, Or At a high level, follow the following steps: 1. Set up the source Amazon RDS for Oracle. -2. Set up the target [TiDB Cloud Serverless Tier](https://tidbcloud.com/console/clusters/create-cluster). +2. Set up the target [TiDB Serverless](https://tidbcloud.com/console/clusters/create-cluster). 3. Set up data migration (full load) using AWS DMS. The following diagram illustrates the high-level architecture. @@ -69,11 +69,11 @@ After you finish executing the SQL script, check the data in Oracle. The followi ![Oracle RDS Data](/media/tidb-cloud/aws-dms-from-oracle-to-tidb-3.png) -## Step 4. Create a TiDB Cloud Serverless Tier cluster +## Step 4. Create a TiDB Serverless cluster 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/console/clusters). -2. [Create a Serverless Tier cluster](/tidb-cloud/tidb-cloud-quickstart.md). +2. [Create a TiDB Serverless cluster](/tidb-cloud/tidb-cloud-quickstart.md). 3. In the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the target cluster name to go to its overview page. @@ -133,7 +133,7 @@ For more information, see [Migrating your source schema to your target database ## Step 9. Check data in the downstream TiDB cluster -Connect to the [Serverless Tier cluster](https://tidbcloud.com/console/clusters/create-cluster) and check the `admin.github_event` table data. As shown in the following screenshot, DMS successfully migrated table `github_events` and 10000 rows of data. +Connect to the [TiDB Serverless cluster](https://tidbcloud.com/console/clusters/create-cluster) and check the `admin.github_event` table data. As shown in the following screenshot, DMS successfully migrated table `github_events` and 10000 rows of data. ![Check Data In TiDB](/media/tidb-cloud/aws-dms-from-oracle-to-tidb-14.png) diff --git a/tidb-cloud/monitor-built-in-alerting.md b/tidb-cloud/monitor-built-in-alerting.md index dfe7e4919b759..11ac7c5053051 100644 --- a/tidb-cloud/monitor-built-in-alerting.md +++ b/tidb-cloud/monitor-built-in-alerting.md @@ -11,7 +11,7 @@ This document describes how to do these operations and provides the TiDB Cloud b > **Note:** > -> Currently, the alert feature is only available for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +> Currently, the alert feature is only available for [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. ## View alerts @@ -25,16 +25,16 @@ In TiDB Cloud, you can view both active and closed alerts on the Alerts page. 2. Click the name of the target cluster. The cluster overview page is displayed. 3. Click **Alerts** in the left navigation pane. -4. The **Alerts** page displays the active alerts by default. You can view the information of each active alert such as the alert name, trigger time, and duration. +4. The **Alerts** page displays the active alerts by default. You can view the information of each active alert such as the alert name, trigger time, and duration. 5. If you also want to view the closed alerts, just click the **Status** drop-down list and select **Closed** or **All**. ## Edit alert rules In TiDB Cloud, you can edit the alert rules by disabling or enabling the alerts or updating the alert threshold. -1. On the **Alerts** page, click **Edit Rules**. +1. On the **Alerts** page, click **Edit Rules**. 2. Disable or enable alert rules as needed. -3. Click **Edit** to update the threshold of an alert rule. +3. Click **Edit** to update the threshold of an alert rule. > **Tip:** > @@ -44,12 +44,12 @@ In TiDB Cloud, you can edit the alert rules by disabling or enabling the alerts To get alert notification emails of clusters in your project, take the following steps: -1. On the **Alerts** page , click **Subscribe Alerts**. -2. Enter your email address, and then click **Subscribe**. +1. On the **Alerts** page , click **Subscribe Alerts**. +2. Enter your email address, and then click **Subscribe**. > **Tip:** > - > The alert subscription is for all alerts in the current project. If you have multiple clusters in the project, you just need to subscribe once. + > The alert subscription is for all alerts in the current project. If you have multiple clusters in the project, you just need to subscribe once. Alternatively, you can also add the subscription from the **Alert Subscription** page as follows: diff --git a/tidb-cloud/monitor-datadog-integration.md b/tidb-cloud/monitor-datadog-integration.md index bb52f03346252..7ad6916e2638c 100644 --- a/tidb-cloud/monitor-datadog-integration.md +++ b/tidb-cloud/monitor-datadog-integration.md @@ -17,7 +17,7 @@ You can configure TiDB Cloud to send metric data about your TiDB clusters to [Da ## Limitation -- You cannot use the Datadog integration in [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- You cannot use the Datadog integration in [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. - Datadog integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**. diff --git a/tidb-cloud/monitor-new-relic-integration.md b/tidb-cloud/monitor-new-relic-integration.md index d714d1c42b55c..c0e58f0751979 100644 --- a/tidb-cloud/monitor-new-relic-integration.md +++ b/tidb-cloud/monitor-new-relic-integration.md @@ -17,7 +17,7 @@ You can configure TiDB Cloud to send metric data of your TiDB clusters to [New R ## Limitation -You cannot use the New Relic integration in [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). +You cannot use the New Relic integration in [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). ## Steps diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index f3bf348b4f6fa..25aafa30a9489 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -17,7 +17,7 @@ This document describes how to configure your Prometheus service to read key met ## Limitation -- You cannot use the Prometheus and Grafana integration in [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- You cannot use the Prometheus and Grafana integration in [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. - Prometheus and Grafana integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**. diff --git a/tidb-cloud/monitor-tidb-cluster.md b/tidb-cloud/monitor-tidb-cluster.md index a6bb49fe6a776..2b6076806cec0 100644 --- a/tidb-cloud/monitor-tidb-cluster.md +++ b/tidb-cloud/monitor-tidb-cluster.md @@ -29,7 +29,7 @@ You can see the current status of each running cluster on the cluster page. > **Note:** > -> The TiDB node status is only available for Dedicated Tier clusters. +> The TiDB node status is only available for TiDB Dedicated clusters. | TiDB node status | Description | |:--|:--| @@ -42,7 +42,7 @@ You can see the current status of each running cluster on the cluster page. > **Note:** > -> The TiKV node status is only available for Dedicated Tier clusters. +> The TiKV node status is only available for TiDB Dedicated clusters. | TiKV node status | Description | |:--|:--| @@ -64,7 +64,7 @@ The cluster overview page provides general metrics of a cluster, including total > **Note:** > -> Some of these metrics might be available only for Dedicated Tier clusters. +> Some of these metrics might be available only for TiDB Dedicated clusters. To view metrics on the cluster overview page, take the following steps: @@ -78,7 +78,7 @@ The cluster monitoring page provides a full set of standard metrics of a cluster > **Note:** > -> Currently, the cluster monitoring page is unavailable for [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). +> Currently, the cluster monitoring page is unavailable for [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). To view metrics on the cluster monitoring page, take the following steps: diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index 60d0c69fabde3..b31f770411dc5 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -13,7 +13,7 @@ Comparing with backup and restore, pausing and resuming a cluster takes less tim > **Note:** > -> You cannot pause a [Serverless Tier cluster](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). +> You cannot pause a [TiDB Serverless cluster](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). ## Limitations diff --git a/tidb-cloud/release-notes-2021.md b/tidb-cloud/release-notes-2021.md index fb2703ab1f1f7..3a378cfdc370d 100644 --- a/tidb-cloud/release-notes-2021.md +++ b/tidb-cloud/release-notes-2021.md @@ -40,7 +40,7 @@ Bug fixes: ## November 8, 2021 -* Launch [Developer Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta), which offers you a one-year free trial of TiDB Cloud +* Launch [Developer Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), which offers you a one-year free trial of TiDB Cloud Each Developer Tier cluster is a full-featured TiDB cluster and comes with the following: diff --git a/tidb-cloud/release-notes-2022.md b/tidb-cloud/release-notes-2022.md index 4809b7e4c6cc7..7ca10c3e6ae00 100644 --- a/tidb-cloud/release-notes-2022.md +++ b/tidb-cloud/release-notes-2022.md @@ -11,13 +11,13 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Currently, after upgrading the default TiDB version of all [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters from [v6.3.0](https://docs.pingcap.com/tidb/v6.3/release-6.3.0) to [v6.4.0](https://docs.pingcap.com/tidb/v6.4/release-6.4.0), the cold start becomes slower in certain circumstances. So we roll back the default TiDB version of all Serverless Tier clusters from v6.4.0 to v6.3.0, then fix the problem as soon as possible, and upgrade it later again. +- Currently, after upgrading the default TiDB version of all [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters from [v6.3.0](https://docs.pingcap.com/tidb/v6.3/release-6.3.0) to [v6.4.0](https://docs.pingcap.com/tidb/v6.4/release-6.4.0), the cold start becomes slower in certain circumstances. So we roll back the default TiDB version of all Serverless Tier clusters from v6.4.0 to v6.3.0, then fix the problem as soon as possible, and upgrade it later again. ## December 27, 2022 **General changes** -- Upgrade the default TiDB version of all [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters from [v6.3.0](https://docs.pingcap.com/tidb/v6.3/release-6.3.0) to [v6.4.0](https://docs.pingcap.com/tidb/v6.4/release-6.4.0). +- Upgrade the default TiDB version of all [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters from [v6.3.0](https://docs.pingcap.com/tidb/v6.3/release-6.3.0) to [v6.4.0](https://docs.pingcap.com/tidb/v6.4/release-6.4.0). - The point-in-time recovery (PITR) for Dedicated Tier clusters is now in General Availability (GA). @@ -100,7 +100,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters from [v6.1.2](https://docs.pingcap.com/tidb/stable/release-6.1.2) to [v6.1.3](https://docs.pingcap.com/tidb/stable/release-6.1.3). +- Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters from [v6.1.2](https://docs.pingcap.com/tidb/stable/release-6.1.2) to [v6.1.3](https://docs.pingcap.com/tidb/stable/release-6.1.3). ## November 29, 2022 @@ -122,7 +122,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c In addition, Data Migration provides full and incremental data migration capabilities to migrate both existing data and ongoing changes from your data source to TiDB Cloud. - Currently, the Data Migration feature is still **in beta**. It is available only for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters and only in the AWS Oregon (us-west-2) and AWS Singapore (ap-southeast-1) regions. You can create one migration job for free for each organization. To create multiple migration jobs for an organization, you need to [file a ticket](/tidb-cloud/tidb-cloud-support.md). + Currently, the Data Migration feature is still **in beta**. It is available only for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters and only in the AWS Oregon (us-west-2) and AWS Singapore (ap-southeast-1) regions. You can create one migration job for free for each organization. To create multiple migration jobs for an organization, you need to [file a ticket](/tidb-cloud/tidb-cloud-support.md). For detailed information, see [Migrate MySQL-Compatible Databases to TiDB Cloud Using Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md). @@ -130,7 +130,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -* Support point-in-time recovery (PITR) for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters (beta). +* Support point-in-time recovery (PITR) for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters (beta). PITR supports restoring data of any point in time to a new cluster. You can use it to: @@ -169,7 +169,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -* Developer Tier is upgraded to [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). Serverless Tier, a fully-managed, auto-scaling deployment of TiDB, is now available. It is still in beta and free to use. +* Developer Tier is upgraded to [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). Serverless Tier, a fully-managed, auto-scaling deployment of TiDB, is now available. It is still in beta and free to use. * A Serverless Tier cluster still contains fully functional HTAP ability as Dedicated Tier clusters. * Serverless Tier offers you faster cluster creation time and instantaneous cold start time. Compared with Developer Tier, the creation time reduces from minutes to seconds. @@ -211,7 +211,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - [`tidb_prepared_plan_cache_size`](/system-variables.md#tidb_prepared_plan_cache_size-new-in-v610) - [`tidb_query_log_max_len`](/system-variables.md#tidb_query_log_max_len) -- Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters from [v6.1.1](https://docs.pingcap.com/tidb/stable/release-6.1.1) to [v6.1.2](https://docs.pingcap.com/tidb/stable/release-6.1.2). +- Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters from [v6.1.1](https://docs.pingcap.com/tidb/stable/release-6.1.1) to [v6.1.2](https://docs.pingcap.com/tidb/stable/release-6.1.2). ## October 19, 2022 @@ -247,7 +247,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -* Upgrade the default TiDB version of new [Developer Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters from [v6.2.0](https://docs.pingcap.com/tidb/v6.2/release-6.2.0) to [v6.3.0](https://docs.pingcap.com/tidb/v6.3/release-6.3.0). +* Upgrade the default TiDB version of new [Developer Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters from [v6.2.0](https://docs.pingcap.com/tidb/v6.2/release-6.2.0) to [v6.3.0](https://docs.pingcap.com/tidb/v6.3/release-6.3.0). **Console changes** @@ -298,7 +298,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -* Support connecting to TiDB Cloud [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters via TLS. +* Support connecting to TiDB Cloud [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters via TLS. For Dedicated Tier clusters, the **Standard Connection** tab in the [Connect](/tidb-cloud/connect-via-standard-connection.md) dialog now provides a link to download the TiDB cluster CA and also provides the connection string and sample code for TLS connection. You can [connect to your Dedicated Tier cluster via TLS](/tidb-cloud/connect-via-standard-connection.md) using third-party MySQL clients, MyCLI, and multiple connection methods for your applications, such as JDBC, Python, Go, and Node.js. This feature ensures the security of data transmission from your applications to TiDB clusters. @@ -310,7 +310,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c In the new design, the entrances of upgrade to Dedicated Tier, cluster connection, and data import are highlighted. -* Introduce Playground for [Developer Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +* Introduce Playground for [Developer Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. Playground contains a pre-loaded dataset of GitHub events, which allows you to get started with TiDB Cloud by running queries instantly, without importing your data or connecting to a client. @@ -318,7 +318,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -* Support a new Google Cloud region for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters: `N. Virginia (us-east4)`. +* Support a new Google Cloud region for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters: `N. Virginia (us-east4)`. ## September 9, 2022 @@ -332,7 +332,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -* Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters from [v6.1.0](https://docs.pingcap.com/tidb/stable/release-6.1.0) to [v6.1.1](https://docs.pingcap.com/tidb/stable/release-6.1.1). +* Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters from [v6.1.0](https://docs.pingcap.com/tidb/stable/release-6.1.0) to [v6.1.1](https://docs.pingcap.com/tidb/stable/release-6.1.1). **Console changes** @@ -350,7 +350,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -* Support AWS PrivateLink-powered endpoint connection as a new network access management option for TiDB Cloud [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +* Support AWS PrivateLink-powered endpoint connection as a new network access management option for TiDB Cloud [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. 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. @@ -358,7 +358,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -* Provide sample connection strings of MySQL, MyCLI, JDBC, Python, Go, and Node.js in the **VPC Peering** tab and **Private Endpoint** tab of the [Connect](/tidb-cloud/connect-to-tidb-cluster.md) dialog for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +* Provide sample connection strings of MySQL, MyCLI, JDBC, Python, Go, and Node.js in the **VPC Peering** tab and **Private Endpoint** tab of the [Connect](/tidb-cloud/connect-to-tidb-cluster.md) dialog for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. You can easily connect to your Dedicated Tier cluster by simply copying and pasting the connection codes to your apps. @@ -374,7 +374,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -* Upgrade the default TiDB version of new [Developer Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters from [v6.1.0](https://docs.pingcap.com/tidb/stable/release-6.1.0) to [v6.2.0](https://docs.pingcap.com/tidb/v6.2/release-6.2.0). +* Upgrade the default TiDB version of new [Developer Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters from [v6.1.0](https://docs.pingcap.com/tidb/stable/release-6.1.0) to [v6.2.0](https://docs.pingcap.com/tidb/v6.2/release-6.2.0). **API changes** @@ -405,7 +405,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c ## August 9, 2022 -* Add the support of the GCP region `Osaka` for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) cluster creation. +* Add the support of the GCP region `Osaka` for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster creation. ## August 2, 2022 @@ -418,7 +418,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c * PoC and staging environments * Development environments -* Add a [Monitoring page](/tidb-cloud/built-in-monitoring.md) to the **Diagnosis** tab for [Dedicated Tier clusters](/tidb-cloud/select-cluster-tier.md#dedicated-tier). +* Add a [Monitoring page](/tidb-cloud/built-in-monitoring.md) to the **Diagnosis** tab for [Dedicated Tier clusters](/tidb-cloud/select-cluster-tier.md#tidb-dedicated). The Monitoring page provides a system-level entry for overall performance diagnosis. According to the top-down performance analysis methodology, the Monitoring page organizes TiDB performance metrics based on database time breakdown and displays these metrics in different colors. By checking these colors, you can identify performance bottlenecks of the entire system at the first glance, which significantly reduces performance diagnosis time and simplifies performance analysis and diagnosis. @@ -441,19 +441,19 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c ## July 26, 2022 -* Support automatic hibernation and resuming for new [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). +* Support automatic hibernation and resuming for new [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). A Developer Tier cluster will not be deleted after 7 days of inactivity so you can still use it at any time until the one-year free trial ends. After 24 hours of inactivity, the Developer Tier cluster will hibernate automatically. To resume the cluster, either send a new connection to the cluster or click the **Resume** button in the TiDB Cloud console. The cluster will be resumed within 50 seconds and back to service automatically. -* Add a user name prefix limitation for new [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). +* Add a user name prefix limitation for new [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). Whenever you use or set a database user name, you must include the prefix for your cluster in the user name. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). -* Disable the backup and restore feature for [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). +* Disable the backup and restore feature for [Developer Tier clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). The backup and restore feature (including both automatic backup and manual backup) is disabled for Developer Tier clusters. You can still use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export your data as a backup. -* Increase the storage size of a [Developer Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster from 500 MiB to 1 GiB. +* Increase the storage size of a [Developer Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster from 500 MiB to 1 GiB. * Add breadcrumbs to the TiDB Cloud console to improve the navigation experience. * Support configuring multiple filter rules when you import data into TiDB Cloud. * Remove the **Traffic Filters** page from **Project Settings**, and remove the **Add Rules from Default Set** button from the **Connect to TiDB** dialog. @@ -495,7 +495,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c ## June 21, 2022 -* Add the support of the GCP region `Taiwan` for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) cluster creation. +* Add the support of the GCP region `Taiwan` for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster creation. * Support [updating user profiles](/tidb-cloud/manage-user-access.md#manage-user-profiles) in the TiDB Cloud console, including first name, last time, company name, country, and phone number. * Provide the connection strings for MySQL, MyCLI, JDBC, Python, Go, and Node.js in the [**Connect to TiDB**](/tidb-cloud/connect-via-standard-connection.md) dialog so you can easily connect to your TiDB cluster. * Support obtaining bucket regions from bucket URIs automatically during data import to save your effort to fill in such information. @@ -526,7 +526,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c ## May 19, 2022 -* Add the support of the AWS region `Frankfurt` for [Developer Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster creation. +* Add the support of the AWS region `Frankfurt` for [Developer Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster creation. ## May 18, 2022 @@ -538,7 +538,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c ## May 1, 2022 -* Support configuring vCPU size of TiDB, TiKV, and TiFlash when you [create](/tidb-cloud/create-tidb-cluster.md) or [restore](/tidb-cloud/backup-and-restore.md#restore) a [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) cluster. +* Support configuring vCPU size of TiDB, TiKV, and TiFlash when you [create](/tidb-cloud/create-tidb-cluster.md) or [restore](/tidb-cloud/backup-and-restore.md#restore) a [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster. * Add the support of the AWS region `Mumbai` for cluster creation. * Update the compute, storage, and data transfer cost for [TiDB Cloud billing](/tidb-cloud/tidb-cloud-billing.md). @@ -550,9 +550,9 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c TiDB Cloud is now in General Availability. You can [sign up](https://tidbcloud.com/signup) and select one of the following options: -* Get started with [Developer Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) for free. +* Get started with [Developer Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) for free. * Apply for [a 14-day PoC trial for free](https://en.pingcap.com/apply-for-poc/). -* Get full access with [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier). +* Get full access with [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated). ## March 25, 2022 @@ -615,4 +615,4 @@ Improvement: Bug fixes: * Fix the issue that a user cannot create a cluster if the password contains a single quote. -* Fix the issue that even an organization only has one owner, the owner can be deleted or changed to another role. +* Fix the issue that even an organization only has one owner, the owner can be deleted or changed to another role. \ No newline at end of file diff --git a/tidb-cloud/scale-tidb-cluster.md b/tidb-cloud/scale-tidb-cluster.md index 75b9ed99795e4..951547671ff05 100644 --- a/tidb-cloud/scale-tidb-cluster.md +++ b/tidb-cloud/scale-tidb-cluster.md @@ -7,7 +7,7 @@ summary: Learn how to scale your TiDB Cloud cluster. > **Note:** > -> - You cannot scale a [Serverless Tier cluster](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). +> - You cannot scale a [TiDB Serverless cluster](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). > - When a cluster is in the **MODIFYING** status, you cannot perform any new scaling operations on it. You can scale a TiDB cluster in the following dimensions: @@ -48,7 +48,7 @@ To change the number of TiDB, TiKV, or TiFlash nodes, take the following steps: 4. On the **Modify Cluster** page, change the number of TiDB, TiKV, or TiFlash nodes. 5. Click **Confirm**. -You can also change the number of TiDB, TiKV, or TiFlash nodes using TiDB Cloud API through the [Modify a Dedicated Tier cluster](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster) endpoint. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). +You can also change the number of TiDB, TiKV, or TiFlash nodes using TiDB Cloud API through the [Modify a TiDB Dedicated cluster](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster) endpoint. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). ## Change node storage @@ -72,7 +72,7 @@ To change the node storage of TiKV or TiFlash, take the following steps: 4. On the **Modify Cluster** page, change the node storage of TiKV or TiFlash. 5. Click **Confirm**. -You can also change the storage of a TiKV or TiFlash node using TiDB Cloud API through the [Modify a Dedicated Tier cluster](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster) endpoint. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). +You can also change the storage of a TiKV or TiFlash node using TiDB Cloud API through the [Modify a TiDB Dedicated cluster](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster) endpoint. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). ## Change node size @@ -98,4 +98,4 @@ To change the size of TiDB, TiKV, or TiFlash nodes, take the following steps: 4. On the **Modify Cluster** page, change the size of TiDB, TiKV, or TiFlash nodes. 5. Click **Confirm**. -You can also change the size of a TiDB, TiKV, or TiFlash node using TiDB Cloud API through the [Modify a Dedicated Tier cluster](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster) endpoint. Currently, TiDB Cloud API is still in beta. For more information, see [TiDB Cloud API Documentation](https://docs.pingcap.com/tidbcloud/api/v1beta). +You can also change the size of a TiDB, TiKV, or TiFlash node using TiDB Cloud API through the [Modify a TiDB Dedicated cluster](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster) endpoint. 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/secure-connections-to-serverless-tier-clusters.md b/tidb-cloud/secure-connections-to-serverless-tier-clusters.md index 7dd5e040381ea..c1cde9589aa78 100644 --- a/tidb-cloud/secure-connections-to-serverless-tier-clusters.md +++ b/tidb-cloud/secure-connections-to-serverless-tier-clusters.md @@ -1,20 +1,20 @@ --- -title: TLS Connections to Serverless Tier -summary: Introduce TLS connections in TiDB Serverless Tier. +title: TLS Connections to TiDB Serverless +summary: Introduce TLS connections in TiDB Serverless. --- -# TLS Connections to Serverless Tier +# TLS Connections to TiDB Serverless -Establishing a secure TLS connection between your client and your TiDB Cloud Serverless Tier cluster is one of the basic security practices for connecting to your databases. The server certificate for Serverless Tier is issued by an independent third-party certificate provider. You can easily connect to your Serverless Tier cluster without downloading a server-side digital certificate. +Establishing a secure TLS connection between your client and your TiDB Serverless cluster is one of the basic security practices for connecting to your databases. The server certificate for TiDB Serverless is issued by an independent third-party certificate provider. You can easily connect to your TiDB Serverless cluster without downloading a server-side digital certificate. ## Prerequisites - Log in to TiDB Cloud via [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md) or [SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md). -- [Create a TiDB Cloud Serverless Tier cluster](/tidb-cloud/tidb-cloud-quickstart.md). +- [Create a TiDB Serverless cluster](/tidb-cloud/tidb-cloud-quickstart.md). -## TLS connection to a Serverless Tier cluster +## TLS connection to a TiDB Serverless cluster -In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of different connection methods and connect to your Serverless Tier cluster as follows: +In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of different connection methods and connect to your TiDB Serverless cluster as follows: 1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project, and then click the name of your cluster to go to its overview page. @@ -25,46 +25,46 @@ In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of dif - Supported connection methods: MySQL CLI, MyCLI, JDBC, Python, Go, and Node.js. - Supported operating systems: MacOS, Debian, CentOS/RedHat/Fedora, Alpine, OpenSUSE, and Windows. -4. If you have not set a password yet, click **Create password** to generate a random password for your Serverless Tier cluster. The password will be automatically embedded in the sample connection string for connecting to your cluster easily. +4. If you have not set a password yet, click **Create password** to generate a random password for your TiDB Serverless cluster. The password will be automatically embedded in the sample connection string for connecting to your cluster easily. > **Note:** > > - The random password consists of 16 characters, including uppercase and lowercase letters, numbers, and special characters. > - After you close this dialog, the generated password will not show again, so you need to save the password in a secure location. If you forget it, you can click **Reset password** in this dialog to reset it. - > - The Serverless Tier cluster can be accessed through the internet. If you need to use the password elsewhere, it is recommended that you reset it to ensure database security. + > - The TiDB Serverless cluster can be accessed through the internet. If you need to use the password elsewhere, it is recommended that you reset it to ensure database security. 5. Connect to your cluster with the connection string. > **Note:** > - > When you connect to a Serverless Tier 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). + > 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). The following examples show the connection strings in MySQL CLI, MyCLI, JDBC, Python, Go, and Node.js. To learn how to get the `` of your operating system, see [Root certificate management](#root-certificate-management).
-MySQL CLI client attempts to establish a TLS connection by default. When you connect to TiDB Serverless Tier clusters, you should set `ssl-mode` and `ssl-ca`. +MySQL CLI client attempts to establish a TLS connection by default. When you connect to TiDB Serverless clusters, you should set `ssl-mode` and `ssl-ca`. ```shell mysql --connect-timeout 15 -u -h -P 4000 --ssl-mode=VERIFY_IDENTITY --ssl-ca= -D test -p ``` -- With `--ssl-mode=VERIFY_IDENTITY`, MySQL CLI client forces to enable TLS and validate TiDB Serverless Tier clusters. +- With `--ssl-mode=VERIFY_IDENTITY`, MySQL CLI client forces to enable TLS and validate TiDB Serverless clusters. - Use `--ssl-ca=` to set the CA root path on your system.
-[MyCLI](https://www.mycli.net/) automatically enables TLS when using TLS related parameters. When you connect to TiDB Serverless Tier clusters, you need to set `ssl-ca` and `ssl-verify-server-cert`. +[MyCLI](https://www.mycli.net/) automatically enables TLS when using TLS related parameters. When you connect to TiDB Serverless clusters, you need to set `ssl-ca` and `ssl-verify-server-cert`. ```shell mycli -u -h -P 4000 -D test --ssl-ca= --ssl-verify-server-cert ``` - Use `--ssl-ca=` to set the CA root path on your system. -- With `--ssl-verify-server-cert` to validate TiDB Serverless Tier clusters. +- With `--ssl-verify-server-cert` to validate TiDB Serverless clusters.
@@ -76,7 +76,7 @@ mycli -u -h -P 4000 -D test --ssl-ca= --ssl-veri jdbc:mysql://:4000/test?user=&password=&sslMode=VERIFY_IDENTITY&enabledTLSProtocols=TLSv1.2,TLSv1.3 ``` -- Set `sslMode=VERIFY_IDENTITY` to enable TLS and validate TiDB Serverless Tier clusters. JDBC trusts system CA root certificates by default, so you do not need to configure certificates. +- Set `sslMode=VERIFY_IDENTITY` to enable TLS and validate TiDB Serverless clusters. JDBC trusts system CA root certificates by default, so you do not need to configure certificates. - Set `enabledTLSProtocols=TLSv1.2,TLSv1.3` to restrict the versions of TLS protocol.
@@ -89,7 +89,7 @@ jdbc:mysql://:4000/test?user=&password=&sslMode=V host="", user="", password="", port=4000, database="test", ssl_mode="VERIFY_IDENTITY", ssl={"ca": ""} ``` -- Set `ssl_mode="VERIFY_IDENTITY"` to enable TLS and validate TiDB Serverless Tier clusters. +- Set `ssl_mode="VERIFY_IDENTITY"` to enable TLS and validate TiDB Serverless clusters. - Set `ssl={"ca": ""}` to set the CA root path on your system.
@@ -107,9 +107,9 @@ mysql.RegisterTLSConfig("tidb", &tls.Config{ db, err := sql.Open("mysql", ":@tcp(:4000)/test?tls=tidb") ``` -- Register `tls.Config` in connection to enable TLS and validate TiDB Serverless Tier clusters. Go-MySQL-Driver uses system CA root certificates by default, so you do not need to configure certificates. +- Register `tls.Config` in connection to enable TLS and validate TiDB Serverless clusters. Go-MySQL-Driver uses system CA root certificates by default, so you do not need to configure certificates. - Set `MinVersion: tls.VersionTLS12` to restrict the versions of TLS protocol. -- Set `ServerName: ""` to verify TiDB Serverless Tier's hostname. +- Set `ServerName: ""` to verify TiDB Serverless's hostname. - If you do not want to register a new TLS configuration, you can just set `tls=true` in the connection string.
@@ -123,7 +123,7 @@ host: '', port: 4000,user: '', password: '', data ``` - Set `ssl: {minVersion: 'TLSv1.2'}` to restrict the versions of TLS protocol. -- Set `ssl: {rejectUnauthorized: true}` to validate TiDB Serverless Tier clusters. Mysql2 uses system CA root certificates by default, so you do not need to configure certificates. +- Set `ssl: {rejectUnauthorized: true}` to validate TiDB Serverless clusters. Mysql2 uses system CA root certificates by default, so you do not need to configure certificates.
@@ -132,15 +132,15 @@ host: '', port: 4000,user: '', password: '', data ### Root certificate issuance and validity -TiDB Serverless Tier uses certificates from [Let's Encrypt](https://letsencrypt.org/) as a Certificate Authority (CA) for TLS connection between clients and TiDB Serverless Tier clusters. Once the Serverless Tier certificate expires, it will be automatically rotated without affecting the normal operations of your cluster and the established TLS secure connection. +TiDB Serverless uses certificates from [Let's Encrypt](https://letsencrypt.org/) as a Certificate Authority (CA) for TLS connection between clients and TiDB Serverless clusters. Once the TiDB Serverless certificate expires, it will be automatically rotated without affecting the normal operations of your cluster and the established TLS secure connection. > **Note:** > -> TiDB Serverless Tier does not provide a CA root certificate download, because we don't guarantee that the same CA will be used to issue a certificate in the future, which will cause the CA root certificate to change. +> TiDB Serverless does not provide a CA root certificate download, because we don't guarantee that the same CA will be used to issue a certificate in the future, which will cause the CA root certificate to change. -If the client uses the system's root CA stores by default, such as Java and Go, you can easily connect securely to TiDB Serverless Tier clusters without specifying the path of CA roots. If you still want to get a CA certificate for a TiDB Serverless Tier cluster, you can download and use the [Mozilla CA Certificate bundle](https://curl.se/docs/caextract.html) instead of a single CA certificate. +If the client uses the system's root CA stores by default, such as Java and Go, you can easily connect securely to TiDB Serverless clusters without specifying the path of CA roots. If you still want to get a CA certificate for a TiDB Serverless cluster, you can download and use the [Mozilla CA Certificate bundle](https://curl.se/docs/caextract.html) instead of a single CA certificate. -However, some drivers and ORMs do not use the system root CA stores. In those cases, you need to configure the CA root path of the drivers or ORMs to your system root CA stores. For example, when you use [mysqlclient](https://github.com/PyMySQL/mysqlclient) to connect a TiDB Serverless Tier cluster in Python on macOS, you need to set `ca: /etc/ssl/cert.pem` in the `ssl` argument. +However, some drivers and ORMs do not use the system root CA stores. In those cases, you need to configure the CA root path of the drivers or ORMs to your system root CA stores. For example, when you use [mysqlclient](https://github.com/PyMySQL/mysqlclient) to connect a TiDB Serverless cluster in Python on macOS, you need to set `ca: /etc/ssl/cert.pem` in the `ssl` argument. If you are using a GUI client, such as DBeaver, which does not accept a certificate file with multiple certificates inside, you must download the [ISRG Root X1](https://letsencrypt.org/certs/isrgrootx1.pem.txt) certificate. @@ -183,22 +183,22 @@ In different operating systems, the default storage paths of the root certificat Windows does not offer a specific path to the CA root. Instead, it uses the [registry](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/local-machine-and-current-user-certificate-stores) to store certificates. For this reason, to specify the CA root path on Windows, take the following steps: 1. Download the [Mozilla CA Certificate bundle](https://curl.se/docs/caextract.html) and save it in a path you prefer, such as ``. -2. Use the path (``) as your CA root path when you connect to a Serverless Tier cluster. +2. Use the path (``) as your CA root path when you connect to a TiDB Serverless cluster. ## FAQs -### Which TLS versions are supported to connect to my TiDB Cloud Serverless Tier cluster? +### Which TLS versions are supported to connect to my TiDB Serverless cluster? -For security reasons, TiDB Cloud Serverless Tier only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details. +For security reasons, TiDB Serverless only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details. -### Is two-way TLS authentication between my connection client and TiDB Cloud Serverless Tier supported? +### Is two-way TLS authentication between my connection client and TiDB Serverless supported? No. -TiDB Cloud Serverless Tier only supports one-way TLS authentication, which means your client uses the public key to verify the signature of your TiDB Cloud cluster certificate's private key while the cluster does not validate the client. +TiDB Serverless only supports one-way TLS authentication, which means your client uses the public key to verify the signature of your TiDB Cloud cluster certificate's private key while the cluster does not validate the client. -### Does TiDB Serverless Tier have to configure TLS to establish a secure connection? +### Does TiDB Serverless have to configure TLS to establish a secure connection? -For standard connection, TiDB Cloud Serverless Tier only allows TLS connections and prohibits non-SSL/TLS connections. The reason is that SSL/TLS is one of the most basic security measures for you to reduce the risk of data exposure to the internet when you connect to the Serverless Tier cluster through the internet. +For standard connection, TiDB Serverless only allows TLS connections and prohibits non-SSL/TLS connections. The reason is that SSL/TLS is one of the most basic security measures for you to reduce the risk of data exposure to the internet when you connect to the TiDB Serverless cluster through the internet. For private endpoint connection, because it supports highly secure and one-way access to the TiDB Cloud service and does not expose your data to the public internet, configuring TLS is optional. \ No newline at end of file diff --git a/tidb-cloud/select-cluster-tier.md b/tidb-cloud/select-cluster-tier.md index dd5aec2354bf2..730736c2cd168 100644 --- a/tidb-cloud/select-cluster-tier.md +++ b/tidb-cloud/select-cluster-tier.md @@ -10,18 +10,18 @@ The cluster tier determines the throughput and performance of your cluster. TiDB Cloud provides the following two options of cluster tiers. Before creating a cluster, you need to consider which option suits your need better. -- [Serverless Tier](#serverless-tier-beta) -- [Dedicated Tier](#dedicated-tier) +- [TiDB Serverless](#tidb-serverless-beta) +- [TiDB Dedicated](#tidb-dedicated) -## Serverless Tier (Beta) +## TiDB Serverless (Beta) -The TiDB Cloud Serverless Tier (previously called Developer Tier) is a fully managed service of TiDB. It's still in beta and should not be used in production. However, you can use Serverless Tier clusters for non-production workloads such as prototype applications, hackathons, academic courses, or to provide a temporary data service for your datasets. +TiDB Serverless (previously called Developer Tier) is a fully managed service of TiDB. It's still in beta and should not 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. ### Usage quota -For each organization in TiDB Cloud, you can create a maximum of five Serverless Tier clusters by default. To create more Serverless Tier clusters, you need to add a credit card and set a [spend limit](/tidb-cloud/tidb-cloud-glossary.md#spend-limit) for the usage. +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. -For the first five Serverless Tier clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: +For the first five TiDB Serverless clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: - Row storage: 5 GiB - [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit): 50 million RUs per month @@ -30,13 +30,13 @@ A Request Unit (RU) is a unit of measure used to represent the amount of resourc Once the free quota of a cluster is reached, the read and write operations on this cluster will be throttled until you [increase the quota](/tidb-cloud/manage-serverless-spend-limit.md#update-spend-limit) or the usage is reset upon the start of a new month. For example, when the storage of a cluster exceeds 5 GiB, the maximum size limit of a single transaction is reduced from 10 MiB to 1 MiB. -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 Cloud Serverless Tier Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). +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). ### User name prefix -For each Serverless Tier cluster, TiDB Cloud generates a unique prefix to distinguish it from other clusters. +For each TiDB Serverless cluster, TiDB Cloud generates a unique prefix to distinguish it from other clusters. Whenever you use or set a database user name, you must include the prefix in the user name. For example, assume that the prefix of your cluster is `3pTAoNNegb47Uc8`. @@ -48,7 +48,7 @@ Whenever you use or set a database user name, you must include the prefix in the > **Note:** > - > Serverless Tier requires TLS connection. To find the CA root path on your system, see [Root certificate default path](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md#root-certificate-default-path). + > TiDB Serverless requires TLS connection. To find the CA root path on your system, see [Root certificate default path](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md#root-certificate-default-path). - To create a database user: @@ -62,18 +62,18 @@ To get the prefix for your cluster, take the following steps: 2. Click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. A connection dialog is displayed. 3. In the dialog, get the prefix from the connection string. -### Serverless Tier special terms and conditions +### TiDB Serverless special terms and conditions -- Serverless Tier is currently in beta and does not have uptime SLA guarantee during beta phase. If you use Serverless Tier beta to store a commercial or production dataset, any potential risk associated with the use should be taken on your own, and PingCAP shall not be liable for any damage. -- Some of TiDB Cloud features are partially supported or not supported on Serverless Tier. See [Serverless Tier Limitations](/tidb-cloud/serverless-tier-limitations.md) for details. +- TiDB Serverless is currently in beta and does not have uptime SLA guarantee during beta phase. If you use TiDB Serverless beta to store a commercial or production dataset, any potential risk associated with the use should be taken on your own, and PingCAP shall not be liable for any damage. +- Some of TiDB Cloud features are partially supported or not supported on TiDB Serverless. See [TiDB Serverless Limitations](/tidb-cloud/serverless-tier-limitations.md) for details. -## Dedicated Tier +## TiDB Dedicated -The TiDB Cloud Dedicated Tier 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). +TiDB Dedicated is for production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing). -For Dedicated Tier clusters, you can customize the cluster size of TiDB, TiKV, and TiFlash easily according to your business need. For each TiKV node and TiFlash node, the data on the node is replicated and distributed in different availability zones for [high availability](/tidb-cloud/high-availability-with-multi-az.md). +For TiDB Dedicated clusters, you can customize the cluster size of TiDB, TiKV, and TiFlash easily according to your business need. For each TiKV node and TiFlash node, the data on the node is replicated and distributed in different availability zones for [high availability](/tidb-cloud/high-availability-with-multi-az.md). -To create a Dedicated Tier cluster, you need to [add a payment method](/tidb-cloud/tidb-cloud-billing.md#payment-method) or [apply for a Proof of Concept (PoC) trial](/tidb-cloud/tidb-cloud-poc.md). +To create a TiDB Dedicated cluster, you need to [add a payment method](/tidb-cloud/tidb-cloud-billing.md#payment-method) or [apply for a Proof of Concept (PoC) trial](/tidb-cloud/tidb-cloud-poc.md). > **Note:** > diff --git a/tidb-cloud/serverless-tier-faqs.md b/tidb-cloud/serverless-tier-faqs.md index 4a4bfdbdd7f22..06df061a992c8 100644 --- a/tidb-cloud/serverless-tier-faqs.md +++ b/tidb-cloud/serverless-tier-faqs.md @@ -1,61 +1,61 @@ --- -title: Serverless Tier FAQs -summary: Learn about the most frequently asked questions (FAQs) relating to TiDB Cloud Serverless Tier. +title: TiDB Serverless FAQs +summary: Learn about the most frequently asked questions (FAQs) relating to TiDB Serverless. --- -# Serverless Tier FAQs +# TiDB Serverless FAQs -This document lists the most frequently asked questions about TiDB Cloud Serverless Tier. +This document lists the most frequently asked questions about TiDB Serverless. ## General FAQs -### What is Serverless Tier? +### What is TiDB Serverless? -TiDB Cloud Serverless Tier offers the TiDB database with full HTAP capabilities for you and your organization. It is a fully managed, auto-scaling deployment of TiDB that lets you start using your database immediately, develop and run your application without caring about the underlying nodes, and automatically scale based on your application's workload changes. +TiDB Serverless offers the TiDB database with full HTAP capabilities for you and your organization. It is a fully managed, auto-scaling deployment of TiDB that lets you start using your database immediately, develop and run your application without caring about the underlying nodes, and automatically scale based on your application's workload changes. -### How do I get started with Serverless Tier? +### How do I get started with TiDB Serverless? Get started with the 5-minute [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md). -### Is Serverless Tier free during beta? +### Is TiDB Serverless free during beta? -Until May 31, 2023, Serverless Tier clusters are still free, with a 100% discount off. After that, usage beyond the free quota will be charged. Once the free quota of a cluster is reached, the read and write operations on this cluster will be throttled until you [increase the quota](/tidb-cloud/manage-serverless-spend-limit.md#update-spend-limit) or the usage is reset upon the start of a new month. +Until May 31, 2023, TiDB Serverless clusters are still free, with a 100% discount off. After that, usage beyond the free quota will be charged. Once the free quota of a cluster is reached, the read and write operations on this cluster will be throttled until you [increase the quota](/tidb-cloud/manage-serverless-spend-limit.md#update-spend-limit) or the usage is reset upon the start of a new month. -For more information, see [Serverless Tier usage quota](/tidb-cloud/select-cluster-tier.md#usage-quota). +For more information, see [TiDB Serverless usage quota](/tidb-cloud/select-cluster-tier.md#usage-quota). ### What does it mean for beta release? -Serverless Tier is in beta while we continuously add new features and improve existing features before it becomes generally available. We do not provide SLA for beta products. Therefore, Serverless Tier should **NOT** be used in production currently. +TiDB Serverless is in beta while we continuously add new features and improve existing features before it becomes generally available. We do not provide SLA for beta products. Therefore, TiDB Serverless should **NOT** be used in production currently. -### What are the limitations of a Serverless Tier cluster in beta? +### What are the limitations of a TiDB Serverless cluster in beta? -For each organization in TiDB Cloud, you can create a maximum of five Serverless Tier clusters by default. To create more Serverless Tier clusters, you need to add a credit card and set a [spend limit](/tidb-cloud/tidb-cloud-glossary.md#spend-limit) for the usage. +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. -Some of TiDB Cloud features are partially supported or not supported on Serverless Tier. See [Serverless Tier Limitations and Quotas](/tidb-cloud/serverless-tier-limitations.md) for details. +Some of TiDB Cloud features are partially supported or not supported on TiDB Serverless. See [TiDB Serverless Limitations and Quotas](/tidb-cloud/serverless-tier-limitations.md) for details. -### What can Serverless Tier be used for? +### What can TiDB Serverless be used for? -You can use your Serverless Tier cluster for non-production workloads such as prototype applications, development environments, hackathons, and academic courses, or to provide temporary data service for your datasets. +You can use your TiDB Serverless cluster for non-production workloads such as prototype applications, development environments, hackathons, and academic courses, or to provide temporary data service for your datasets. -### I created a Developer Tier cluster before Serverless Tier was available. Can I still use my cluster? +### I created a Developer Tier cluster before TiDB Serverless was available. Can I still use my cluster? -Yes, your Developer Tier cluster will be automatically migrated to the Serverless Tier cluster soon. Your ability to use your cluster should not be affected, and you will have the same improved Serverless Tier user experiences. +Yes, your Developer Tier cluster will be automatically migrated to the TiDB Serverless cluster soon. Your ability to use your cluster should not be affected, and you will have the same improved TiDB Serverless user experiences. ## Security FAQs -### Is my Serverless Tier shared or dedicated? +### Is my TiDB Serverless shared or dedicated? -The serverless technology is designed for multi-tenancy and the resources used by all clusters are shared. To get managed TiDB service with isolated infrastructure and resources, you can upgrade it to the [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier). +The serverless technology is designed for multi-tenancy and the resources used by all clusters are shared. To get managed TiDB service with isolated infrastructure and resources, you can upgrade it to [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated). -### How does TiDB Serverless Tier ensure security? +### How does TiDB Serverless ensure security? -- Your connections are encrypted by Transport Layer Security (TLS). For more information about using TLS to connect to Serverless Tier, see [TLS Connection to Serverless Tier](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md). -- All persisted data on Serverless Tier is encrypted-at-rest using the tool of the cloud provider that your cluster is running in. +- Your connections are encrypted by Transport Layer Security (TLS). For more information about using TLS to connect to TiDB Serverless, see [TLS Connection to TiDB Serverless](/tidb-cloud/secure-connections-to-serverless-tier-clusters.md). +- All persisted data on TiDB Serverless is encrypted-at-rest using the tool of the cloud provider that your cluster is running in. ## Maintenance FAQ ### Can I upgrade the version of TiDB that my cluster is running on? -No. Serverless Tier clusters are upgraded automatically as we roll out new TiDB versions on TiDB Cloud. You can see what version of TiDB your cluster is running in the [TiDB Cloud console](https://tidbcloud.com/console/clusters) or in the latest [release note](https://docs.pingcap.com/tidbcloud/tidb-cloud-release-notes). Alternatively, you can also connect to your cluster and use `SELECT version()` or `SELECT tidb_version()` to check the TiDB version. +No. TiDB Serverless clusters are upgraded automatically as we roll out new TiDB versions on TiDB Cloud. You can see what version of TiDB your cluster is running in the [TiDB Cloud console](https://tidbcloud.com/console/clusters) or in the latest [release note](https://docs.pingcap.com/tidbcloud/tidb-cloud-release-notes). Alternatively, you can also connect to your cluster and use `SELECT version()` or `SELECT tidb_version()` to check the TiDB version. diff --git a/tidb-cloud/serverless-tier-limitations.md b/tidb-cloud/serverless-tier-limitations.md index 7874316de00c7..d3fff1b7c2348 100644 --- a/tidb-cloud/serverless-tier-limitations.md +++ b/tidb-cloud/serverless-tier-limitations.md @@ -1,61 +1,61 @@ --- -title: Serverless Tier Limitations and Quotas -summary: Learn about the limitations of TiDB Cloud Serverless Tier. +title: TiDB Serverless Limitations and Quotas +summary: Learn about the limitations of TiDB Serverless. --- -# Serverless Tier Limitations and Quotas +# TiDB Serverless Limitations and Quotas -This document describes the limitations of Serverless Tier. +This document describes the limitations of TiDB Serverless. -We are constantly filling in the feature gaps between Serverless Tier and Dedicated Tier. If you require these features or capabilities in the gap, use [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) or [contact us](https://www.pingcap.com/contact-us/?from=en) for a feature request. +We are constantly filling in the feature gaps between TiDB Serverless and TiDB Dedicated. If you require these features or capabilities in the gap, use [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) or [contact us](https://www.pingcap.com/contact-us/?from=en) for a feature request. ## Limitations ### SQL -- [Time to live (TTL)](/time-to-live.md) is not available for Serverless Tier clusters currently. -- The [`FLASHBACK CLUSTER TO TIMESTAMP`](/sql-statements/sql-statement-flashback-to-timestamp.md) syntax is not applicable to TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- [Time to live (TTL)](/time-to-live.md) is not available for TiDB Serverless clusters currently. +- The [`FLASHBACK CLUSTER TO TIMESTAMP`](/sql-statements/sql-statement-flashback-to-timestamp.md) syntax is not applicable to [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. - The [`SLEEP()` function](/functions-and-operators/miscellaneous-functions.md) only supports a maximum sleep time of 300 seconds. ### System tables -- Tables `CLUSTER_SLOW_QUERY`, `SLOW_QUERY`, `CLUSTER_STATEMENTS_SUMMARY`, `CLUSTER_STATEMENTS_SUMMARY_HISTORY`, `STATEMENTS_SUMMARY`, `STATEMENTS_SUMMARY_HISTORY` are not available for Serverless Tier clusters. +- Tables `CLUSTER_SLOW_QUERY`, `SLOW_QUERY`, `CLUSTER_STATEMENTS_SUMMARY`, `CLUSTER_STATEMENTS_SUMMARY_HISTORY`, `STATEMENTS_SUMMARY`, `STATEMENTS_SUMMARY_HISTORY` are not available for TiDB Serverless clusters. ### Transaction -- The total size of a single transaction is set to no more than 10 MB on Serverless Tier during the beta phase. +- The total size of a single transaction is set to no more than 10 MB on TiDB Serverless during the beta phase. ### 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 Serverless Tier clusters.  +- 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.  - No "IP Access List" support. ### Monitoring -- [Third-party Monitoring integrations](/tidb-cloud/third-party-monitoring-integrations.md) are currently not available for Serverless Tier. -- [Cluster Events](/tidb-cloud/tidb-cloud-events.md) are currently not available for Serverless Tier. -- [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md) is currently not available for Serverless Tier. +- [Third-party Monitoring integrations](/tidb-cloud/third-party-monitoring-integrations.md) are currently not available for TiDB Serverless. +- [Cluster Events](/tidb-cloud/tidb-cloud-events.md) are currently not available for TiDB Serverless. +- [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md) is currently not available for TiDB Serverless. ### Diagnosis -- [Key Visualizer](/tidb-cloud/tune-performance.md#key-visualizer) is unavailable for Serverless Tier. +- [Key Visualizer](/tidb-cloud/tune-performance.md#key-visualizer) is unavailable for TiDB Serverless. ### Stream data -* [Changefeed](/tidb-cloud/changefeed-overview.md) is not supported for Serverless Tier currently. -* [Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md) is not supported for Serverless Tier currently. +* [Changefeed](/tidb-cloud/changefeed-overview.md) is not supported for TiDB Serverless currently. +* [Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md) is not supported for TiDB Serverless currently. ### Maintenance window -- [Maintenance window](/tidb-cloud/configure-maintenance-window.md) is unavailable for Serverless Tier. +- [Maintenance window](/tidb-cloud/configure-maintenance-window.md) is unavailable for TiDB Serverless. ## Usage quota -For each organization in TiDB Cloud, you can create a maximum of five Serverless Tier clusters by default. To create more Serverless Tier clusters, you need to add a credit card and set a [spend limit](/tidb-cloud/tidb-cloud-glossary.md#spend-limit) for the usage. +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. -For the first five Serverless Tier clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: +For the first five TiDB Serverless clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: - Row storage: 5 GiB - [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit): 50 million RUs per month @@ -64,8 +64,8 @@ The Request Unit (RU) is a unit of measurement used to track the resource consum Once the free quota of a cluster is reached, the read and write operations on this cluster will be throttled until you [increase the quota](/tidb-cloud/manage-serverless-spend-limit.md#update-spend-limit) or the usage is reset upon the start of a new month. For example, when the storage of a cluster exceeds 5 GiB, the maximum size limit of a single transaction is reduced from 10 MiB to 1 MiB. -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 Cloud Serverless Tier Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). +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 Serverless Tier 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 cluster](/tidb-cloud/create-tidb-cluster.md#step-4-create-a-tidb-cluster). -After creating a Serverless Tier, you can still check and edit the spend limit on your cluster overview page. For more information, see [Manage Spend Limit for Serverless Tier Clusters](/tidb-cloud/manage-serverless-spend-limit.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.md b/tidb-cloud/set-up-private-endpoint-connections.md index c57dc59bb00dc..1460056542958 100644 --- a/tidb-cloud/set-up-private-endpoint-connections.md +++ b/tidb-cloud/set-up-private-endpoint-connections.md @@ -31,11 +31,11 @@ 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 Serverless Tier cluster and a Dedicated Tier cluster. +This section describes how to set up a private endpoint with AWS PrivateLink for a TiDB Serverless cluster and a TiDB Dedicated cluster. -### Serverless Tier +### TiDB Serverless -To connect to your Serverless Tier cluster via a private endpoint, follow these steps: +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) @@ -43,14 +43,14 @@ To connect to your Serverless Tier cluster via a private endpoint, follow these #### Step 1. Choose a TiDB cluster -1. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click the name of your target Serverless Tier cluster to go to its overview page. +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 Serverless Tier clusters located in the same region. + > 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 @@ -116,9 +116,9 @@ After you have created the interface endpoint, go back to the TiDB Cloud console > > 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. -### Dedicated Tier +### TiDB Dedicated -To connect to your Dedicated Tier cluster via a private endpoint, complete the [prerequisites](#prerequisites) and follow these steps: +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) 2. [Check the service endpoint region](#step-2-check-the-service-endpoint-region) @@ -142,7 +142,7 @@ If you have multiple clusters, you need to repeat these steps for each cluster t #### Step 1. Choose a TiDB cluster -1. Click the drop-down list and choose an available Dedicated Tier cluster. +1. Click the drop-down list and choose an available TiDB Dedicated cluster. 2. Click **Next**. #### Step 2. Check the service endpoint region @@ -157,7 +157,7 @@ Your service endpoint region is selected by default. Have a quick check and clic > **Note:** > -> For each Dedicated Tier cluster created after March 28, 2023, the corresponding endpoint service is automatically created 3 to 4 minutes after the cluster creation. +> For each TiDB Dedicated cluster created after March 28, 2023, the corresponding endpoint service is automatically created 3 to 4 minutes after the cluster creation. If you see the `Endpoint Service Ready` message, take note of your endpoint service name from the command in the lower area of the console for later use. Otherwise, wait 3 to 4 minutes to let TiDB Cloud create an endpoint service for your cluster. diff --git a/tidb-cloud/set-up-vpc-peering-connections.md b/tidb-cloud/set-up-vpc-peering-connections.md index caa0d44e09e18..67356921b8d3b 100644 --- a/tidb-cloud/set-up-vpc-peering-connections.md +++ b/tidb-cloud/set-up-vpc-peering-connections.md @@ -7,7 +7,7 @@ summary: Learn how to connect to TiDB Cloud via VPC peering. > **Note:** > -> VPC peering connection is only available for Dedicated Tier clusters. You cannot connect to [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) using VPC peering. +> VPC peering connection is only available for TiDB Dedicated clusters. You cannot connect to [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) using VPC peering. To connect your application to TiDB Cloud via VPC peering, you need to set up [VPC peering](/tidb-cloud/tidb-cloud-glossary.md#vpc-peering) with TiDB Cloud. This document walks you through setting up VPC peering connections [on AWS](#set-up-vpc-peering-on-aws) and [on GCP](#set-up-vpc-peering-on-gcp) and connecting to TiDB Cloud via a VPC peering. @@ -25,7 +25,7 @@ Project CIDR (Classless Inter-Domain Routing) is the CIDR block used for network Before adding VPC Peering requests to a region, you need to set a project CIDR for your project's cloud provider (AWS or GCP) to establish a peering link to your application's VPC. -You can set the project CIDR when creating the first Dedicated Tier of your project. If you want to set the project CIDR before creating the tier, perform the following operations: +You can set the project CIDR when creating the first TiDB Dedicated of your project. If you want to set the project CIDR before creating the cluster, perform the following operations: 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: diff --git a/tidb-cloud/size-your-cluster.md b/tidb-cloud/size-your-cluster.md index 393de21bb6bea..9c0e31ca34d05 100644 --- a/tidb-cloud/size-your-cluster.md +++ b/tidb-cloud/size-your-cluster.md @@ -5,11 +5,11 @@ summary: Learn how to determine the size of your TiDB Cloud cluster. # Determine Your TiDB Size -This document describes how to determine the size of a Dedicated Tier cluster. +This document describes how to determine the size of a TiDB Dedicated cluster. > **Note:** > -> You cannot change the size of a [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster. +> You cannot change the size of a [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster. ## Size TiDB @@ -158,7 +158,7 @@ For example, your overall expected performance is 110,000 QPS under a mixed work As 7 is less than 8, the performance deviation coefficient of 7 nodes is 0. The estimated TiKV performance is `7 * 17,800 * (1 - 0) = 124,600`, which can meet your expected performance of 110,000 QPS. -Therefore, 7 TiKV nodes (8 vCPU, 32 GiB) are recommended for you according to your expected performance. +Therefore, 7 TiKV nodes (8 vCPU, 32 GiB) are recommended for you according to your expected performance. Next, you can compare the TiKV node number calculated according to data volume with the number calculated according to your expected performance, and take the larger one as a recommended number of your TiKV nodes. diff --git a/tidb-cloud/terraform-tidbcloud-provider-overview.md b/tidb-cloud/terraform-tidbcloud-provider-overview.md index 3b84491665cfb..b248bf10ac2d8 100644 --- a/tidb-cloud/terraform-tidbcloud-provider-overview.md +++ b/tidb-cloud/terraform-tidbcloud-provider-overview.md @@ -5,7 +5,7 @@ summary: Create, manage, and update your TiDB Cloud resources through Terraform. # Terraform Integration Overview -[Terraform](https://www.terraform.io/) is an infrastructure as code tool that lets you define both cloud and on-premises resources in human-readable configuration files that you can version, reuse, and share. +[Terraform](https://www.terraform.io/) is an infrastructure as code tool that lets you define both cloud and self-hosted resources in human-readable configuration files that you can version, reuse, and share. [TiDB Cloud Terraform Provider](https://registry.terraform.io/providers/tidbcloud/tidbcloud) is a plugin that allows you to use Terraform to manage TiDB Cloud resources, such as clusters, backups, and restores. diff --git a/tidb-cloud/terraform-use-backup-resource.md b/tidb-cloud/terraform-use-backup-resource.md index c1bb5ef113506..f882f8f2ea20e 100644 --- a/tidb-cloud/terraform-use-backup-resource.md +++ b/tidb-cloud/terraform-use-backup-resource.md @@ -9,13 +9,13 @@ You can learn how to create a backup of a TiDB Cloud cluster with the `tidbcloud The features of the `tidbcloud_backup` resource include the following: -- Create backups for Dedicated Tier clusters. -- Delete backups for Dedicated Tier clusters. +- Create backups for TiDB Dedicated clusters. +- Delete backups for TiDB Dedicated clusters. ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). -- The backup and restore feature is unavailable to Serverless Tier clusters. To use backup resources, make sure that you have created a Dedicated Tier cluster. +- The backup and restore feature is unavailable to TiDB Serverless clusters. To use backup resources, make sure that you have created a TiDB Dedicated cluster. ## Create a backup with the backup resource diff --git a/tidb-cloud/terraform-use-cluster-resource.md b/tidb-cloud/terraform-use-cluster-resource.md index 90c2ca2ef7798..ac2fa7469f1be 100644 --- a/tidb-cloud/terraform-use-cluster-resource.md +++ b/tidb-cloud/terraform-use-cluster-resource.md @@ -11,9 +11,9 @@ In addition, you will also learn how to get the necessary information with the ` The features of the `tidbcloud_cluster` resource include the following: -- Create Serverless Tier and Dedicated Tier clusters. -- Modify Dedicated Tier clusters. -- Delete Serverless Tier and Dedicated Tier clusters. +- Create TiDB Serverless and TiDB Dedicated clusters. +- Modify TiDB Dedicated clusters. +- Delete TiDB Serverless and TiDB Dedicated clusters. ## Prerequisites @@ -69,7 +69,7 @@ To view the information of all available projects, you can use the `tidbcloud_pr ``` $ terraform apply --auto-approve - + Changes to Outputs: + projects = [ + { @@ -151,7 +151,7 @@ To get the cluster specification information, you can use the `tidbcloud_cluster
Cluster specification - + ``` { "cloud_provider" = "AWS" @@ -289,7 +289,7 @@ In the results: You can create a cluster using the `tidbcloud_cluster` resource. -The following example shows how to create a Dedicated Tier cluster. +The following example shows how to create a TiDB Dedicated cluster. 1. Create a directory for the cluster and enter it. @@ -343,7 +343,7 @@ The following example shows how to create a Dedicated Tier cluster. ```shell $ terraform apply - + Terraform will perform the following actions: # tidbcloud_cluster.example_cluster will be created @@ -487,9 +487,9 @@ The following example shows how to create a Dedicated Tier cluster. When the status is `AVAILABLE`, it indicates that your TiDB cluster is created and ready for use. -## Modify a Dedicated Tier cluster +## Modify a TiDB Dedicated cluster -For a Dedicated Tier cluster, you can use Terraform to manage cluster resources as follows: +For a TiDB Dedicated cluster, you can use Terraform to manage cluster resources as follows: - Add a TiFlash component to the cluster. - Scale the cluster. @@ -845,7 +845,7 @@ You can pause a cluster when its status is `AVAILABLE` or resume a cluster when 6. Wait for a moment, then use the `terraform refersh` command to update the state. The status will be changed to `AVAILABLE` finally. -Now, you have created and managed a Dedicated Tier cluster with Terraform. Next, you can try creating a backup of the cluster by our [backup resource](/tidb-cloud/terraform-use-backup-resource.md). +Now, you have created and managed a TiDB Dedicated cluster with Terraform. Next, you can try creating a backup of the cluster by our [backup resource](/tidb-cloud/terraform-use-backup-resource.md). ## Import a cluster @@ -971,7 +971,7 @@ For example, you can import a cluster that is not created by Terraform or import Apply complete! Resources: 0 added, 0 changed, 0 destroyed. ``` -Now you can use Terraform to manage the cluster. +Now you can use Terraform to manage the cluster. ## Delete a cluster diff --git a/tidb-cloud/terraform-use-import-resource.md b/tidb-cloud/terraform-use-import-resource.md index 96f5fb772dc98..1087d884589ae 100644 --- a/tidb-cloud/terraform-use-import-resource.md +++ b/tidb-cloud/terraform-use-import-resource.md @@ -9,14 +9,14 @@ You can learn how to import data to a TiDB Cloud cluster with the `tidbcloud_imp The features of the `tidbcloud_import` resource include the following: -- Create import tasks for Serverless Tier and Dedicated Tier clusters. +- Create import tasks for TiDB Serverless and TiDB Dedicated clusters. - Import data either from local disks or from Amazon S3 buckets. - Cancel ongoing import tasks. ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). -- [Create a Serverless Tier or Dedicated Tier cluster](/tidb-cloud/create-tidb-cluster.md). +- [Create a TiDB Serverless or TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). ## Create and run an import task @@ -26,7 +26,7 @@ You can manage either a local import task or an Amazon S3 import task using the > **Note:** > -> Importing local files is supported only for Serverless Tier clusters, not for Dedicated Tier clusters. +> Importing local files is supported only for TiDB Serverless clusters, not for TiDB Dedicated clusters. 1. Create a CSV file for import. For example: @@ -51,7 +51,7 @@ You can manage either a local import task or an Amazon S3 import task using the public_key = "your_public_key" private_key = "your_private_key" } - + resource "tidbcloud_import" "example_local" { project_id = "your_project_id" cluster_id = "your_cluster_id" @@ -76,13 +76,13 @@ You can manage either a local import task or an Amazon S3 import task using the $ terraform apply ... Plan: 1 to add, 0 to change, 0 to destroy. - + Do you want to perform these actions? Terraform will perform the actions described above. Only 'yes' will be accepted to approve. - + Enter a value: yes - + tidbcloud_import.example_local: Creating... tidbcloud_import.example_local: Creation complete after 6s [id=781074] ``` @@ -201,12 +201,12 @@ You can manage either a local import task or an Amazon S3 import task using the } } } - + provider "tidbcloud" { public_key = "your_public_key" private_key = "your_private_key" } - + resource "tidbcloud_import" "example_s3_csv" { project_id = "your_project_id" cluster_id = "your_cluster_id" @@ -215,7 +215,7 @@ You can manage either a local import task or an Amazon S3 import task using the aws_role_arn = "your_arn" source_url = "your_url" } - + resource "tidbcloud_import" "example_s3_parquet" { project_id = "your_project_id" cluster_id = "your_cluster_id" @@ -225,26 +225,26 @@ You can manage either a local import task or an Amazon S3 import task using the source_url = "your_url" } ``` - + 2. Run the `terraform apply` command to create an import task, and then type `yes` to confirm the creation and start the import: ``` $ terraform apply ... Plan: 2 to add, 0 to change, 0 to destroy. - + Do you want to perform these actions? Terraform will perform the actions described above. Only 'yes' will be accepted to approve. - + Enter a value: yes - + tidbcloud_import.example_s3_csv: Creating... tidbcloud_import.example_s3_csv: Creation complete after 3s [id=781075] tidbcloud_import.example_s3_parquet: Creating... tidbcloud_import.example_s3_parquet: Creation complete after 4s [id=781076] ``` - + 3. Use `terraform refresh` and `terraform state show tidbcloud_import.${resource-name}` to update and check the status of the import task. ## Update an import task @@ -253,7 +253,7 @@ Import tasks cannot be updated. ## Delete an import task -For Terraform, deleting an import task means canceling the corresponding import resource. +For Terraform, deleting an import task means canceling the corresponding import resource. You cannot cancel a `COMPLETED` import task. Otherwise, you will get a `Delete Error` as in the following example: @@ -271,7 +271,7 @@ Do you really want to destroy all resources? tidbcloud_import.example_local: Destroying... [id=781074] ╷ │ Error: Delete Error -│ +│ │ Unable to call CancelImport, got error: [DELETE /api/internal/projects/{project_id}/clusters/{cluster_id}/imports/{id}][500] CancelImport default &{Code:59900104 Details:[] Message:failed to cancel │ import} ╵ @@ -289,11 +289,11 @@ Do you really want to destroy all resources? There is no undo. Only 'yes' will be accepted to confirm. Enter a value: yes - + tidbcloud_import.example_local: Destroying... [id=781074] tidbcloud_import.example_local: Destruction complete after 0s -Destroy complete! Resources: 1 destroyed. +Destroy complete! Resources: 1 destroyed. ``` ## Configurations diff --git a/tidb-cloud/terraform-use-restore-resource.md b/tidb-cloud/terraform-use-restore-resource.md index c8a0f3fdc3f22..9afd88ab46e2f 100644 --- a/tidb-cloud/terraform-use-restore-resource.md +++ b/tidb-cloud/terraform-use-restore-resource.md @@ -9,12 +9,12 @@ You can learn how to manage a restore task with the `tidbcloud_restore` resource The features of the `tidbcloud_restore` resource include the following: -- Create restore tasks for Dedicated Tier clusters according to your backup. +- Create restore tasks for TiDB Dedicated clusters according to your backup. ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). -- The backup and restore feature is unavailable for Serverless Tier clusters. To use restore resources, make sure that you have created a Dedicated Tier cluster. +- The backup and restore feature is unavailable for TiDB Serverless clusters. To use restore resources, make sure that you have created a TiDB Dedicated cluster. ## Create a restore task diff --git a/tidb-cloud/third-party-monitoring-integrations.md b/tidb-cloud/third-party-monitoring-integrations.md index 692b8ae1ed9fe..0f74034e4600e 100644 --- a/tidb-cloud/third-party-monitoring-integrations.md +++ b/tidb-cloud/third-party-monitoring-integrations.md @@ -23,7 +23,7 @@ The available third-party integrations are displayed. ## Limitation -- For [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters, third-party metrics integrations are not supported. +- For [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters, third-party metrics integrations are not supported. - Third-party metrics integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**. diff --git a/tidb-cloud/ticloud-cluster-connect-info.md b/tidb-cloud/ticloud-cluster-connect-info.md index 9567d8c624a9c..fdb43cf2fe992 100644 --- a/tidb-cloud/ticloud-cluster-connect-info.md +++ b/tidb-cloud/ticloud-cluster-connect-info.md @@ -13,7 +13,7 @@ ticloud cluster connect-info [flags] > **Note:** > -> Currently, this command only supports getting the connection string of a [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster. +> Currently, this command only supports getting the connection string of a [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster. ## Examples diff --git a/tidb-cloud/ticloud-cluster-create.md b/tidb-cloud/ticloud-cluster-create.md index c750be2217292..06daf4bc849dd 100644 --- a/tidb-cloud/ticloud-cluster-create.md +++ b/tidb-cloud/ticloud-cluster-create.md @@ -13,7 +13,7 @@ ticloud cluster create [flags] > **Note:** > -> Currently, you can only create a [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster using the preceding command. +> Currently, you can only create a [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster using the preceding command. ## Examples diff --git a/tidb-cloud/ticloud-connect.md b/tidb-cloud/ticloud-connect.md index a9228a06bc3a0..c99e9fa658a00 100644 --- a/tidb-cloud/ticloud-connect.md +++ b/tidb-cloud/ticloud-connect.md @@ -13,7 +13,7 @@ ticloud connect [flags] > **Note:** > -> - If you are prompted about whether to use the default user, you can choose `Y` to use the default root user or choose `n` to specify another user. For [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters, the name of the default root user has a [prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix) such as `3pTAoNNegb47Uc8`. +> - If you are prompted about whether to use the default user, you can choose `Y` to use the default root user or choose `n` to specify another user. For [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters, the name of the default root user has a [prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix) such as `3pTAoNNegb47Uc8`. > - The connection forces the [ANSI SQL mode](https://dev.mysql.com/doc/refman/8.0/en/sql-mode.html#sqlmode_ansi) for the session. To exit the session, enter `\q`. ## Examples diff --git a/tidb-cloud/ticloud-import-start-local.md b/tidb-cloud/ticloud-import-start-local.md index 084d1edfe6793..1c86739bc41ca 100644 --- a/tidb-cloud/ticloud-import-start-local.md +++ b/tidb-cloud/ticloud-import-start-local.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud import start local`. # ticloud import start local -Import a local file to a TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster: +Import a local file to a [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster: ```shell ticloud import start local [flags] diff --git a/tidb-cloud/tidb-cloud-auditing.md b/tidb-cloud/tidb-cloud-auditing.md index b18de6bf18954..929af52868539 100644 --- a/tidb-cloud/tidb-cloud-auditing.md +++ b/tidb-cloud/tidb-cloud-auditing.md @@ -21,7 +21,7 @@ The audit logging feature is disabled by default. To audit a cluster, you need t ## Prerequisites -- You are using a TiDB Cloud Dedicated Tier cluster. Audit logging is not available for TiDB Cloud Serverless Tier clusters. +- You are using a TiDB Dedicated cluster. Audit logging is not available for TiDB Serverless clusters. - You are the audit administrator of your organization in TiDB Cloud. Otherwise, you cannot see the audit-related options in the TiDB Cloud console. For more information, see [Manage role access](/tidb-cloud/manage-user-access.md#manage-role-access). ## Enable audit logging for AWS or GCP diff --git a/tidb-cloud/tidb-cloud-billing.md b/tidb-cloud/tidb-cloud-billing.md index 85aa1d3c4eaf6..47ea19381c1e6 100644 --- a/tidb-cloud/tidb-cloud-billing.md +++ b/tidb-cloud/tidb-cloud-billing.md @@ -7,12 +7,12 @@ summary: Learn about TiDB Cloud billing. > **Note:** > -> [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) are free until May 31, 2023, with a 100% discount off. After that, usage beyond the [free quota](/tidb-cloud/select-cluster-tier.md#usage-quota) will be charged. +> [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) are free until May 31, 2023, with a 100% discount off. After that, usage beyond the [free quota](/tidb-cloud/select-cluster-tier.md#usage-quota) will be charged. TiDB Cloud charges according to the resources that you consume. You can visit the following pages to get more information about the pricing. -- [TiDB Cloud Serverless Tier Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details) -- [TiDB Cloud Dedicated Tier Pricing Details](https://en.pingcap.com/tidb-cloud-pricing-details/) +- [TiDB Serverless Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details) +- [TiDB Dedicated Pricing Details](https://en.pingcap.com/tidb-cloud-pricing-details/) ## Invoices diff --git a/tidb-cloud/tidb-cloud-console-auditing.md b/tidb-cloud/tidb-cloud-console-auditing.md index 61c82d92ce64a..bc2e7c15cb7ab 100644 --- a/tidb-cloud/tidb-cloud-console-auditing.md +++ b/tidb-cloud/tidb-cloud-console-auditing.md @@ -29,7 +29,7 @@ To disable console audit logging, take the following steps: ## View console audit logs -You can only view the console audit logs of your organization. +You can only view the console audit logs of your organization. > **Note:** > @@ -37,8 +37,8 @@ You can only view the console audit logs of your organization. > - If it has been more than 90 days since console audit logging was disabled, you cannot see any logs. 1. In the upper-right corner of the [TiDB Cloud console](https://tidbcloud.com/), click **Organization** > **Console Audit Logging**. -2. To get a specific part of audit logs, you can filter the event type, operation status, and time range. -3. (Optional) To filter more fields, click **Advanced filter**, add more filters, and then click **Apply**. +2. To get a specific part of audit logs, you can filter the event type, operation status, and time range. +3. (Optional) To filter more fields, click **Advanced filter**, add more filters, and then click **Apply**. 4. Click the row of a log to view its detailed information in the right pane. ## Export console audit logs @@ -47,7 +47,7 @@ To export the console audit logs of your organization, take the following step: 1. In the upper-right corner of the [TiDB Cloud console](https://tidbcloud.com/), click **Organization** > **Console Audit Logging**. 2. (Optional) If you need to export a specific part of console audit logs, you can filter through various conditions. Otherwise, skip this step. -3. Click **Export** and select the desired export format in JSON or CSV. +3. Click **Export** and select the desired export format in JSON or CSV. ## Console audit log storage policy @@ -64,7 +64,7 @@ The console audit logs record various user activities on the TiDB Cloud console > **Note:** > -> Currently, most event types on the TiDB Cloud console can be audited, and you can find them in the following table. For the remaining event types that are not covered yet, TiDB Cloud will continuously work on including them as well. +> Currently, most event types on the TiDB Cloud console can be audited, and you can find them in the following table. For the remaining event types that are not covered yet, TiDB Cloud will continuously work on including them as well. | Console audit event type | Description | |---|---| @@ -147,7 +147,7 @@ The console audit logs record various user activities on the TiDB Cloud console | BindSupportPlan | Bind a support plan | | CancelSupportPlan | Cancel a support plan | | UpdateOrganizationName | Update the organization name | -| SetSpendLimit | Edit the spend limit of a Serverless Tier cluster | +| SetSpendLimit | Edit the spend limit of a TiDB Serverless cluster | | UpdateMaintenanceWindow | Modify maintenance window start time | | DeferMaintenanceTask | Defer a maintenance task | diff --git a/tidb-cloud/tidb-cloud-encrypt-cmek.md b/tidb-cloud/tidb-cloud-encrypt-cmek.md index 10ea51a89dd5d..5a841735ac6d9 100644 --- a/tidb-cloud/tidb-cloud-encrypt-cmek.md +++ b/tidb-cloud/tidb-cloud-encrypt-cmek.md @@ -5,7 +5,7 @@ summary: Learn about how to use Customer-Managed Encryption Key (CMEK) in TiDB C # Encryption at Rest Using Customer-Managed Encryption Keys -Customer-Managed Encryption Key (CMEK) lets you protect your static data in a TiDB Cloud Dedicated Tier using a cryptographic key that is completely controlled by you. This key is known as the CMEK key. +Customer-Managed Encryption Key (CMEK) lets you protect your static data in a TiDB Dedicated cluster using a cryptographic key that is completely controlled by you. This key is known as the CMEK key. After you enable CMEK for a project, all clusters created within this project encrypt their static data using this CMEK key, and any backup data produced by these clusters is also encrypted using the same key. If you do not enable CMEK, TiDB Cloud uses an escrow key to encrypt all data in your cluster at rest. @@ -17,7 +17,7 @@ After you enable CMEK for a project, all clusters created within this project en - Currently, TiDB Cloud only supports using AWS KMS to provide CMEK. - To use CMEK, you need to enable CMEK when creating a project and complete CMEK-related configurations before creating a cluster. You cannot enable CMEK for existing projects. -- Currently, in CMEK-enabled projects, you can only create [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters hosted on AWS. Dedicated Tier clusters hosted on GCP and [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters are not supported. +- Currently, in CMEK-enabled projects, you can only create [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters hosted on AWS. TiDB Dedicated clusters hosted on GCP and [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters are not supported. - Currently, for a specific project, you can only enable CMEK for one AWS region. Once you have configured it, you cannot create clusters in other regions within the same project. ## Enable CMEK @@ -99,7 +99,7 @@ If you want to encrypt your data using the KMS owned by your account, take the f ### Step 3. Create a cluster -Create a Dedicated Tier cluster hosted on AWS under the project created in Step 1. Ensure that the region where the cluster is located is the same as that in Step 2. +Create a TiDB Dedicated cluster hosted on AWS under the project created in Step 1. Ensure that the region where the cluster is located is the same as that in Step 2. > **Note:** > diff --git a/tidb-cloud/tidb-cloud-events.md b/tidb-cloud/tidb-cloud-events.md index b5c07d19612c0..5c130cad5d49a 100644 --- a/tidb-cloud/tidb-cloud-events.md +++ b/tidb-cloud/tidb-cloud-events.md @@ -1,6 +1,6 @@ --- title: TiDB Cloud Cluster Events -summary: Learn how to view the events for TiDB Cloud clusters using the Events page. +summary: Learn how to view the events for TiDB Cloud clusters using the Events page. --- # TiDB Cloud Cluster Events @@ -11,7 +11,7 @@ This document describes how to view the events for TiDB Cloud clusters using the > **Note:** > -> Currently, the Events page is only available for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +> Currently, the Events page is only available for [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. ## View the Events page @@ -30,7 +30,7 @@ To view the events on the Events page, take the following steps: TiDB Cloud logs the following types of cluster events: -| Event Type| Description | +| Event Type| Description | |:--- |:--- | | CreateCluster | Create a cluster | | PauseCluster | Pause a cluster | @@ -57,8 +57,8 @@ For each event, the following information is logged: > **Note:** > -> Cluster events started before 2023-03-22 are not visible on the Events page. +> Cluster events started before 2023-03-22 are not visible on the Events page. ## Event retention policy -For Dedicated Tier clusters, the event data is kept for 7 days. +For TiDB Dedicated clusters, the event data is kept for 7 days. diff --git a/tidb-cloud/tidb-cloud-faq.md b/tidb-cloud/tidb-cloud-faq.md index ebda1e5ba2c94..f16337c83a0c2 100644 --- a/tidb-cloud/tidb-cloud-faq.md +++ b/tidb-cloud/tidb-cloud-faq.md @@ -19,7 +19,7 @@ TiDB Cloud allows developers and DBAs with little or no training to handle once- ### What is the relationship between TiDB and TiDB Cloud? -TiDB is an open-source database and is the best option for organizations who want to run TiDB on-premises in their own data centers, in a self-managed cloud environment, or in a hybrid of the two. +TiDB is an open-source database and is the best option for organizations who want to run TiDB Self-Hosted in their own data centers, in a self-managed cloud environment, or in a hybrid of the two. TiDB Cloud is a fully managed cloud Database as a Service of TiDB. It has an easy-to-use web-based management console to let you manage TiDB clusters for mission-critical production environments. @@ -121,9 +121,9 @@ No. TiFlash data cannot be exported. ### Is TiDB Cloud secure? -In TiDB Cloud, all data at rest is encrypted, and all network traffic is encrypted using Transport Layer Security (TLS). +In TiDB Cloud, all data at rest is encrypted, and all network traffic is encrypted using Transport Layer Security (TLS). -- Encryption of data at rest is automated using encrypted storage volumes. +- Encryption of data at rest is automated using encrypted storage volumes. - Encryption of data in transit between your client and your cluster is automated using TiDB Cloud web server TLS and TiDB cluster TLS. ### How does TiDB Cloud encrypt my business data? @@ -142,16 +142,16 @@ No. TiDB Cloud is Database-as-a-Service (DBaaS) and runs only in the TiDB Cloud ### Is my TiDB cluster secure? -In TiDB Cloud, you can use either a Dedicated Tier cluster or a Serverless Tier cluster according to your needs. +In TiDB Cloud, you can use either a TiDB Dedicated cluster or a TiDB Serverless cluster according to your needs. -For Dedicated Tier clusters, TiDB Cloud ensures cluster security with the following measures: +For TiDB Dedicated clusters, TiDB Cloud ensures cluster security with the following measures: - Creates independent sub-accounts and VPCs for each cluster. - Sets up firewall rules to isolate external connections. - Creates server-side TLS certificates and component-level TLS certificates for each cluster to encrypt cluster data in transit. - Provide IP access rules for each cluster to ensure that only allowed source IP addresses can access your cluster. -For Serverless Tier clusters, TiDB Cloud ensures cluster security with the following measures: +For TiDB Serverless clusters, TiDB Cloud ensures cluster security with the following measures: - Creates independent sub-accounts for each cluster. - Sets up firewall rules to isolate external connections. @@ -159,23 +159,23 @@ For Serverless Tier clusters, TiDB Cloud ensures cluster security with the follo ### How do I connect to my database in a TiDB cluster? -For a Dedicated Tier cluster, the steps to connect to your cluster are simplified as follows: +For a TiDB Dedicated cluster, the steps to connect to your cluster are simplified as follows: 1. Authorize your network. 2. Set up your database users and login credentials. 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 a Serverless Tier cluster, the steps to connect to your cluster are simplified as follows: +For a TiDB Serverless cluster, the steps to connect to your cluster are simplified as follows: -1. Set a database user and login credential. +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). ### Who has access to my business data of a database cluster? -Only you can access your table data in your own TiDB cluster. TiDB Cloud Support cannot directly access the data in your TiDB cluster. The only exception is that when you need to improve products and solve cluster operation problems, TiDB Cloud Support can access the cluster operation data after you provide your internal temporary authorization. All authorization and access records are audited annually by third-party audit organizations, for example, PCI-DSS, SOC2, and ISO27701. +Only you can access your table data in your own TiDB cluster. TiDB Cloud Support cannot directly access the data in your TiDB cluster. The only exception is that when you need to improve products and solve cluster operation problems, TiDB Cloud Support can access the cluster operation data after you provide your internal temporary authorization. All authorization and access records are audited annually by third-party audit organizations, for example, PCI-DSS, SOC2, and ISO27701. TiDB Cloud operational data is described in [TiDB Cloud Privacy Policy](https://www.pingcap.com/privacy-policy/) and [TiDB Cloud Data Processing Agreement](https://www.pingcap.com/legal/data-processing-agreement-for-tidb-cloud-services/). diff --git a/tidb-cloud/tidb-cloud-glossary.md b/tidb-cloud/tidb-cloud-glossary.md index f1721d5c92ae9..00ce64c1c2cc4 100644 --- a/tidb-cloud/tidb-cloud-glossary.md +++ b/tidb-cloud/tidb-cloud-glossary.md @@ -29,11 +29,7 @@ TiDB Cloud is powered by AI. You can use Chat2Query (beta), an AI-powered SQL ed 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. For more information, see [Chat2Query (beta)](/tidb-cloud/explore-data-with-chat2query.md). -In addition, TiDB Cloud provides a Chat2Query API for Serverless Tier clusters. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). - -### cluster tier - -Determines the functionality and capacity of your cluster. Different cluster tiers provide different numbers of TiDB, TiKV, and TiFlash nodes in your cluster. +In addition, TiDB Cloud provides a Chat2Query API for TiDB Serverless clusters. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). ### Credit @@ -123,13 +119,13 @@ The replication of changefeed is charged according to the computing resources, w ### Request Unit -A Request Unit (RU) is a unit of measure used to represent the amount of resources consumed by a single request to the database. The amount of RUs consumed by a request depends on various factors, such as the operation type or the amount of data being retrieved or modified. For more information, see [TiDB Cloud Serverless Tier Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). +A Request Unit (RU) is a unit of measure used to represent the amount of resources consumed by a single request to the database. The amount of RUs consumed by a request depends on various factors, such as the operation type or the amount of data being retrieved or modified. For more information, see [TiDB Serverless Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). ## S ### Spend limit -Spend limit refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that allows you to set a budget for your Serverless Tier clusters. When the spend limit of a cluster is greater than 0, the cluster is considered a paid cluster. Also, the paid cluster can have a free quota if it meets the qualifications. The paid cluster with a free quota will consume the free quota first. +Spend limit refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that allows you to set a budget for your TiDB Serverless clusters. When the spend limit of a cluster is greater than 0, the cluster is considered a paid cluster. Also, the paid cluster can have a free quota if it meets the qualifications. The paid cluster with a free quota will consume the free quota first. ## T diff --git a/tidb-cloud/tidb-cloud-guide-sample-application-java.md b/tidb-cloud/tidb-cloud-guide-sample-application-java.md index 8a296b98a40bf..d38edc2b5a64f 100644 --- a/tidb-cloud/tidb-cloud-guide-sample-application-java.md +++ b/tidb-cloud/tidb-cloud-guide-sample-application-java.md @@ -22,9 +22,9 @@ This document describes how to use TiDB and Java to build a simple CRUD applicat The following introduces how to start a TiDB cluster. -**Use a TiDB Cloud Serverless Tier cluster** +**Use a TiDB Serverless cluster** -For detailed steps, see [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +For detailed steps, see [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). **Use a local cluster** @@ -34,7 +34,7 @@ For detailed steps, see [Deploy a local test cluster](/quick-start-with-tidb.md# -See [Create a Serverless Tier cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-serverless-tier-cluster). +See [Create a TiDB Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md#step-1-create-a-tidb-serverless-cluster). @@ -293,7 +293,7 @@ public interface PlayerMapper { id, coins, goods - select + select from player where `id` = #{id,jdbcType=VARCHAR} @@ -1448,7 +1448,7 @@ When using JDBC, you need to connect to your cluster and run the statement in th
-If you are using a TiDB Cloud Serverless Tier cluster, modify the `dataSource.url`, `dataSource.username`, `dataSource.password` in `mybatis-config.xml`. +If you are using a TiDB Serverless cluster, modify the `dataSource.url`, `dataSource.username`, `dataSource.password` in `mybatis-config.xml`. ```xml @@ -1523,7 +1523,7 @@ In this case, you can modify the parameters in `dataSource` node as follows:
-If you are using a TiDB Cloud Serverless Tier cluster, modify the `hibernate.connection.url`, `hibernate.connection.username`, `hibernate.connection.password` in `hibernate.cfg.xml`. +If you are using a TiDB Serverless cluster, modify the `hibernate.connection.url`, `hibernate.connection.username`, `hibernate.connection.password` in `hibernate.cfg.xml`. ```xml @@ -1589,7 +1589,7 @@ In this case, you can modify the parameters as follows:
-If you are using a TiDB Cloud Serverless Tier cluster, modify the parameters of the host, port, user, and password in `JDBCExample.java`: +If you are using a TiDB Serverless cluster, modify the parameters of the host, port, user, and password in `JDBCExample.java`: ```java mysqlDataSource.setServerName("localhost"); diff --git a/tidb-cloud/tidb-cloud-import-local-files.md b/tidb-cloud/tidb-cloud-import-local-files.md index 6d6633395c8c3..950517a858be0 100644 --- a/tidb-cloud/tidb-cloud-import-local-files.md +++ b/tidb-cloud/tidb-cloud-import-local-files.md @@ -12,7 +12,7 @@ Currently, this method supports importing one CSV file for one task into either ## Limitations - Currently, TiDB Cloud only supports importing a local file in CSV format within 50 MiB for one task. -- Importing local files is supported only for Serverless Tier clusters, not for Dedicated Tier clusters. +- Importing local files is supported only for TiDB Serverless clusters, not for TiDB Dedicated clusters. - You cannot run more than one import task at the same time. - If you import a CSV file into an existing table in TiDB Cloud, make sure that the first line of the CSV file contains the column names, and the order of the columns in the CSV file must be the same as that in the target table. diff --git a/tidb-cloud/tidb-cloud-migration-overview.md b/tidb-cloud/tidb-cloud-migration-overview.md index f8d2ff5583c08..c6892a8429101 100644 --- a/tidb-cloud/tidb-cloud-migration-overview.md +++ b/tidb-cloud/tidb-cloud-migration-overview.md @@ -26,9 +26,9 @@ When you migrate data from a MySQL-compatible database, you can perform full dat If your application uses MySQL shards for data storage, you can migrate these shards into TiDB Cloud as one table. For more information, see [Migrate and Merge MySQL Shards of Large Datasets to TiDB Cloud](/tidb-cloud/migrate-sql-shards.md). -- Migrate from on-premises TiDB +- Migrate from TiDB Self-Hosted - You can migrate data from your on-premises (OP) TiDB clusters to TiDB Cloud (AWS) through Dumpling and TiCDC. For more information, see [Migrate from On-Premises TiDB to TiDB Cloud](/tidb-cloud/migrate-from-op-tidb.md). + You can migrate data from your TiDB Self-Hosted clusters to TiDB Cloud (AWS) through Dumpling and TiCDC. For more information, see [Migrate from TiDB Self-Hosted to TiDB Cloud](/tidb-cloud/migrate-from-op-tidb.md). ## Import data from files to TiDB Cloud diff --git a/tidb-cloud/tidb-cloud-poc.md b/tidb-cloud/tidb-cloud-poc.md index e1bbd1d994ec6..a0d1cceefe573 100644 --- a/tidb-cloud/tidb-cloud-poc.md +++ b/tidb-cloud/tidb-cloud-poc.md @@ -13,7 +13,7 @@ This document describes the typical PoC procedures and aims to help you quickly If you are interested in doing a PoC, feel free to contact PingCAP before you get started. The support team can help you create a test plan and walk you through the PoC procedures smoothly. -Alternatively, you can [create a Serverless Tier](/tidb-cloud/tidb-cloud-quickstart.md#step-1-create-a-tidb-cluster) to get familiar with TiDB Cloud for a quick evaluation. Note that the Serverless Tier has some [special terms and conditions](/tidb-cloud/select-cluster-tier.md#serverless-tier-special-terms-and-conditions). +Alternatively, you can [create a TiDB Serverless](/tidb-cloud/tidb-cloud-quickstart.md#step-1-create-a-tidb-cluster) to get familiar with TiDB Cloud for a quick evaluation. Note that the TiDB Serverless has some [special terms and conditions](/tidb-cloud/select-cluster-tier.md#tidb-serverless-special-terms-and-conditions). ## Overview of the PoC procedures @@ -23,7 +23,7 @@ A typical TiDB Cloud PoC consists of the following steps: 1. Define success criteria and create a test plan 2. Identify characteristics of your workload -3. Sign up and create a dedicated cluster for the PoC +3. Sign up and create a TiDB Dedicated cluster for the PoC 4. Adapt your schemas and SQL 5. Import data 6. Run your workload and evaluate results @@ -56,9 +56,9 @@ TiDB Cloud is suitable for various use cases that require high availability and You might also be interested in using [TiFlash](https://docs.pingcap.com/tidb/stable/tiflash-overview), a columnar storage engine that helps speed up analytical processing. During the PoC, you can use the TiFlash feature at any time. -## Step 3. Sign up and create a dedicated cluster for the PoC +## Step 3. Sign up and create a TiDB Dedicated cluster for the PoC -To create a dedicated cluster for the PoC, take the following steps: +To create a TiDB Dedicated cluster for the PoC, take the following steps: 1. Fill in the PoC application form by doing one of the following: @@ -67,12 +67,12 @@ To create a 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 [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) cluster for the PoC. +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. 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 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 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). @@ -87,7 +87,7 @@ For a newly created cluster, note the following configurations: Next, you can load your database schemas to the TiDB cluster, including tables and indexes. -Because the amount of PoC credits is limited, to maximize the value of credits, it is recommended that you create a [Serverless Tier cluster](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) for compatibility tests and preliminary analysis on TiDB Cloud. +Because the amount of PoC credits is limited, to maximize the value of credits, it is recommended that you create a [TiDB Serverless cluster](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) for compatibility tests and preliminary analysis on TiDB Cloud. TiDB Cloud is highly compatible with MySQL 5.7. You can directly import your data into TiDB if it is MySQL-compatible or can be adapted to be compatible with MySQL. @@ -181,7 +181,7 @@ Now the workload testing is finished, you can explore more features, for example You have completed the full cycle of a PoC after you test TiDB Cloud using real workloads and get the testing results. These results help you determine if TiDB Cloud meets your expectations. Meanwhile, you have accumulated best practices for using TiDB Cloud. -If you want to try TiDB Cloud on a larger scale, for a new round of deployments and tests, such as deploying with other node storage sizes offered by TiDB Cloud, get full access to TiDB Cloud by creating a [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier). +If you want to try TiDB Cloud on a larger scale, for a new round of deployments and tests, such as deploying with other node storage sizes offered by TiDB Cloud, get full access to TiDB Cloud by creating a [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster. If your credits are running out and you want to continue with the PoC, contact the [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) for consultation. diff --git a/tidb-cloud/tidb-cloud-quickstart.md b/tidb-cloud/tidb-cloud-quickstart.md index e13a613439a20..54caf86873181 100644 --- a/tidb-cloud/tidb-cloud-quickstart.md +++ b/tidb-cloud/tidb-cloud-quickstart.md @@ -12,7 +12,7 @@ This tutorial guides you through an easy way to get started with your TiDB Cloud ## Step 1. Create a TiDB cluster -TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) (Beta) is the best way to get started with TiDB Cloud. To create a Serverless Tier cluster, take the following steps: +[TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) (Beta) is the best way to get started with TiDB Cloud. To create a TiDB Serverless cluster, take the following steps: 1. If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up for an account. @@ -22,13 +22,13 @@ TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier- The [**Clusters**](https://tidbcloud.com/console/clusters) page is displayed by default. -3. For new sign-up users, TiDB Cloud creates a default Serverless Tier cluster `Cluster0` for you automatically. +3. For new sign-up users, TiDB Cloud creates a default TiDB Serverless cluster `Cluster0` for you automatically. - To try out TiDB Cloud features instantly with this default cluster, go to [Step 2. Try AI-powered Chat2Query (beta)](#step-2-try-ai-powered-chat2query-beta). - - To try creating a new Serverless Tier cluster on your own, take the following operations: + - To try creating a new TiDB Serverless cluster on your own, take the following operations: 1. Click **Create Cluster**. - 2. On the **Create Cluster** page, **Serverless** is selected by default. Select a target region of your cluster, update the default cluster name if necessary, and then click **Create**. Your Serverless Tier cluster will be created in approximately 30 seconds. + 2. On the **Create Cluster** page, **Serverless** is selected by default. Select a target region of your cluster, update the default cluster name if necessary, and then click **Create**. Your TiDB Serverless cluster will be created in approximately 30 seconds. ## Step 2. Try AI-powered Chat2Query (beta) @@ -90,4 +90,4 @@ TiDB Cloud offers interactive tutorials with crafted sample datasets to help you - For how to connect to your cluster via different methods, see [Connect to a TiDB cluster](/tidb-cloud/connect-to-tidb-cluster.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 Dedicated Tier 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 cluster](/tidb-cloud/create-tidb-cluster.md) to create a TiDB Dedicated cluster. diff --git a/tidb-cloud/tidb-cloud-release-notes.md b/tidb-cloud/tidb-cloud-release-notes.md index 28d2c802d15df..7ea75d262f4a9 100644 --- a/tidb-cloud/tidb-cloud-release-notes.md +++ b/tidb-cloud/tidb-cloud-release-notes.md @@ -61,7 +61,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Import CSV Files from Amazon S3 or GCS into TiDB Cloud](/tidb-cloud/import-csv-files.md) and [Import Sample Data](/tidb-cloud/import-sample-data.md). -- Support AWS PrivateLink-powered endpoint connection as a new network access management option for TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- Support AWS PrivateLink-powered endpoint connection as a new network access management option for TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. The private endpoint connection does not expose your data to the public internet. In addition, the endpoint connection supports CIDR overlap and is easier for network management. @@ -69,11 +69,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Add new event types to the [**Event**](/tidb-cloud/tidb-cloud-events.md) page to record backup, restore, and changefeed actions for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +- Add new event types to the [**Event**](/tidb-cloud/tidb-cloud-events.md) page to record backup, restore, and changefeed actions for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. To get a full list of the events that can be recorded, see [Logged events](/tidb-cloud/tidb-cloud-events.md#logged-events). -- Introduce the **SQL Statement** tab on the [**SQL Diagnosis**](/tidb-cloud/tune-performance.md) page for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- Introduce the **SQL Statement** tab on the [**SQL Diagnosis**](/tidb-cloud/tune-performance.md) page for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. The **SQL Statement** tab provides the following: @@ -87,7 +87,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Support directly accessing the [Data Service endpoint](/tidb-cloud/tidb-cloud-glossary.md#endpoint) in the region where a TiDB [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster is located. +- Support directly accessing the [Data Service endpoint](/tidb-cloud/tidb-cloud-glossary.md#endpoint) in the region where a TiDB [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster is located. For newly created Serverless Tier clusters, the endpoint URL now includes the cluster region information. By requesting the regional domain `.data.tidbcloud.com`, you can directly access the endpoint in the region where the TiDB cluster is located. @@ -99,24 +99,24 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- For the first five [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: +- For the first five [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: - Row storage: 5 GiB - [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit): 50 million RUs per month Until May 31, 2023, Serverless Tier clusters are still free, with a 100% discount off. After that, usage beyond the free quota will be charged. - You can easily [monitor your cluster usage or increase your usage quota](/tidb-cloud/manage-serverless-spend-limit.md#manage-spend-limit-for-serverless-tier-clusters) in the **Usage This Month** area of your cluster **Overview** page. Once the free quota of a cluster is reached, the read and write operations on this cluster will be throttled until you increase the quota or the usage is reset upon the start of a new month. + You can easily [monitor your cluster usage or increase your usage quota](/tidb-cloud/manage-serverless-spend-limit.md#manage-spend-limit-for-tidb-serverless-clusters) in the **Usage This Month** area of your cluster **Overview** page. Once the free quota of a cluster is reached, the read and write operations on this cluster will be throttled until you increase the quota or the usage is reset upon the start of a new month. For more information about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [TiDB Cloud Serverless Tier Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). -- Support backup and restore for TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- 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#serverless-tier). + For more information, see [Back up and Restore TiDB Cluster Data](/tidb-cloud/backup-and-restore.md#tidb-serverless). -- Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) 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). +- 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). -- Provide a maintenance window feature to enable you to easily schedule and manage planned maintenance activities for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +- Provide a maintenance window feature to enable you to easily schedule and manage planned maintenance activities for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. 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. @@ -129,7 +129,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Configure maintenance window](/tidb-cloud/configure-maintenance-window.md). -- Improve load balancing of TiDB and reduce connection drops when you scale TiDB nodes of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters that are hosted on AWS and created after April 25, 2023. +- Improve load balancing of TiDB and reduce connection drops when you scale TiDB nodes of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters that are hosted on AWS and created after April 25, 2023. - Support automatically migrating existing connections to new TiDB nodes when you scale out TiDB nodes. - Support automatically migrating existing connections to available TiDB nodes when you scale in TiDB nodes. @@ -138,7 +138,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Release a new native web infrastructure for the [Monitoring](/tidb-cloud/built-in-monitoring.md#view-the-metrics-page) page of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +- Release a new native web infrastructure for the [Monitoring](/tidb-cloud/built-in-monitoring.md#view-the-metrics-page) page of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. With the new infrastructure, you can easily navigate through the [Monitoring](/tidb-cloud/built-in-monitoring.md#view-the-metrics-page) page and access the necessary information in a more intuitive and efficient manner. The new infrastructure also resolves many problems on UX, making the monitoring process more user-friendly. @@ -146,7 +146,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Support scaling up or down [Data Migration job specifications](/tidb-cloud/tidb-cloud-billing-dm.md#specifications-for-data-migration) for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +- Support scaling up or down [Data Migration job specifications](/tidb-cloud/tidb-cloud-billing-dm.md#specifications-for-data-migration) for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. With this feature, you can improve migration performance by scaling up specifications or reduce costs by scaling down specifications. @@ -168,14 +168,14 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Improve the load balance of TiDB and reduce connection drops when you scale TiDB nodes of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters hosted on AWS. +- Improve the load balance of TiDB and reduce connection drops when you scale TiDB nodes of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters hosted on AWS. - Support automatically migrating existing connections to new TiDB nodes when you scale out TiDB nodes. - Support automatically migrating existing connections to available TiDB nodes when you scale in TiDB nodes. Currently, this feature is only provided for Dedicated Tier clusters that are hosted on the AWS `Oregon (us-west-2)` region. -- Support the [New Relic](https://newrelic.com/) integration for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters. +- Support the [New Relic](https://newrelic.com/) integration for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters. With the New Relic integration, you can configure TiDB Cloud to send metric data of your TiDB clusters to [New Relic](https://newrelic.com/). Then, you can monitor and analyze both your application performance and your TiDB database performance on [New Relic](https://newrelic.com/). This feature can help you quickly identify and troubleshoot potential issues and reduce the resolution time. @@ -190,7 +190,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Update the [Monitoring](/tidb-cloud/built-in-monitoring.md#view-the-metrics-page) page for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters to use [node-level resource metrics](/tidb-cloud/built-in-monitoring.md#server). +- Update the [Monitoring](/tidb-cloud/built-in-monitoring.md#view-the-metrics-page) page for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters to use [node-level resource metrics](/tidb-cloud/built-in-monitoring.md#server). With node-level resource metrics, you can see a more accurate representation of resource consumption to better understand the actual usage of purchased services. @@ -209,7 +209,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Introduce the [Alerts](/tidb-cloud/monitor-built-in-alerting.md) page for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters, which lists both active and closed alerts for each Dedicated Tier cluster. +- Introduce the [Alerts](/tidb-cloud/monitor-built-in-alerting.md) page for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters, which lists both active and closed alerts for each Dedicated Tier cluster. The **Alerts** page provides the following: @@ -253,11 +253,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Scale a changefeed](/tidb-cloud/changefeed-overview.md#scale-a-changefeed). -- Support replicating incremental data in real-time from a [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) cluster in AWS to a [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster in the same project and same region. +- Support replicating incremental data in real-time from a [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster in AWS to a [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster in the same project and same region. For more information, see [Sink to TiDB Cloud](/tidb-cloud/changefeed-sink-to-tidb-cloud.md). -- Support two new GCP regions for the [Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md) feature of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters: `Singapore (asia-southeast1)` and `Oregon (us-west1)`. +- Support two new GCP regions for the [Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md) feature of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters: `Singapore (asia-southeast1)` and `Oregon (us-west1)`. With these new regions, you have more options for migrating your data to TiDB Cloud. If your upstream data is stored in or near these regions, you can now take advantage of faster and more reliable data migration from GCP to TiDB Cloud. @@ -265,7 +265,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Release a new native web infrastructure for the [Slow Query](/tidb-cloud/tune-performance.md#slow-query) page of [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- Release a new native web infrastructure for the [Slow Query](/tidb-cloud/tune-performance.md#slow-query) page of [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. With this new infrastructure, you can easily navigate through the [Slow Query](/tidb-cloud/tune-performance.md#slow-query) page and access the necessary information in a more intuitive and efficient manner. The new infrastructure also resolves many problems on UX, making the SQL diagnosis process more user-friendly. @@ -273,7 +273,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Introduce [Data Service (beta)](https://tidbcloud.com/console/data-service) for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters, which enables you to access data via an HTTPS request using a custom API endpoint. +- Introduce [Data Service (beta)](https://tidbcloud.com/console/data-service) for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters, which enables you to access data via an HTTPS request using a custom API endpoint. With Data Service, you can seamlessly integrate TiDB Cloud with any application or service that is compatible with HTTPS. The following are some common scenarios: @@ -290,11 +290,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - [Get Started with Data Service](/tidb-cloud/data-service-get-started.md) - [Get Started with Chat2Query API](/tidb-cloud/use-chat2query-api.md) -- Support decreasing the size of TiDB, TiKV, and TiFlash nodes to scale in a [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) cluster that is hosted on AWS and created after December 31, 2022. +- Support decreasing the size of TiDB, TiKV, and TiFlash nodes to scale in a [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster that is hosted on AWS and created after December 31, 2022. You can decrease the node size [via the TiDB Cloud console](/tidb-cloud/scale-tidb-cluster.md#change-node-size) or [via the TiDB Cloud API (beta)](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster). -- Support a new GCP region for the [Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md) feature of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters: `Tokyo (asia-northeast1)`. +- Support a new GCP region for the [Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md) feature of [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters: `Tokyo (asia-northeast1)`. The feature can help you migrate data from MySQL-compatible databases in Google Cloud Platform (GCP) to your TiDB cluster easily and efficiently. @@ -302,13 +302,13 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Introduce the **Events** page for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters, which provides the records of main changes to your cluster. +- Introduce the **Events** page for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters, which provides the records of main changes to your cluster. On this page, you can view the event history for the last 7 days and track important details such as the trigger time and the user who initiated an action. For example, you can view events such as when a cluster was paused or who modified the cluster size. For more information, see [TiDB Cloud cluster events](/tidb-cloud/tidb-cloud-events.md). -- Add the **Database Status** tab to the **Monitoring** page for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters, which displays the following database-level metrics: +- Add the **Database Status** tab to the **Monitoring** page for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters, which displays the following database-level metrics: - QPS Per DB - Average Query Duration Per DB @@ -322,11 +322,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters from [v6.5.0](https://docs.pingcap.com/tidb/v6.5/release-6.5.0) to [v6.5.1](https://docs.pingcap.com/tidb/v6.5/release-6.5.1). +- Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters from [v6.5.0](https://docs.pingcap.com/tidb/v6.5/release-6.5.0) to [v6.5.1](https://docs.pingcap.com/tidb/v6.5/release-6.5.1). - Support modifying column names of the target table to be created by TiDB Cloud when uploading a local CSV file with a header row. - When importing a local CSV file with a header row to a [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster, if you need TiDB Cloud to create the target table and the column names in the header row do not follow the TiDB Cloud column naming conventions, you will see a warning icon next to the corresponding column name. To resolve the warning, you can move the cursor over the icon and follow the message to edit the existing column names or enter new column names. + When importing a local CSV file with a header row to a [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster, if you need TiDB Cloud to create the target table and the column names in the header row do not follow the TiDB Cloud column naming conventions, you will see a warning icon next to the corresponding column name. To resolve the warning, you can move the cursor over the icon and follow the message to edit the existing column names or enter new column names. For information about column naming conventions, see [Import local files](/tidb-cloud/tidb-cloud-import-local-files.md#import-local-files). @@ -334,13 +334,13 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Upgrade the default TiDB version of all [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters from [v6.4.0](https://docs.pingcap.com/tidb/v6.4/release-6.4.0) to [v6.6.0](https://docs.pingcap.com/tidb/v6.6/release-6.6.0). +- Upgrade the default TiDB version of all [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters from [v6.4.0](https://docs.pingcap.com/tidb/v6.4/release-6.4.0) to [v6.6.0](https://docs.pingcap.com/tidb/v6.6/release-6.6.0). ## February 28, 2023 **General changes** -- Add the [SQL Diagnosis](/tidb-cloud/tune-performance.md) feature for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- Add the [SQL Diagnosis](/tidb-cloud/tune-performance.md) feature for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. With SQL Diagnosis, you can gain deep insights into SQL-related runtime status, which makes the SQL performance tuning more efficient. Currently, the SQL Diagnosis feature for Serverless Tier only provides slow query data. @@ -404,7 +404,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Release a new native web infrastructure on the Monitoring page of [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- Release a new native web infrastructure on the Monitoring page of [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. With the new infrastructure, you can easily navigate through the Monitoring page and access the necessary information in a more intuitive and efficient manner. The new infrastructure also resolves many problems on UX, making the monitoring process a lot more user-friendly. @@ -420,13 +420,13 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Support decreasing the number of TiKV and TiFlash nodes to scale in a TiDB [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) cluster. +- Support decreasing the number of TiKV and TiFlash nodes to scale in a TiDB [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) cluster. You can decrease the node number [via the TiDB Cloud console](/tidb-cloud/scale-tidb-cluster.md#change-node-number) or [via the TiDB Cloud API (beta)](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster). **Console changes** -- Introduce the **Monitoring** page for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- Introduce the **Monitoring** page for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. The **Monitoring** page provides a range of metrics and data, such as the number of SQL statements executed per second, the average duration of queries, and the number of failed queries, which helps you better understand the overall performance of SQL statements in your Serverless Tier cluster. @@ -452,11 +452,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters from [v6.1.3](https://docs.pingcap.com/tidb/stable/release-6.1.3) to [v6.5.0](https://docs.pingcap.com/tidb/stable/release-6.5.0). +- Upgrade the default TiDB version of new [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters from [v6.1.3](https://docs.pingcap.com/tidb/stable/release-6.1.3) to [v6.5.0](https://docs.pingcap.com/tidb/stable/release-6.5.0). -- For new sign-up users, TiDB Cloud will automatically create a free [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster so that you can quickly start a data exploration journey with TiDB Cloud. +- For new sign-up users, TiDB Cloud will automatically create a free [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) cluster so that you can quickly start a data exploration journey with TiDB Cloud. -- Support a new AWS region for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) clusters: `Seoul (ap-northeast-2)`. +- Support a new AWS region for [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) clusters: `Seoul (ap-northeast-2)`. The following features are enabled for this region: @@ -468,7 +468,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Optimize the feature of importing data from local CSV files to TiDB to improve the user experience for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +- Optimize the feature of importing data from local CSV files to TiDB to improve the user experience for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. - To upload a CSV file, now you can simply drag and drop it to the upload area on the **Import** page. - When creating an import task, if your target database or table does not exist, you can enter a name to let TiDB Cloud create it for you automatically. For the target table to be created, you can specify a primary key or select multiple fields to form a composite primary key. @@ -489,7 +489,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Rename SQL Editor (beta) to Chat2Query (beta) for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters and support generating SQL queries using AI. +- Rename SQL Editor (beta) to Chat2Query (beta) for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters and support generating SQL queries using AI. In Chat2Query, you can either let AI generate SQL queries automatically or write SQL queries manually, and run SQL queries against databases without a terminal. @@ -499,7 +499,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Support scaling up TiDB, TiKV, and TiFlash nodes by increasing the **Node Size(vCPU + RAM)** for TiDB Dedicated Tier clusters hosted on AWS and created after December 31, 2022. +- Support scaling up TiDB, TiKV, and TiFlash nodes by increasing the **Node Size(vCPU + RAM)** for TiDB Dedicated clusters hosted on AWS and created after December 31, 2022. You can increase the node size [using the TiDB Cloud console](/tidb-cloud/scale-tidb-cluster.md#change-node-size) or [using the TiDB Cloud API (beta)](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster). @@ -515,11 +515,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Use Grafana GUI dashboards to visualize the metrics](/tidb-cloud/monitor-prometheus-and-grafana-integration.md#step-3-use-grafana-gui-dashboards-to-visualize-the-metrics). -- Upgrade the default TiDB version of all [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters from [v6.3.0](https://docs.pingcap.com/tidb/v6.3/release-6.3.0) to [v6.4.0](https://docs.pingcap.com/tidb/v6.4/release-6.4.0). The cold start issue after upgrading the default TiDB version of Serverless Tier clusters to v6.4.0 has been resolved. +- Upgrade the default TiDB version of all [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters from [v6.3.0](https://docs.pingcap.com/tidb/v6.3/release-6.3.0) to [v6.4.0](https://docs.pingcap.com/tidb/v6.4/release-6.4.0). The cold start issue after upgrading the default TiDB version of Serverless Tier clusters to v6.4.0 has been resolved. **Console changes** - Simplify the display of the [**Clusters**](https://tidbcloud.com/console/clusters) page and the cluster overview page. - You can click the cluster name on the [**Clusters**](https://tidbcloud.com/console/clusters) page to enter the cluster overview page and start operating the cluster. - - Remove the **Connection** and **Import** panes from the cluster overview page. You can click **Connect** in the upper-right corner to get the connection information and click **Import** in the left navigation pane to import data. + - Remove the **Connection** and **Import** panes from the cluster overview page. You can click **Connect** in the upper-right corner to get the connection information and click **Import** in the left navigation pane to import data. \ No newline at end of file diff --git a/tidb-cloud/tidb-cloud-tls-connect-to-dedicated-tier.md b/tidb-cloud/tidb-cloud-tls-connect-to-dedicated-tier.md index 943f76ce39465..f616b5d06fd5b 100644 --- a/tidb-cloud/tidb-cloud-tls-connect-to-dedicated-tier.md +++ b/tidb-cloud/tidb-cloud-tls-connect-to-dedicated-tier.md @@ -1,27 +1,27 @@ --- -title: TLS Connections to Dedicated Tier -summary: Introduce TLS connections in TiDB Dedicated Tier. +title: TLS Connections to TiDB Dedicated +summary: Introduce TLS connections in TiDB Dedicated. --- -# TLS Connections to Dedicated Tier +# TLS Connections to TiDB Dedicated -On TiDB Cloud, establishing TLS connections is one of the basic security practices for connecting to Dedicated Tier clusters. You can configure multiple TLS connections from your client, application, and development tools to your Dedicated Tier cluster to protect data transmission security. For security reasons, TiDB Cloud Dedicated Tier only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. +On TiDB Cloud, establishing TLS connections is one of the basic security practices for connecting to TiDB Dedicated clusters. You can configure multiple TLS connections from your client, application, and development tools to your TiDB Dedicated cluster to protect data transmission security. For security reasons, TiDB Dedicated only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. -To ensure data security, TiDB cluster CA for your Dedicated Tier cluster is hosted on [AWS Certificate Manager (ACM)](https://aws.amazon.com/certificate-manager/), and TiDB cluster private keys are stored in AWS-managed hardware security modules (HSMs) that meet [FIPS 140-2 Level 3](https://csrc.nist.gov/projects/cryptographic-module-validation-program/Certificate/3139) security standards. +To ensure data security, TiDB cluster CA for your TiDB Dedicated cluster is hosted on [AWS Certificate Manager (ACM)](https://aws.amazon.com/certificate-manager/), and TiDB cluster private keys are stored in AWS-managed hardware security modules (HSMs) that meet [FIPS 140-2 Level 3](https://csrc.nist.gov/projects/cryptographic-module-validation-program/Certificate/3139) security standards. ## Prerequisites -- Log in to TiDB Cloud via [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md) or [SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md), and then [Create a TiDB Cloud Dedicated Tier cluster](/tidb-cloud/create-tidb-cluster.md). +- Log in to TiDB Cloud via [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md) or [SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md), and then [Create a TiDB Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). - Set a password to access your cluster in secure settings. - To do so, you can navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project, click **...** in the row of your Dedicated Tier cluster, and then select **Security Settings**. In security settings, you can click **Generate** to automatically generate a root password with a length of 16 characters, including numbers, uppercase and lowercase characters, and special characters. + To do so, you can navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project, click **...** in the row of your TiDB Dedicated cluster, and then select **Security Settings**. In security settings, you can click **Generate** to automatically generate a root password with a length of 16 characters, including numbers, uppercase and lowercase characters, and special characters. -## Secure connection to a Dedicated Tier cluster +## Secure connection to a TiDB Dedicated cluster -In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of different connection methods and connect to your Dedicated Tier cluster as follows: +In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of different connection methods and connect to your TiDB Dedicated cluster as follows: -1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project, and then click the name of your Dedicated Tier cluster to go to its overview page. +1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project, and then click the name of your TiDB Dedicated cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. A dialog is displayed. @@ -35,8 +35,8 @@ In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of dif 5. Under **Step 2: Download TiDB cluster CA**, click **Download TiDB cluster CA** to download it locally for client TLS configuration. The TiDB cluster CA ensures that the TLS connection is secure and reliable. > **Note:** - > - > After downloading your Dedicated Tier cluster CA, you can store it in the default storage path of your operating system, or specify another storage path. You need to replace the CA path in the code example with your own cluster CA path in the subsequent steps. + > + > After downloading your TiDB Dedicated cluster CA, you can store it in the default storage path of your operating system, or specify another storage path. You need to replace the CA path in the code example with your own cluster CA path in the subsequent steps. 6. Under **Step 3: Connect with an SQL client** in the dialog, click the tab of your preferred connection method, and then refer to the connection string and sample code on the tab to connect to your cluster. @@ -45,7 +45,7 @@ The following examples show the connection strings in MySQL, MyCLI, JDBC, Python
-MySQL CLI client attempts to establish a TLS connection by default. When you connect to Dedicated Tier clusters, you need to set `ssl-mode` and `ssl-ca`. +MySQL CLI client attempts to establish a TLS connection by default. When you connect to TiDB Dedicated clusters, you need to set `ssl-mode` and `ssl-ca`. ```shell mysql --connect-timeout 15 --ssl-mode=VERIFY_IDENTITY --ssl-ca=ca.pem --tls-version="TLSv1.2" -u root -h tidb.eqlfbdgthh8.clusters.staging.tidb-cloud.com -P 4000 -D test -p @@ -53,7 +53,7 @@ mysql --connect-timeout 15 --ssl-mode=VERIFY_IDENTITY --ssl-ca=ca.pem --tls-vers Parameter description： -- With `--ssl-mode=VERIFY_IDENTITY`, MySQL CLI client forces to enable TLS and validate TiDB Dedicated Tier clusters. +- With `--ssl-mode=VERIFY_IDENTITY`, MySQL CLI client forces to enable TLS and validate TiDB Dedicated clusters. - Use `--ssl-ca=` to specify your local path of the downloaded TiDB cluster `ca.pem`. - Use `--tls-version=TLSv1.2` to restrict the versions of the TLS protocol. If you want to use TLS 1.3, you can set the version to `TLSv1.3`. @@ -61,7 +61,7 @@ Parameter description：
-[MyCLI](https://www.mycli.net/) automatically enables TLS when using TLS related parameters. When you connect to TiDB Dedicated Tier clusters, you need to set `ssl-ca` and `ssl-verify-server-cert`. +[MyCLI](https://www.mycli.net/) automatically enables TLS when using TLS related parameters. When you connect to TiDB Dedicated clusters, you need to set `ssl-ca` and `ssl-verify-server-cert`. ```shell mycli --ssl-ca=ca.pem --ssl-verify-server-cert -u root -h tidb.eqlfbdgthh8.clusters.staging.tidb-cloud.com -P 4000 -D test @@ -70,7 +70,7 @@ mycli --ssl-ca=ca.pem --ssl-verify-server-cert -u root -h tidb.eqlfbdgthh8.clust Parameter descriptions： - Use `--ssl-ca=` to specify your local path of the downloaded TiDB cluster `ca.pem`. -- With `--ssl-verify-server-cert` to validate TiDB Dedicated Tier clusters. +- With `--ssl-verify-server-cert` to validate TiDB Dedicated clusters.
@@ -91,7 +91,7 @@ You can click **show example usage** to view detailed code examples. ``` import com.mysql.jdbc.Driver; import java.sql.*; - + class Main { public static void main(String args[]) throws SQLException, ClassNotFoundException { Class.forName("com.mysql.cj.jdbc.Driver"); @@ -105,7 +105,7 @@ class Main { } } catch (Exception e) { System.out.println("exec error:" + e); - } + } } catch (Exception e) { System.out.println("connect error:" + e); } @@ -115,7 +115,7 @@ class Main { Parameter description： -- Set `sslMode=VERIFY_IDENTITY` to enable TLS and validate TiDB Dedicated Tier clusters. +- Set `sslMode=VERIFY_IDENTITY` to enable TLS and validate TiDB Dedicated clusters. - Set `enabledTLSProtocols=TLSv1.2` to restrict the versions of the TLS protocol. If you want to use TLS 1.3, you can set the version to `TLSv1.3`. - Set `trustCertificateKeyStoreUrl` to your custom truststore path. - Set `trustCertificateKeyStorePassword` to your truststore password. @@ -146,7 +146,7 @@ with connection: Parameter descriptions： -- Set `ssl_mode="VERIFY_IDENTITY"` to enable TLS and validate TiDB Dedicated Tier clusters. +- Set `ssl_mode="VERIFY_IDENTITY"` to enable TLS and validate TiDB Dedicated clusters. - Use `ssl={"ca": ""}` to specify your local path of the downloaded TiDB cluster `ca.pem`.
@@ -169,7 +169,7 @@ mysql.RegisterTLSConfig("tidb", &tls.Config{ MinVersion: tls.VersionTLS12, ServerName: "tidb.srgnqxji5bc.clusters.staging.tidb-cloud.com", }) - + db, err := sql.Open("mysql", "root:@tcp(tidb.srgnqxji5bc.clusters.staging.tidb-cloud.com:4000)/test?tls=tidb") ``` @@ -184,9 +184,9 @@ import ( "fmt" "io/ioutil" "log" - + "github.com/go-sql-driver/mysql" -) +) func main() { rootCertPool := x509.NewCertPool() pem, err := ioutil.ReadFile("ca.pem") @@ -218,9 +218,9 @@ func main() { Parameter descriptions： -- Register `tls.Config` in the TLS connection configuration to enable TLS and validate TiDB Dedicated Tier clusters. +- Register `tls.Config` in the TLS connection configuration to enable TLS and validate TiDB Dedicated clusters. - Set `MinVersion: tls.VersionTLS12` to restrict the versions of TLS protocol. -- Set `ServerName: ""` to verify TiDB Dedicated Tier's hostname. +- Set `ServerName: ""` to verify TiDB Dedicated's hostname. - If you do not want to register a new TLS configuration, you can just set `tls=true` in the connection string.
@@ -283,18 +283,18 @@ Parameter descriptions：
-## Manage root certificates for Dedicated Tier +## Manage root certificates for TiDB Dedicated -TiDB Dedicated Tier uses certificates from [AWS Certificate Manager (ACM)](https://aws.amazon.com/certificate-manager/) as a Certificate Authority (CA) for TLS connections between clients and TiDB Dedicated Tier clusters. Usually, the root certificates of ACM are stored securely in AWS-managed hardware security modules (HSMs) that meet [FIPS 140-2 Level 3](https://csrc.nist.gov/projects/cryptographic-module-validation-program/Certificate/3139) security standards. +TiDB Dedicated uses certificates from [AWS Certificate Manager (ACM)](https://aws.amazon.com/certificate-manager/) as a Certificate Authority (CA) for TLS connections between clients and TiDB Dedicated clusters. Usually, the root certificates of ACM are stored securely in AWS-managed hardware security modules (HSMs) that meet [FIPS 140-2 Level 3](https://csrc.nist.gov/projects/cryptographic-module-validation-program/Certificate/3139) security standards. ## FAQs -### Which TLS versions are supported to connect to my TiDB Cloud Dedicated Tier cluster? +### Which TLS versions are supported to connect to my TiDB Dedicated cluster? -For security reasons, TiDB Cloud Dedicated Tier only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details. +For security reasons, TiDB Dedicated only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details. -### Is two-way TLS authentication between my client and TiDB Cloud Dedicated Tier supported? +### Is two-way TLS authentication between my client and TiDB Dedicated supported? No. -TiDB Cloud Dedicated Tier only supports one-way TLS authentication, and does not support two-way TLS authentication currently. If you need two-way TLS authentication, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). \ No newline at end of file +TiDB Dedicated only supports one-way TLS authentication, and does not support two-way TLS authentication currently. If you need two-way TLS authentication, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). \ No newline at end of file diff --git a/tidb-cloud/tune-performance.md b/tidb-cloud/tune-performance.md index d649e0518d0da..7d2efe3153450 100644 --- a/tidb-cloud/tune-performance.md +++ b/tidb-cloud/tune-performance.md @@ -15,7 +15,7 @@ TiDB Cloud provides [Slow Query](#slow-query), [Statement Analysis](#statement-a > **Note:** > -> Currently, **Key Visualizer** is unavailable for [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta). +> Currently, **Key Visualizer** is unavailable for [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta). ## Slow Query @@ -59,7 +59,7 @@ For more information, see [Statement Execution Details in TiDB Dashboard](https: > **Note:** > -> Key Visualizer is only available for [Dedicated Tier clusters](/tidb-cloud/select-cluster-tier.md#dedicated-tier). +> Key Visualizer is only available for [TiDB Dedicated clusters](/tidb-cloud/select-cluster-tier.md#tidb-dedicated). To view the key analytics, perform the following steps: diff --git a/tidb-cloud/use-chat2query-api.md b/tidb-cloud/use-chat2query-api.md index f1fdeb13b30ad..85bc984d8fb27 100644 --- a/tidb-cloud/use-chat2query-api.md +++ b/tidb-cloud/use-chat2query-api.md @@ -11,11 +11,11 @@ Chat2Query API can only be accessed through HTTPS, ensuring that all data transm > **Note:** > -> Chat2Query API is only available for [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) clusters. +> Chat2Query API is only available for [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. ## Before you begin -Before using the Chat2Query API, make sure that you have created a [Serverless Tier](/tidb-cloud/select-cluster-tier.md#serverless-tier-beta) cluster and enabled [AI to generate SQL queries](/tidb-cloud/explore-data-with-chat2query.md). If you do not have a Serverless Tier 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 cluster](/tidb-cloud/create-tidb-cluster.md) to create one. ## Step 1. Enable the Chat2Query API @@ -33,7 +33,7 @@ To enable the Chat2Query API, perform the following steps: > **Note:** > - > After DataAPI is enabled for one Serverless Tier cluster, all Serverless Tier clusters in the same project can use the Chat2Query API. + > After DataAPI is enabled for one TiDB Serverless cluster, all TiDB Serverless clusters in the same project can use the Chat2Query API. 5. Click the **Data Service** link in the message to access the Chat2Query API. diff --git a/tidb-cloud/use-htap-cluster.md b/tidb-cloud/use-htap-cluster.md index 7c0a80df29bf0..c39f00c8de520 100644 --- a/tidb-cloud/use-htap-cluster.md +++ b/tidb-cloud/use-htap-cluster.md @@ -11,7 +11,7 @@ With TiDB Cloud, you can create an HTAP cluster easily by specifying one or more > **Note:** > -> TiFlash is always enabled for Serverless Tier clusters. You cannot disable it. +> TiFlash is always enabled for TiDB Serverless clusters. You cannot disable it. TiKV data is not replicated to TiFlash by default. You can select which table to replicate to TiFlash using 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 3ba971bd4a813..041c7bdc676ac 100644 --- a/tidb-cloud/v7.1.0-performance-benchmarking-with-tpcc.md +++ b/tidb-cloud/v7.1.0-performance-benchmarking-with-tpcc.md @@ -5,7 +5,7 @@ summary: Introduce the TPC-C performance test results for TiDB Cloud. # TiDB Cloud TPC-C Performance Test Report -This document provides the TPC-C performance test steps and results for a TiDB Dedicated cluster with the TiDB version of v7.1.0. This report can also be used as a reference for the performance of TiDB v7.1.0 clusters. +This document provides the TPC-C performance test steps and results for a TiDB Dedicated cluster with the TiDB version of v7.1.0. This report can also be used as a reference for the performance of TiDB Self-Hosted v7.1.0 clusters. ## Test overview @@ -17,7 +17,7 @@ This test aims at showing the TPC-C performance of TiDB v7.1.0 in the Online Tra The test is conducted on a TiDB cluster with the following settings: -- Cluster type: [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#dedicated-tier) +- Cluster type: [TiDB Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-dedicated) - Cluster version: v7.1.0 - Cloud provider: AWS (us-west-2) - Cluster configuration: diff --git a/time-to-live.md b/time-to-live.md index cca4b048b5649..824d6e102c7fc 100644 --- a/time-to-live.md +++ b/time-to-live.md @@ -18,7 +18,7 @@ TTL is designed to help users clean up unnecessary data periodically and in a ti > **Warning:** > > This is an experimental feature. It is not recommended that you use it in a production environment. -> TTL is not available for [TiDB Cloud Serverless Tier](https://docs.pingcap.com/tidbcloud/select-cluster-tier#serverless-tier-beta). +> TTL is not available for [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless-beta). ## Syntax @@ -160,7 +160,7 @@ The preceding statement allows TTL jobs to be scheduled only between 1:00 and 5: > **Note:** > -> This section is only applicable to on-premises TiDB. Currently, TiDB Cloud does not provide TTL metrics. +> This section is only applicable to TiDB Self-Hosted. Currently, TiDB Cloud does not provide TTL metrics.