Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/release-6.5' into serverless_faq
Browse files Browse the repository at this point in the history
  • Loading branch information
sunxiaoguang committed Jul 6, 2023
2 parents 174b396 + 660d6b0 commit 75c50f0
Show file tree
Hide file tree
Showing 81 changed files with 289 additions and 287 deletions.
2 changes: 1 addition & 1 deletion TOC-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
- [Built-in Metrics](/tidb-cloud/built-in-monitoring.md)
- [Built-in Alerting](/tidb-cloud/monitor-built-in-alerting.md)
- [Cluster Events](/tidb-cloud/tidb-cloud-events.md)
- [Third-Party Metrics Integrations](/tidb-cloud/third-party-monitoring-integrations.md)
- [Third-Party Metrics Integrations (Beta)](/tidb-cloud/third-party-monitoring-integrations.md)
- Tune Performance
- [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md)
- Analyze Performance
Expand Down
2 changes: 1 addition & 1 deletion br/backup-and-restore-storages.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ This section provides some URL examples by using `external` as the `host` parame
**Back up snapshot data to Amazon S3**

```shell
./br restore full -u "${PD_IP}:2379" \
./br backup full -u "${PD_IP}:2379" \
--storage "s3://external/backup-20220915?access-key=${access-key}&secret-access-key=${secret-access-key}"
```

Expand Down
1 change: 0 additions & 1 deletion develop/dev-guide-aws-appflow-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,5 +244,4 @@ 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 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.
4 changes: 2 additions & 2 deletions develop/dev-guide-build-cluster-in-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ This document walks you through the quickest way to get started with TiDB Cloud.

> **Note:**
>
> 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).
> For [TiDB Serverless clusters](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless), 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).
</CustomContent>

<CustomContent platform="tidb-cloud">

> **Note:**
>
> 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).
> For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless), 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 develop/dev-guide-third-party-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,8 +251,8 @@ If you encounter problems when connecting to TiDB using the tools listed in this
<tr>
<td rowspan="4">Python</td>
<td><a href="https://pypi.org/project/Django/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Django</a></td>
<td>v4.0.5</td>
<td>Compatible</td>
<td>v4.1</td>
<td>Full</td>
<td><a href="https://github.com/pingcap/django-tidb" target="_blank" referrerpolicy="no-referrer-when-downgrade">django-tidb</a></td>
<td>N/A</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion information-schema/information-schema-slow-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The `SLOW_QUERY` table provides the slow query information of the current node,

> **Note:**
>
> The `SLOW_QUERY` table is unavailable for [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta).
> The `SLOW_QUERY` table is unavailable for [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless).
</CustomContent>

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 Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters. Do not execute this statement on TiDB Serverless 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) clusters. Do not execute this statement on TiDB Serverless clusters to avoid unexpected results.
</CustomContent>

Expand Down
2 changes: 1 addition & 1 deletion statement-summary-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Therefore, starting from v4.0.0-rc.1, TiDB provides system tables in `informatio

> **Note:**
>
> 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`.
> The following tables are unavailable for [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless): `statements_summary`, `statements_summary_history`, `cluster_statements_summary`, and `cluster_statements_summary_history`.
</CustomContent>

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 [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-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) clusters, this feature is unavailable.
</CustomContent>
Expand Down
35 changes: 30 additions & 5 deletions tidb-cloud/backup-and-restore-serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ This document describes how to back up and restore your TiDB Serverless cluster

- 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.

Expand Down Expand Up @@ -56,9 +55,35 @@ TiDB Serverless only supports in-place restoration. To restore your TiDB Serverl

1. Navigate to the **Backup** page of a cluster.

2. Click **Restore**. This will open the **Restore** window.
2. Click **Restore**. The setting window displays.

1. Choose a backup from the **Backup Time** drop-down list.
2. Click **Confirm** to begin the restoration process.
3. In **Restore Mode**, you can choose to restore from a specific backup or any point in time.

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.
<SimpleTab>
<div label="Basic Snapshot Restore">

To restore from a selected backup snapshot, take the following steps:

1. Click **Basic Snapshot Restore**.
2. Select the backup snapshot you want to restore to.

</div>
<div label="Point-in-Time Restore">

This feature lets you restore a cluster to a specific state from any time within the last 90 days.

> **Note:**
>
> The **Point-in-Time Restore** feature is currently in beta.
To restore from a specific point in time, take the following steps:

1. Click **Point-in-Time Restore**.
2. Select the date and time you want to restore to.

</div>
</SimpleTab>

4. Click **Restore** to begin the restoration process.

