Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cloud: rename three products #13668

Merged
merged 21 commits into from
Jun 2, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion develop/dev-guide-build-cluster-in-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [Serverless Tier 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).

</CustomContent>

Expand Down
4 changes: 2 additions & 2 deletions information-schema/information-schema-slow-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta).

</CustomContent>

<CustomContent platform="tidb">
Expand Down
2 changes: 1 addition & 1 deletion sql-statements/sql-statement-flashback-to-timestamp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. Do not execute this statement on Serverless Tier clusters to avoid unexpected results.

</CustomContent>

Expand Down
4 changes: 2 additions & 2 deletions statement-summary-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [Serverless Tier clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta): `statements_summary`, `statements_summary_history`, `cluster_statements_summary`, and `cluster_statements_summary_history`.

</CustomContent>

This document details these tables and introduces how to use them to troubleshoot SQL performance issues.
Expand Down
2 changes: 1 addition & 1 deletion system-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters, this feature is unavailable.

</CustomContent>

Expand Down
34 changes: 17 additions & 17 deletions tidb-cloud/backup-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,32 @@ 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.
- If any TiFlash replica is enabled, the replica will be unavailable for a while after the restore because data needs to be rebuilt in TiFlash.

## Backup

You can back up data for both [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.

Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand All @@ -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
Expand Down
20 changes: 10 additions & 10 deletions tidb-cloud/built-in-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions tidb-cloud/changefeed-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/changefeed-sink-to-apache-kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 7 additions & 7 deletions tidb-cloud/changefeed-sink-to-mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -36,22 +36,22 @@ 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.

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)

Expand Down Expand Up @@ -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

Expand Down
Loading