Skip to content

Commit 4bb0fcd

Browse files
committed
Merge branch 'release-8.5' into pr/21926
2 parents d578810 + 3860ae9 commit 4bb0fcd

15 files changed

+523
-20
lines changed

TOC-tidb-cloud-premium.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,15 +128,16 @@
128128

129129
## GUIDES
130130

131-
- Manage Cluster
131+
- Manage Instances
132132
- [Select Your Cluster Plan](/tidb-cloud/select-cluster-tier.md)
133-
- Manage TiDB Cloud Clusters
134-
- [Create a TiDB Cloud Cluster](/tidb-cloud/create-tidb-cluster-serverless.md)
133+
- Manage TiDB Cloud Instances
134+
- [Create a {{{ .premium }}} Instance](/tidb-cloud/premium/create-tidb-instance-premium.md)
135135
- Connect to Your TiDB Cloud Cluster
136136
- [Connection Overview](/tidb-cloud/premium/connect-to-tidb-instance.md)
137137
- [Connect via Public Endpoint](/tidb-cloud/premium/connect-to-premium-via-public-connection.md)
138+
- [Connect via Private Endpoint with AWS](/tidb-cloud/premium/connect-to-premium-via-aws-private-endpoint.md)
138139
- [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md)
139-
- [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)
140141
- Use an HTAP Cluster with TiFlash
141142
- [TiFlash Overview](/tiflash/tiflash-overview.md)
142143
- [Create TiFlash Replicas](/tiflash/create-tiflash-replicas.md)

develop/dev-guide-connection-parameters.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,38 @@ It is a common practice that the connection pool size is well adjusted according
3434

3535
The application needs to return the connection after finishing using it. It is recommended that the application uses the corresponding connection pool monitoring (such as **metricRegistry**) to locate connection pool issues in time.
3636

37+
### Configure the lifetime of connections
38+
39+
When a TiDB server shuts down, restarts for maintenance, or encounters unexpected issues such as hardware or network failures, your existing client connections might be reset, which can lead to application disruptions. To avoid such issues, it is recommended to close and recreate long-running database connections at least once a day.
40+
41+
Most connection pool libraries provide a parameter to control the maximum lifetime of a connection:
42+
43+
<SimpleTab>
44+
<div label="HikariCP">
45+
46+
- **`maxLifetime`**: The maximum lifetime of a connection in the pool.
47+
48+
</div>
49+
50+
<div label="tomcat-jdbc">
51+
52+
- **`maxAge`**: The maximum lifetime of a connection in the pool.
53+
54+
</div>
55+
56+
<div label="c3p0">
57+
58+
- **`maxConnectionAge`**: The maximum lifetime of a connection in the pool.
59+
60+
</div>
61+
62+
<div label="dbcp">
63+
64+
- **`maxConnLifetimeMillis`**: The maximum lifetime of a connection in the pool.
65+
66+
</div>
67+
</SimpleTab>
68+
3769
### Probe configuration
3870

3971
The connection pool maintains persistent connections from clients to TiDB as follows:
@@ -293,4 +325,4 @@ Ask the community on [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc) or
293325

294326
Ask the community on [Discord](https://discord.gg/DQZ2dy3cuc?utm_source=doc) or [Slack](https://slack.tidb.io/invite?team=tidb-community&channel=everyone&ref=pingcap-docs), or [submit a support ticket](https://tidb.support.pingcap.com/).
295327

296-
</CustomContent>
328+
</CustomContent>

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

Lines changed: 7 additions & 4 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

@@ -33,13 +33,16 @@ Automatic backup settings vary between {{{ .starter }}} clusters and {{{ .essent
3333
| Backup setting | {{{ .starter }}} (free) | {{{ .starter }}} (with spending limit > 0) | {{{ .essential }}} |
3434
|------------------|----------------------------|----------------------------|----------------------------|
3535
| Backup Cycle | Daily | Daily | Daily |
36-
| Backup Retention | 1 day | 30 days | 30 days |
36+
| Backup Retention | 1 day | Up to 30 days | Up to 30 days |
3737
| Backup Time | Fixed time | Configurable | Configurable |
3838

3939
- **Backup Cycle** is the frequency at which backups are taken.
4040

4141
- **Backup Retention** is the duration for which backups are retained. Expired backups cannot be restored.
4242

43+
- For a free {{{ .starter }}} cluster, the backup retention is 1 day.
44+
- For a {{{ .starter }}} (with spending limit > 0) or {{{ .essential }}} cluster, you can configure the backup retention to any value between 1 and 30 days. The default retention is 14 days.
45+
4346
- **Backup Time** is the time when the backup starts to be scheduled. Note that the final backup time might fall behind the configured backup time.
4447

4548
- For a free {{{ .starter }}} cluster, the backup time is a randomly fixed time.
@@ -70,7 +73,7 @@ TiDB Cloud supports snapshot restore and point-in-time restore for your cluster.
7073
- **Point-in-Time Restore (beta)**: restores your cluster to a specific time.
7174

7275
- {{{ .starter }}} clusters: not supported.
73-
- {{{ .essential }}} clusters: restores to any time within the last 30 days, 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.
7477

7578
### Restore destination
7679

tidb-cloud/essential/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings
107107

108108
<LearningPath label="Billing" icon="cloud2">
109109

110-
[Pricing](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing#pricing-for-starter/?plan=essential)
110+
[Pricing](https://www.pingcap.com/tidb-cloud-essential-pricing-details/)
111111

112112
[Invoices](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing#invoices/?plan=essential)
113113

tidb-cloud/premium/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings
107107

108108
<LearningPath label="Billing" icon="cloud2">
109109

110-
[Pricing](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-billing#pricing-for-starter/?plan=premium)
110+
[Pricing](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-billing#pricing-for-premium/?plan=premium)
111111

112112
[Invoices](https://docs-preview.pingcap.com/tidbcloud/tidb-cloud-billing#invoices/?plan=premium)
113113

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)