After initiating the restore process, the cluster status changes to **Restoring**. The cluster will be unavailable during the restore process and existing connections will be terminated. Once the restore process completes successfully, you can access the cluster as usual.
8 changes: 2 additions & 6 deletions tidb-cloud/backup-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,12 +165,8 @@ To restore your TiDB Dedicated cluster data from a backup to a new cluster, take
To restore a deleted cluster from recycle bin, take the following steps:

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:

- If you have multiple projects, switch to the target project, and then click **Admin** > **Recycle Bin**.
- If you only have one project, click **Admin** > **Recycle Bin**.

3. Locate the cluster you want to restore, and then click **Backups** in the **Action** column.
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Admin**.
3. On the **Admin** page of your project, click **Recycle Bin** in the left navigation pane, locate the cluster you want to restore, and then click **Backups** in the **Action** column.
4. Locate your desired backup time, and then click **Restore** in the **Action** column.
5. In the **Restore** window, make the following changes if necessary:

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/built-in-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To view the metrics on the Metrics page, take the following steps:

> **Tip:**
>
> If you have multiple projects, you can view the project list and switch to another project from the ☰ hover menu in the upper-left corner.
> If you have multiple projects, you can click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner and switch to another project.
2. Click the name of the target cluster. The cluster overview page is displayed.
3. Click **Metrics** in the left navigation pane.
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/changefeed-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data servic
>
> - To use the changefeed feature, make sure that your TiDB Dedicated cluster version is v6.4.0 or later.
> - Currently, TiDB Cloud only allows up to 5 changefeeds per cluster.
> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable.
> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless), 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
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 @@ -10,7 +10,7 @@ This document describes how to create a changefeed to stream data from TiDB Clou
> **Note:**
>
> - Currently, Kafka sink is in **beta**. To use the changefeed feature, make sure that your TiDB Dedicated cluster version is v6.4.0 or later and the TiKV node size is at least 8 vCPU and 16 GiB.
> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable.
> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless), the changefeed feature is unavailable.
## Restrictions

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/changefeed-sink-to-cloud-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This document describes how to create a changefeed to stream data from TiDB Clou
> **Note:**
>
> - To stream data to cloud storage, make sure that your TiDB cluster version is v7.1.0 or later. To upgrade your TiDB Dedicated cluster to v7.1.0 or later, [contact TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).
> - For [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) clusters, the changefeed feature is unavailable.
> - For [TiDB Serverless](/tidb-cloud/select-cluster-tier.md#tidb-serverless) clusters, the changefeed feature is unavailable.
## Restrictions

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/changefeed-sink-to-mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This document describes how to stream data from TiDB Cloud to MySQL using the **
>
> - To use the changefeed feature, make sure that your TiDB Dedicated cluster version is v6.4.0 or later and the TiKV node size is at least 8 vCPU and 16 GiB.
> - Currently, TiDB Cloud only allows up to 5 changefeeds per cluster.
> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta), the changefeed feature is unavailable.
> - For [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless), the changefeed feature is unavailable.
## Restrictions

Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/config-s3-and-gcs-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Configure the bucket access for TiDB Cloud and get the Role ARN as follows:

> **Tip:**
>
> If you have multiple projects, you can view the project list and switch to another project from the ☰ hover menu in the upper-left corner.
> If you have multiple projects, you can click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner and switch to another project.
2. Click the name of your target cluster to go to its overview page, and then click **Import** in the left navigation pane.

Expand Down Expand Up @@ -144,7 +144,7 @@ To allow TiDB Cloud to access the source data in your GCS bucket, you need to co

> **Tip:**
>
> If you have multiple projects, you can view the project list and switch to another project from the ☰ hover menu in the upper-left corner.
> If you have multiple projects, you can click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner and switch to another project.
2. Click the name of your target cluster to go to its overview page, and then click **Import** in the left navigation pane.

Expand Down
12 changes: 3 additions & 9 deletions tidb-cloud/configure-maintenance-window.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,9 @@ If a maintenance window is planned, the default start time of the window is 03:0

