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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 164 additions & 88 deletions TOC-tidb-cloud.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions develop/dev-guide-build-cluster-in-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,17 +142,17 @@ mysql Ver 15.1 Distrib 5.5.68-MariaDB, for Linux (x86_64) using readline 5.1

> **Note:**
>
> - 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.
> - When you connect to a TiDB Serverless cluster, you must [use the TLS connection](https://docs.pingcap.com/tidbcloud/secure-connections-to-serverless-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-clusters) for more information.

</CustomContent>

<CustomContent platform="tidb-cloud">

> **Note:**
>
> - 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.
> - When you connect to a TiDB Serverless cluster, you must [use the TLS connection](/tidb-cloud/secure-connections-to-serverless-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-clusters.md) for more information.

</CustomContent>

Expand Down
2 changes: 1 addition & 1 deletion develop/dev-guide-insert-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ If you need to quickly import a large amount of data into a TiDB cluster, it is

The following are the recommended tools for bulk-insert:

- Data export: [Dumpling](/dumpling-overview.md). You can export MySQL or TiDB data to local or Amazon S3.
- Data export: [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview). You can export MySQL or TiDB data to local or Amazon S3.

<CustomContent platform="tidb">

Expand Down
2 changes: 1 addition & 1 deletion foreign-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ Create Table | CREATE TABLE `child` (

</CustomContent>

- [Dumpling](/dumpling-overview.md) is compatible with foreign keys.
- [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) is compatible with foreign keys.

<CustomContent platform="tidb">

Expand Down
Binary file added media/tidb-cloud/branch/github-authorize.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/branch/github-connect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified media/tidb-cloud/import-data-csv-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file removed media/tidb-cloud/integration-vercel-link-page.png
Binary file not shown.
Binary file removed media/tidb-cloud/key-visualizer.png
Binary file not shown.
Binary file removed media/tidb-cloud/slow-queries.png
Binary file not shown.
Binary file removed media/tidb-cloud/statement-analysis.png
Binary file not shown.
Binary file added media/tidb-cloud/v.7.1.0-oltp_read_write.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.1.0-oltp_insert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.1.0-oltp_select_point.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.1.0-oltp_update_index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/tidb-cloud/v7.1.0-tpmC.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion read-historical-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,4 +174,4 @@ To restore data from an older version, you can use one of the following methods:

- For simple cases, use [`SELECT`](/sql-statements/sql-statement-select.md) after setting the `tidb_snapshot` variable and copy-paste the output, or use `SELECT ... INTO OUTFILE` and then use [`LOAD DATA`](/sql-statements/sql-statement-load-data.md) to import the data later on.

- Use [Dumpling](/dumpling-overview.md#export-historical-data-snapshots-of-tidb) to export a historical snapshot. Dumpling performs well in exporting larger sets of data.
- Use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview#export-historical-data-snapshots-of-tidb) to export a historical snapshot. Dumpling performs well in exporting larger sets of data.
2 changes: 1 addition & 1 deletion system-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -1924,7 +1924,7 @@ MPP is a distributed computing framework provided by the TiFlash engine, which a

- In all OLTP scenarios, it is recommended to use the method of paging.
- For read queries that use `IndexLookup` and `Limit` and that `Limit` cannot be pushed down to `IndexScan`, there might be high latency for the read queries and high usage for TiKV `Unified read pool CPU`. In such cases, because the `Limit` operator only requires a small set of data, if you set [`tidb_enable_paging`](#tidb_enable_paging-new-in-v540) to `ON`, TiDB processes less data, which reduces query latency and resource consumption.
- In scenarios such as data export using [Dumpling](/dumpling-overview.md) and full table scan, enabling paging can effectively reduce the memory consumption of TiDB processes.
- In scenarios such as data export using [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) and full table scan, enabling paging can effectively reduce the memory consumption of TiDB processes.

> **Note:**
>
Expand Down
2 changes: 1 addition & 1 deletion table-filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Table filters can be applied to the tools using multiple `-f` or `--filter` comm

</CustomContent>

* [Dumpling](/dumpling-overview.md):
* [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview):

```shell
./dumpling -f 'foo*.*' -f 'bar*.*' -P 3306 -o /tmp/data/
Expand Down
21 changes: 14 additions & 7 deletions tidb-cloud/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TiDB Cloud Documentation
aliases: ['/tidbcloud/privacy-policy', '/tidbcloud/terms-of-service', '/tidbcloud/service-level-agreement']
hide_sidebar: true
hide_commit: true
---
Expand Down Expand Up @@ -36,19 +37,25 @@ hide_commit: true

</LearningPath>

<LearningPath label="Use" icon="cloud7">
<LearningPath label="Maintain" icon="cloud7">

[Create a Cluster](https://docs.pingcap.com/tidbcloud/create-tidb-cluster)

[Connect to a Cluster](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster)

[Use an HTAP Cluster](https://docs.pingcap.com/tidbcloud/tiflash-overview)

[Back Up and Restore Data](https://docs.pingcap.com/tidbcloud/backup-and-restore)

[Scale a Cluster](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster)

[Pause or Resume a TiDB Cluster](https://docs.pingcap.com/tidbcloud/pause-or-resume-tidb-cluster)

[Use API (beta)](https://docs.pingcap.com/tidbcloud/api-overview)
[Stream Data](http://docs.pingcap.com/tidbcloud/changefeed-overview)

[Use API (Beta)](https://docs.pingcap.com/tidbcloud/api-overview)

[Use TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli)

</LearningPath>

Expand Down Expand Up @@ -94,14 +101,14 @@ hide_commit: true

[Password Authentication](https://docs.pingcap.com/tidbcloud/tidb-cloud-password-authentication)

[User Roles](https://docs.pingcap.com/tidbcloud/manage-user-access#user-roles)

[Manage User Profiles](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-user-profiles)

[Manage organization access](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-organization-access)

[Manage project access](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-project-access)

[Configure Roles](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-role-access)

[Configure Security Settings](https://docs.pingcap.com/tidbcloud/configure-security-settings)

</LearningPath>
Expand All @@ -122,13 +129,13 @@ hide_commit: true

[Datadog](https://docs.pingcap.com/tidbcloud/monitor-datadog-integration)

[dbt](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-dbt)
[Zapier](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-zapier)

[Prometheus and Grafana](https://docs.pingcap.com/tidbcloud/monitor-prometheus-and-grafana-integration)
[Vercel](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-vercel)

[Terraform](https://docs.pingcap.com/tidbcloud/terraform-tidbcloud-provider-overview)

[Vercel](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-vercel)
[Amazon AppFlow](https://docs.pingcap.com/tidbcloud/dev-guide-aws-appflow-integration)

</LearningPath>

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ summary: Learn about what is TiDB Cloud API, its features, and how to use API to
>
> [TiDB Cloud API](https://docs.pingcap.com/tidbcloud/api/v1beta) is in beta.

The TiDB Cloud API is a [REST interface](https://en.wikipedia.org/wiki/Representational_state_transfer) that provides you with programmatic access to manage administrative objects within TiDB Cloud. Through this API, you can automatically and efficiently manage resources such as Projects, Clusters, Backups, and Restores.
The TiDB Cloud API is a [REST interface](https://en.wikipedia.org/wiki/Representational_state_transfer) that provides you with programmatic access to manage administrative objects within TiDB Cloud. Through this API, you can automatically and efficiently manage resources such as Projects, Clusters, Backups, Restores, and Imports.

The API has the following features:

Expand Down
89 changes: 89 additions & 0 deletions tidb-cloud/backup-and-restore-serverless.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
title: Back Up and Restore TiDB Serverless Data
summary: Learn how to back up and restore your TiDB Serverless cluster.
aliases: ['/tidbcloud/restore-deleted-tidb-cluster']
---

# Back Up and Restore TiDB Serverless Data

This document describes how to back up and restore your TiDB Serverless cluster data on TiDB Cloud.

> **Tip:**
>
> To learn how to back up and restore TiDB Dedicated cluster data, see [Back Up and Restore TiDB Dedicated Data](/tidb-cloud/backup-and-restore.md).

## Limitations

- It is important to note that TiDB Serverless clusters only support in-place restoring from backups. When a restore is performed, tables in the `mysql` schema are also impacted. Hence, any changes made to user credentials and permissions or system variables will be rolled back to the state when the backup was taken.
- Manual backup is not yet supported.
- The cluster will be unavailable during the restore process, and existing connections will be terminated. You can establish new connections once the restore is complete.
- If any TiFlash replica is enabled, the replica will be unavailable for a while after the restore because data needs to be rebuilt in TiFlash.

## Backup

Automatic backups are scheduled for your TiDB Serverless clusters according to the backup setting, which can reduce your loss in extreme disaster situations.

### Automatic backup

By the automatic backup, you can back up the TiDB Serverless cluster data every day at the backup time you have set. To set the backup time, perform the following steps:

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

2. Click **Backup Settings**. This will open the **Backup Settings** window, where you can configure the automatic backup settings according to your requirements.

- In **Backup Time**, schedule a start time for the daily cluster backup.

If you do not specify a preferred backup time, TiDB Cloud assigns a default backup time, which is 2:00 AM in the time zone of the region where the cluster is located.

- In **Backup Retention**, configure the minimum backup data retention period.

The backup retention period must be set within a range of 7 to 90 days.

3. Click **Confirm**.

### Delete backup files

To delete an existing backup file, perform the following steps:

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

2. Click **Delete** for the backup file that you want to delete.

## Restore

TiDB Serverless only supports in-place restoration. To restore your TiDB Serverless cluster from a backup, follow these steps:

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

2. Click **Restore**. The setting window displays.

3. In **Restore Mode**, you can choose to restore from a specific backup or any point in time.

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