Skip to content

Commit 3860ae9

Browse files
authored
tidbcloud: add backup& restore (#21934)
1 parent bc27f95 commit 3860ae9

File tree

3 files changed

+163
-4
lines changed

3 files changed

+163
-4
lines changed

TOC-tidb-cloud-premium.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@
137137
- [Connect via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md)
138138
- [Connect via Private Endpoint with AWS](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md)
139139
- [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md)
140-
- [Back Up and Restore TiDB Cloud Data](/tidb-cloud/backup-and-restore-serverless.md)
140+
- [Back Up and Restore TiDB Cloud Data](/tidb-cloud/premium/backup-and-restore-premium.md)
141141
- Use an HTAP Cluster with TiFlash
142142
- [TiFlash Overview](/tiflash/tiflash-overview.md)
143143
- [Create TiFlash Replicas](/tiflash/create-tiflash-replicas.md)

tidb-cloud/backup-and-restore-serverless.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Back Up and Restore Data on {{{ .starter }}} or Essential
2+
title: Back Up and Restore {{{ .starter }}} or Essential Data
33
summary: Learn how to back up and restore your {{{ .starter }}} or {{{ .essential }}} clusters.
44
aliases: ['/tidbcloud/restore-deleted-tidb-cluster']
55
---
66

7-
# Back Up and Restore Data on {{{ .starter }}} or Essential
7+
# Back Up and Restore {{{ .starter }}} or Essential Data
88

99
This document describes how to back up and restore your data on {{{ .starter }}} or {{{ .essential }}} clusters.
1010

@@ -73,7 +73,7 @@ TiDB Cloud supports snapshot restore and point-in-time restore for your cluster.
7373
- **Point-in-Time Restore (beta)**: restores your cluster to a specific time.
7474

7575
- {{{ .starter }}} clusters: not supported.
76-
- {{{ .essential }}} clusters: restores to any time within the backup retention, but not before the cluster creation time or after the current time minus one minute.
76+
- {{{ .essential }}} clusters: restores to any time within the backup retention, but not earlier than the cluster creation time or later than one minute before the current time.
7777

7878
### Restore destination
7979

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
---
2+
title: Back Up and Restore {{{ .premium }}} Data
3+
summary: Learn how to back up and restore your {{{ .premium }}} instances.
4+
aliases: ['/tidbcloud/restore-deleted-tidb-cluster']
5+
---
6+
7+
# Back Up and Restore {{{ .premium }}} Data
8+
9+
This document describes how to back up and restore your data on {{{ .premium }}} instances. {{{ .premium }}} supports automatic backup and lets you restore backup data to a new instance as needed.
10+
11+
Backup files can originate from the following sources:
12+
13+
- Active {{{ .premium }}} instances
14+
- The Recycle Bin for backups from deleted Premium instances
15+
16+
> **Tip:**
17+
>
18+
> - To learn how to back up and restore data on {{{ .dedicated }}} clusters, see [Back Up and Restore {{{ .dedicated }}} Data](/tidb-cloud/backup-and-restore.md).
19+
> - To learn how to back up and restore data on {{{ .starter }}} or {{{ .essential }}} clusters, see [Back Up and Restore {{{ .starter }}} or Essential Data](/tidb-cloud/backup-and-restore-serverless.md).
20+
21+
## View the Backup page
22+
23+
1. On the [**TiDB Instances**](https://tidbcloud.com/tidbs) page, click the name of your target instance to go to its overview page.
24+
25+
> **Tip:**
26+
>
27+
> You can use the combo box in the upper-left corner to switch between organizations and instances.
28+
29+
2. In the left navigation pane, click **Data** > **Backup**.
30+
31+
## Automatic backups
32+
33+
TiDB Cloud automatically backs up your instance data, letting you restore data from a backup snapshot to minimize data loss in the event of a disaster.
34+
35+
### Learn about the backup setting
36+
37+
Compared with {{{ .starter }}} clusters and {{{ .essential }}} clusters, {{{ .premium }}} offers enhanced backup capabilities, including longer retention and hourly backup support.
38+
39+
| Backup setting | {{{ .starter }}} (free) | {{{ .starter }}} (with spending limit > 0) | {{{ .essential }}} | {{{ .premium }}} |
40+
|------------------|--------------------------|---------------------------------------------|--------------------|------------------|
41+
| Backup Cycle | Daily | Daily | Daily | Daily + Hourly |
42+
| Backup Retention | 1 day | 30 days | 30 days | Up to 33 days |
43+
| Backup Time | Fixed time | Configurable | Configurable | Configurable |
44+
45+
- **Backup Cycle** determines how frequently backups are created.
46+
47+
- Premium instances support both **daily** and **hourly** backups.
48+
- The **default** is **hourly backups**.
49+
50+
- **Backup Retention** is the duration for which backups are retained. Expired backups cannot be restored.
51+
52+
- Premium instances can retain backups for up to **33 days**.
53+
54+
- **Backup Time** is the scheduled start time for backups.
55+
56+
- For Premium instances, **daily backups** can be configured to start at a preferred time (in 30-minute intervals), while **hourly backups** always run on the hour.
57+
58+
### Configure the backup settings
59+
60+
To configure backups for a {{{ .premium }}} instance, perform the following steps:
61+
62+
1. Navigate to the [**Backup**](#view-the-backup-page) page of your TiDB instance.
63+
64+
2. Click **Backup Setting**. This will open the **Backup Setting** window, where you can configure automatic backup options.
65+
66+
3. In **Backup Cycle**, choose between the **Hourly Backup** and **Daily Backup** tabs:
67+
68+
- **Hourly Backup** (default):
69+
- Runs **on the hour**.
70+
- You can configure **Backup Retention** (1–33 days).
71+
- **Daily Backup**:
72+
- Runs at a configurable time in **30-minute intervals**.
73+
- You can configure both **Backup Retention** (1–33 days) and **Backup Time**.
74+
75+
4. Click **Save** to save your settings.
76+
77+
### Delete backup files
78+
79+
To delete an existing backup file for your {{{ .premium }}} instance, perform the following steps:
80+
81+
1. Navigate to the [**Backup**](#view-the-backup-page) page of your instance.
82+
83+
2. Locate the corresponding backup file you want to delete, and click **...** > **Delete** in the **Action** column.
84+
85+
## Restore
86+
87+
TiDB Cloud provides restore functionality to help recover data in case of accidental loss or corruption. You can restore from backups of active instances or from deleted instances in the Recycle Bin.
88+
89+
### Restore mode
90+
91+
TiDB Cloud supports snapshot restore and point-in-time restore for your instance.
92+
93+
- **Snapshot Restore**: restores your instance from a specific backup snapshot.
94+
95+
- **Point-in-Time Restore**: restores your instance to a specific point in time.
96+
97+
- Premium instances: can be restored to any time within the last 33 days, but not earlier than the instance creation time or later than one minute before the current time.
98+
99+
### Restore destination
100+
101+
TiDB Cloud supports restoring data to a new instance.
102+
103+
### Restore to a new instance
104+
105+
To restore your data to a new instance, take the following steps:
106+
107+
1. Navigate to the [**Backup**](#view-the-backup-page) page of your instance.
108+
109+
2. Click **Restore**.
110+
111+
3. On the **Select Backup** page, choose the **Restore Mode** you want to use. You can restore from a specific backup snapshot or restore to a specific point in time.
112+
113+
<SimpleTab>
114+
<div label="Snapshot Restore">
115+
116+
To restore from a selected backup snapshot, take the following steps:
117+
118+
1. Click **Snapshot Restore**.
119+
2. Select the backup snapshot you want to restore from.
120+
121+
</div>
122+
<div label="Point-in-Time Restore">
123+
124+
To restore to a specific point in time for a Premium instance, take the following steps:
125+
126+
1. Click **Point-in-Time Restore**.
127+
2. Select the date and time you want to restore to.
128+
129+
</div>
130+
</SimpleTab>
131+
132+
4. Click **Next** to proceed to the **Restore to a New Instance** page.
133+
134+
5. Configure your new TiDB instance for restoration. The steps are the same as [creating a new TiDB instance](/tidb-cloud/premium/create-tidb-instance-premium.md).
135+
136+
> **Note:**
137+
>
138+
> The new instance uses the same cloud provider and region as the backup by default.
139+
140+
6. Click **Restore** to start the restore process.
141+
142+
When the restore process starts, the instance status first changes to **Creating**. After the creation is complete, it changes to **Restoring**. The instance remains unavailable until the restore finishes and the status changes to **Available**.
143+
144+
### Restore from Recycle Bin
145+
146+
To restore a deleted instance from the Recycle Bin, take the following steps:
147+
148+
1. Log in to the [TiDB Cloud console](https://tidbcloud.com), and then navigate to the [**TiDB Instances**](https://staging.tidbcloud.com/tidbs?orgId=1369847559692509630&uiMode=new-offerings-preview) page. In the top-right corner, click **Recycle Bin**.
149+
150+
2. On the **Recycle Bin** page, locate the TiDB instance you want to restore:
151+
152+
- Click the **>** button to expand instance details.
153+
- Find the desired backup, click **...** in the **Action** column, and then select **Restore**.
154+
155+
3. On the **Restore** page, follow the same steps as [Restore to a new instance](#restore-to-a-new-instance) to restore the backup to a new instance.
156+
157+
## Limitations
158+
159+
Manual backups are not supported for Premium instances.

0 commit comments

Comments
 (0)