You can modify the start time to your preferred time or defer maintenance tasks until the deadline as follows:

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [Clusters](https://tidbcloud.com/console/clusters) page of your project.

> **Note:**
>
> If you have multiple projects, you can view the project list and switch to another project from the ☰ hover menu in the upper-left corner.
2. In the left navigation bar, click <svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke-width="1.5" xmlns="http://www.w3.org/2000/svg"><path d="M12 14.5H7.5C6.10444 14.5 5.40665 14.5 4.83886 14.6722C3.56045 15.06 2.56004 16.0605 2.17224 17.3389C2 17.9067 2 18.6044 2 20M14.5 6.5C14.5 8.98528 12.4853 11 10 11C7.51472 11 5.5 8.98528 5.5 6.5C5.5 4.01472 7.51472 2 10 2C12.4853 2 14.5 4.01472 14.5 6.5ZM22 16.516C22 18.7478 19.6576 20.3711 18.8054 20.8878C18.7085 20.9465 18.6601 20.9759 18.5917 20.9911C18.5387 21.003 18.4613 21.003 18.4083 20.9911C18.3399 20.9759 18.2915 20.9465 18.1946 20.8878C17.3424 20.3711 15 18.7478 15 16.516V14.3415C15 13.978 15 13.7962 15.0572 13.6399C15.1077 13.5019 15.1899 13.3788 15.2965 13.2811C15.4172 13.1706 15.5809 13.1068 15.9084 12.9791L18.2542 12C18.3452 11.9646 18.4374 11.8 18.4374 11.8H18.5626C18.5626 11.8 18.6548 11.9646 18.7458 12L21.0916 12.9791C21.4191 13.1068 21.5828 13.1706 21.7035 13.2811C21.8101 13.3788 21.8923 13.5019 21.9428 13.6399C22 13.7962 22 13.978 22 14.3415V16.516Z" stroke="currentColor" stroke-width="inherit" stroke-linecap="round" stroke-linejoin="round"></path></svg> **Admin**.

3. On the **Admin** page, click **Maintenance** in the left navigation pane.
1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Admin**.
3. On the **Admin** page of your project, click **Maintenance** in the left navigation pane.

- If any maintenance tasks are displayed, check the descriptions, scheduled start time, and deadline. The maintenance tasks will start at the designated time.

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/configure-security-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For TiDB Dedicated clusters, you can configure the root password and allowed IP

> **Tip:**
>
> If you have multiple projects, you can view the project list and switch to another project from the ☰ hover menu in the upper-left corner.
> If you have multiple projects, you can click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner and switch to another project.
2. In the row of your target cluster, click **...** and select **Security Settings**.
3. In the **Security Settings** dialog, configure the root password and allowed IP addresses.
Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/connect-via-sql-shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ In TiDB Cloud SQL Shell, you can try TiDB SQL, test out TiDB's compatibility wit

> **Note:**
>
> You cannot connect to [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless-beta) using SQL Shell. To connect to your TiDB Serverless cluster, see [Connect to TiDB Serverless clusters](/tidb-cloud/connect-to-tidb-cluster-serverless.md).
> You cannot connect to [TiDB Serverless clusters](/tidb-cloud/select-cluster-tier.md#tidb-serverless) using SQL Shell. To connect to your TiDB Serverless cluster, see [Connect to TiDB Serverless clusters](/tidb-cloud/connect-to-tidb-cluster-serverless.md).
To connect to your TiDB cluster using SQL shell, perform the following steps:

1. Log in to the [TiDB Cloud console](https://tidbcloud.com/) and navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page of your project.

> **Tip:**
>
> If you have multiple projects, you can view the project list and switch to another project from the ☰ hover menu in the upper-left corner.
> If you have multiple projects, you can click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner and switch to another project.
2. Click the name of your target cluster to go to its cluster overview page, and then click **Connect** in the upper-right corner. A connection dialog is displayed.

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/connect-via-standard-connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To connect to a TiDB Dedicated cluster via standard connection, take the followi

> **Tip:**
>
> If you have multiple projects, you can view the project list and switch to another project from the ☰ hover menu in the upper-left corner.
> If you have multiple projects, you can click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner and switch to another project.
2. Click the name of your target cluster to go to its overview page.

Expand Down
4 changes: 2 additions & 2 deletions tidb-cloud/create-tidb-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Once you log in to the [TiDB Cloud console](https://tidbcloud.com/), you have a

If you are an organization owner, you can rename the default project or create a new project for the cluster according to your need as follows:

1. Log in to the [TiDB Cloud console](https://tidbcloud.com/), and then click <MDSvgIcon name="icon-top-organization" /> **Organization** in the upper-right corner.
1. Log in to the [TiDB Cloud console](https://tidbcloud.com/), and then click <MDSvgIcon name="icon-top-organization" /> in the lower-left corner.

2. Click **Organization Settings**.

Expand All @@ -46,7 +46,7 @@ To create a TiDB Dedicated cluster, take the following steps:

> **Tip:**
>
> If you have multiple projects, you can view the project list and switch to another project from the ☰ hover menu in the upper-left corner.
> If you have multiple projects, you can click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner and switch to another project.
2. Click **Create Cluster**.

Expand Down
Loading

0 comments on commit 75c50f0

Please sign in to comment.