From 932442ced1fd3348d1025f7bd28ac47c4e97106d Mon Sep 17 00:00:00 2001 From: Aolin Date: Tue, 28 Nov 2023 20:20:51 +0800 Subject: [PATCH 1/3] add experimental note for BACKUP and RESTORE statements Signed-off-by: Aolin --- migrate-from-tidb-to-tidb.md | 6 +++--- replicate-between-primary-and-secondary-clusters.md | 4 ++-- sql-statements/sql-statement-backup.md | 5 +++-- sql-statements/sql-statement-restore.md | 6 ++++-- 4 files changed, 12 insertions(+), 9 deletions(-) diff --git a/migrate-from-tidb-to-tidb.md b/migrate-from-tidb-to-tidb.md index 18b9f7bad2bfe..63d71027806ec 100644 --- a/migrate-from-tidb-to-tidb.md +++ b/migrate-from-tidb-to-tidb.md @@ -103,9 +103,9 @@ After setting up the environment, you can use the backup and restore functions o > **Note:** > -> In production clusters, performing a backup with GC disabled might affect cluster performance. It is recommended that you back up data in off-peak hours, and set `RATE_LIMIT` to a proper value to avoid performance degradation. -> -> If the versions of the upstream and downstream clusters are different, you should check [BR compatibility](/br/backup-and-restore-overview.md#before-you-use). In this document, we assume that the upstream and downstream clusters are the same version. +> - `BACKUP` and `RESTORE` SQL statements are experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. +> - In production clusters, performing a backup with GC disabled might affect cluster performance. It is recommended that you back up data in off-peak hours, and set `RATE_LIMIT` to a proper value to avoid performance degradation. +> - If the versions of the upstream and downstream clusters are different, you should check [BR compatibility](/br/backup-and-restore-overview.md#before-you-use). In this document, we assume that the upstream and downstream clusters are the same version. 1. Disable GC. diff --git a/replicate-between-primary-and-secondary-clusters.md b/replicate-between-primary-and-secondary-clusters.md index 0871b6182127b..77698bc6b1791 100644 --- a/replicate-between-primary-and-secondary-clusters.md +++ b/replicate-between-primary-and-secondary-clusters.md @@ -98,12 +98,12 @@ To replicate incremental data from a running TiDB cluster to its secondary clust ## Step 2. Migrate full data -After setting up the environment, you can use the backup and restore functions of [BR](https://github.com/pingcap/tidb/tree/master/br)) to migrate full data. BR can be started in [three ways](/br/br-use-overview.md#deploy-and-use-br). In this document, we use the SQL statements, `BACKUP` and `RESTORE`. +After setting up the environment, you can use the backup and restore functions of [BR](https://github.com/pingcap/tidb/tree/master/br) to migrate full data. BR can be started in [three ways](/br/br-use-overview.md#deploy-and-use-br). In this document, we use the SQL statements, `BACKUP` and `RESTORE`. > **Note:** > +> - `BACKUP` and `RESTORE` SQL statements are experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. > - In production clusters, performing a backup with GC disabled might affect cluster performance. It is recommended that you back up data in off-peak hours, and set RATE_LIMIT to a proper value to avoid performance degradation. -> > - If the versions of the upstream and downstream clusters are different, you should check [BR compatibility](/br/backup-and-restore-overview.md#some-tips). In this document, we assume that the upstream and downstream clusters are the same version. 1. Disable GC. diff --git a/sql-statements/sql-statement-backup.md b/sql-statements/sql-statement-backup.md index 7a86bf8c34d05..11604511c9c4e 100644 --- a/sql-statements/sql-statement-backup.md +++ b/sql-statements/sql-statement-backup.md @@ -7,9 +7,10 @@ summary: An overview of the usage of BACKUP for the TiDB database. This statement is used to perform a distributed backup of the TiDB cluster. -> **Note:** +> **Warning:** > -> This feature is not available on [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) clusters. +> - This feature is experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. +> - This feature is not available on [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) clusters. The `BACKUP` statement uses the same engine as the [BR tool](https://docs.pingcap.com/tidb/stable/backup-and-restore-overview) does, except that the backup process is driven by TiDB itself rather than a separate BR tool. All benefits and warnings of BR also apply to this statement. diff --git a/sql-statements/sql-statement-restore.md b/sql-statements/sql-statement-restore.md index 6cea3d1fade7a..95a96bec36916 100644 --- a/sql-statements/sql-statement-restore.md +++ b/sql-statements/sql-statement-restore.md @@ -7,9 +7,11 @@ summary: An overview of the usage of RESTORE for the TiDB database. This statement performs a distributed restore from a backup archive previously produced by a [`BACKUP` statement](/sql-statements/sql-statement-backup.md). -> **Note:** +> **Warning:** > -> This feature is not available on [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) clusters. +> - This feature is experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. +> +> - This feature is not available on [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) clusters. The `RESTORE` statement uses the same engine as the [BR tool](https://docs.pingcap.com/tidb/stable/backup-and-restore-overview), except that the restore process is driven by TiDB itself rather than a separate BR tool. All benefits and caveats of BR also apply here. In particular, **`RESTORE` is currently not ACID-compliant**. Before running `RESTORE`, ensure that the following requirements are met: From c2f62d669a1d71c424f1a646966061026596f544 Mon Sep 17 00:00:00 2001 From: Aolin Date: Tue, 28 Nov 2023 20:24:11 +0800 Subject: [PATCH 2/3] fix format --- sql-statements/sql-statement-restore.md | 1 - 1 file changed, 1 deletion(-) diff --git a/sql-statements/sql-statement-restore.md b/sql-statements/sql-statement-restore.md index 95a96bec36916..25c2a496b5dc3 100644 --- a/sql-statements/sql-statement-restore.md +++ b/sql-statements/sql-statement-restore.md @@ -10,7 +10,6 @@ This statement performs a distributed restore from a backup archive previously p > **Warning:** > > - This feature is experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. -> > - This feature is not available on [TiDB Serverless](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-serverless) clusters. The `RESTORE` statement uses the same engine as the [BR tool](https://docs.pingcap.com/tidb/stable/backup-and-restore-overview), except that the restore process is driven by TiDB itself rather than a separate BR tool. All benefits and caveats of BR also apply here. In particular, **`RESTORE` is currently not ACID-compliant**. Before running `RESTORE`, ensure that the following requirements are met: From 556c0ed6331b640771eca060e4ce2ae16618bdec Mon Sep 17 00:00:00 2001 From: Aolin Date: Wed, 29 Nov 2023 11:29:50 +0800 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: xixirangrang --- migrate-from-tidb-to-tidb.md | 2 +- replicate-between-primary-and-secondary-clusters.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/migrate-from-tidb-to-tidb.md b/migrate-from-tidb-to-tidb.md index 63d71027806ec..3e3c0de72d67d 100644 --- a/migrate-from-tidb-to-tidb.md +++ b/migrate-from-tidb-to-tidb.md @@ -103,7 +103,7 @@ After setting up the environment, you can use the backup and restore functions o > **Note:** > -> - `BACKUP` and `RESTORE` SQL statements are experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. +> - `BACKUP` and `RESTORE` SQL statements are experimental. It is not recommended that you use them in the production environment. They might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. > - In production clusters, performing a backup with GC disabled might affect cluster performance. It is recommended that you back up data in off-peak hours, and set `RATE_LIMIT` to a proper value to avoid performance degradation. > - If the versions of the upstream and downstream clusters are different, you should check [BR compatibility](/br/backup-and-restore-overview.md#before-you-use). In this document, we assume that the upstream and downstream clusters are the same version. diff --git a/replicate-between-primary-and-secondary-clusters.md b/replicate-between-primary-and-secondary-clusters.md index 77698bc6b1791..3209f435e3e3e 100644 --- a/replicate-between-primary-and-secondary-clusters.md +++ b/replicate-between-primary-and-secondary-clusters.md @@ -102,7 +102,7 @@ After setting up the environment, you can use the backup and restore functions o > **Note:** > -> - `BACKUP` and `RESTORE` SQL statements are experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. +> - `BACKUP` and `RESTORE` SQL statements are experimental. It is not recommended that you use them in the production environment. They might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. > - In production clusters, performing a backup with GC disabled might affect cluster performance. It is recommended that you back up data in off-peak hours, and set RATE_LIMIT to a proper value to avoid performance degradation. > - If the versions of the upstream and downstream clusters are different, you should check [BR compatibility](/br/backup-and-restore-overview.md#some-tips). In this document, we assume that the upstream and downstream clusters are the same version.