-
Notifications
You must be signed in to change notification settings - Fork 706
tidbcloud: add backup& restore #21934
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
Changes from 16 commits
cb03ddb
781cbc8
c461320
7e29b47
1500897
494f2df
f830337
a22073a
acf0ed6
b7984b4
c616e5c
7e45a3a
791404f
ae4a7e0
49e9932
9519035
d5809fc
10d5515
24d4035
ed7e37e
dae64d6
c012871
3d1b9fb
9e18004
70d207a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| --- | ||
| title: Back Up and Restore {{{ .premium }}} Data | ||
| summary: Learn how to back up and restore your {{{ .premium }}} instances. | ||
| aliases: ['/tidbcloud/restore-deleted-tidb-cluster'] | ||
| --- | ||
|
|
||
| # Back Up and Restore {{{ .premium }}} Data | ||
|
|
||
| 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. | ||
|
|
||
| Backup files can originate from the following sources: | ||
|
|
||
| - Active {{{ .premium }}} instances | ||
| - {{{ .dedicated }}} clusters | ||
| - The Recycle Bin for backups from deleted {{{ .dedicated }}} clusters or Premium instances | ||
|
||
|
|
||
| > **Tip:** | ||
| > | ||
| > - 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). | ||
| > - 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). | ||
|
|
||
| ## View the Backup page | ||
|
|
||
| 1. On the [**TiDB Instances**](https://tidbcloud.com/project/clusters) page, click the name of your target instance to go to its overview page. | ||
lilin90 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| > **Tip:** | ||
| > | ||
| > You can use the combo box in the upper-left corner to switch between organizations and instances. | ||
|
|
||
| 2. In the left navigation pane, click **Data** > **Backup**. | ||
|
|
||
| ## Automatic backups | ||
|
|
||
| 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. | ||
|
|
||
| ### Learn about the backup setting | ||
|
|
||
| Compared with {{{ .starter }}} clusters and {{{ .essential }}} clusters, {{{ .premium }}} offers enhanced backup capabilities, including longer retention and hourly backup support. | ||
|
|
||
| | Backup setting | {{{ .starter }}} (free) | {{{ .starter }}} (with spending limit > 0) | {{{ .essential }}} | {{{ .premium }}} | | ||
| |------------------|--------------------------|---------------------------------------------|--------------------|------------------| | ||
| | Backup Cycle | Daily | Daily | Daily | Daily + Hourly | | ||
| | Backup Retention | 1 day | 30 days | 30 days | Up to 33 days | | ||
| | Backup Time | Fixed time | Configurable | Configurable | Configurable | | ||
|
|
||
| - **Backup Cycle** determines how frequently backups are created. | ||
|
|
||
| - Premium instances support both **daily** and **hourly** backups. | ||
| - The **default** is **hourly backups**. | ||
|
|
||
| - **Backup Retention** is the duration for which backups are retained. Expired backups cannot be restored. | ||
|
|
||
| - Premium instances can retain backups for up to **33 days**. | ||
|
|
||
| - **Backup Time** is the scheduled start time for backups. | ||
|
|
||
| - 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. | ||
|
|
||
| ### Configure the backup settings | ||
|
|
||
| To configure backups for a {{{ .premium }}} instance, perform the following steps: | ||
|
|
||
| 1. Navigate to the [**Backup**](#view-the-backup-page) page of your TiDB instance. | ||
|
|
||
| 2. Click **Backup Setting**. This will open the **Backup Setting** window, where you can configure automatic backup options. | ||
|
|
||
| 3. In **Backup Cycle**, choose between the **Hourly Backup** and **Daily Backup** tabs: | ||
|
|
||
| - **Hourly Backup** (default): | ||
| - Runs **on the hour**. | ||
| - You can configure **Backup Retention** (1–33 days). | ||
|
Check failure on line 71 in tidb-cloud/premium/backup-and-restore-premium.md
|
||
| - **Daily Backup**: | ||
| - Runs at a configurable time in **30-minute intervals**. | ||
| - You can configure both **Backup Retention** (1–33 days) and **Backup Time**. | ||
|
Check failure on line 74 in tidb-cloud/premium/backup-and-restore-premium.md
|
||
|
|
||
| 4. Click **Save** to save your settings. | ||
|
|
||
| ### Delete backup files | ||
|
|
||
| To delete an existing backup file for your {{{ .premium }}} instance, perform the following steps: | ||
|
|
||
| 1. Navigate to the [**Backup**](#view-the-backup-page) page of your instance. | ||
|
|
||
| 2. Locate the corresponding backup file you want to delete, and click **...** > **Delete** in the **Action** column. | ||
|
|
||
| ## Restore | ||
|
|
||
| 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. | ||
|
|
||
| ### Restore mode | ||
|
|
||
| TiDB Cloud supports snapshot restore and point-in-time restore for your instance. | ||
|
|
||
| - **Snapshot Restore**: restores your instance from a specific backup snapshot. | ||
|
|
||
| - **Point-in-Time Restore**: restores your instance to a specific point in time. | ||
|
|
||
| - 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. | ||
|
|
||
| ### Restore destination | ||
|
|
||
| TiDB Cloud supports restoring data to a new instance. | ||
|
|
||
| ### Restore to a new instance | ||
|
|
||
| > **Note:** | ||
| > | ||
| > User credentials and permissions from the source instance will **not** be restored to the new instance. You must recreate any users and permissions manually in the new instance. | ||
|
||
|
|
||
| To restore your data to a new instance, take the following steps: | ||
|
|
||
| 1. Navigate to the [**Backup**](#view-the-backup-page) page of your instance. | ||
|
|
||
| 2. Click **Restore**. | ||
|
|
||
| 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. | ||
|
|
||
| <SimpleTab> | ||
| <div label="Snapshot Restore"> | ||
|
|
||
| To restore from a selected backup snapshot, take the following steps: | ||
|
|
||
| 1. Click **Snapshot Restore**. | ||
| 2. Select the backup snapshot you want to restore from. | ||
|
|
||
| </div> | ||
| <div label="Point-in-Time Restore"> | ||
|
|
||
| To restore to a specific point in time for a Premium instance, 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 **Next** to proceed to the **Restore to a New Instance** page. | ||
|
|
||
| 5. Configure your new TiDB instance for restoration. The steps are the same as [creating a new TiDB instance](/tidb-cloud/create-tidb-cluster-premium.md). | ||
|
||
|
|
||
| > **Note:** | ||
| > | ||
| > The new instance uses the same cloud provider and region as the backup by default. | ||
|
|
||
| 6. Click **Restore** to start the restore process. | ||
|
|
||
| Once the restore process begins, the instance status changes to **Restoring**. The instance will remain unavailable until the restore is complete and the status changes to **Available**. | ||
|
||
|
|
||
| ### Restore from Recycle Bin | ||
|
|
||
| To restore a deleted instance from the Recycle Bin, take the following steps: | ||
|
|
||
| 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**. | ||
|
|
||
| 2. On the **Recycle Bin** page, locate the TiDB instance you want to restore: | ||
|
|
||
| - Click the **>** button to expand instance details. | ||
| - Find the desired backup, click **...** in the **Action** column, and then select **Restore**. | ||
|
|
||
| 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. | ||
|
|
||
| ## Limitations | ||
|
|
||
| - Manual backups are not supported for Premium instances. | ||
lilin90 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not support dedicated