From 9280ed1a19b4f61aa226510d63b7f9e980bdbc38 Mon Sep 17 00:00:00 2001 From: hillium Date: Tue, 28 Nov 2023 18:07:19 +0800 Subject: [PATCH 1/3] add expiremential notion in BACKUP and RESTORE sql Signed-off-by: hillium --- sql-statements/sql-statement-backup.md | 4 ++++ sql-statements/sql-statement-restore.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/sql-statements/sql-statement-backup.md b/sql-statements/sql-statement-backup.md index 0e9bf219cd45..03b7e09bab6f 100644 --- a/sql-statements/sql-statement-backup.md +++ b/sql-statements/sql-statement-backup.md @@ -5,6 +5,10 @@ summary: TiDB 数据库中 BACKUP 的使用概况。 # BACKUP +> **警告：** +> +> 基于 SQL 发起的 BACKUP 目前是实验性功能，不建议在生产环境中使用。 + `BACKUP` 语句用于对 TiDB 集群执行分布式备份操作。 `BACKUP` 语句使用的引擎与 [BR](/br/backup-and-restore-overview.md) 相同，但备份过程是由 TiDB 本身驱动，而非单独的 BR 工具。BR 工具的优势和警告也适用于 `BACKUP` 语句。 diff --git a/sql-statements/sql-statement-restore.md b/sql-statements/sql-statement-restore.md index 615cd35c12f5..da7863907132 100644 --- a/sql-statements/sql-statement-restore.md +++ b/sql-statements/sql-statement-restore.md @@ -5,6 +5,10 @@ summary: TiDB 数据库中 RESTORE 的使用概况。 # RESTORE +> **警告：** +> +> 基于 SQL 发起的 RESTORE 目前是实验性功能，不建议在生产环境中使用。 + `RESTORE` 语句用于执行分布式恢复，把 [`BACKUP` 语句](/sql-statements/sql-statement-backup.md)生成的备份文件恢复到 TiDB 集群中。 `RESTORE` 语句使用的引擎与 [BR](/br/backup-and-restore-overview.md) 相同，但恢复过程是由 TiDB 本身驱动，而非单独的 BR 工具。BR 工具的优势和警告也适用于 `RESTORE` 语句。需要注意的是，**`RESTORE` 语句目前不遵循 ACID 原则**。 From 5a40f2d18766dec2a1ad3b1a742416632ac26be7 Mon Sep 17 00:00:00 2001 From: Aolin Date: Tue, 28 Nov 2023 20:11:17 +0800 Subject: [PATCH 2/3] refine wording --- sql-statements/sql-statement-backup.md | 2 +- sql-statements/sql-statement-restore.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sql-statements/sql-statement-backup.md b/sql-statements/sql-statement-backup.md index 03b7e09bab6f..50cd2bcdefec 100644 --- a/sql-statements/sql-statement-backup.md +++ b/sql-statements/sql-statement-backup.md @@ -7,7 +7,7 @@ summary: TiDB 数据库中 BACKUP 的使用概况。 > **警告：** > -> 基于 SQL 发起的 BACKUP 目前是实验性功能，不建议在生产环境中使用。 +> `BACKUP` 语句目前为实验特性，不建议在生产环境中使用。该功能可能会在未事先通知的情况下发生变化或删除。如果发现 bug，请在 GitHub 上提 [issue](https://github.com/pingcap/tidb/issues) 反馈。 `BACKUP` 语句用于对 TiDB 集群执行分布式备份操作。 diff --git a/sql-statements/sql-statement-restore.md b/sql-statements/sql-statement-restore.md index da7863907132..2b4205f86a83 100644 --- a/sql-statements/sql-statement-restore.md +++ b/sql-statements/sql-statement-restore.md @@ -7,7 +7,7 @@ summary: TiDB 数据库中 RESTORE 的使用概况。 > **警告：** > -> 基于 SQL 发起的 RESTORE 目前是实验性功能，不建议在生产环境中使用。 +> `RESTORE` 语句目前为实验特性，不建议在生产环境中使用。该功能可能会在未事先通知的情况下发生变化或删除。如果发现 bug，请在 GitHub 上提 [issue](https://github.com/pingcap/tidb/issues) 反馈。 `RESTORE` 语句用于执行分布式恢复，把 [`BACKUP` 语句](/sql-statements/sql-statement-backup.md)生成的备份文件恢复到 TiDB 集群中。 From 262d2e8a1debefa7948097e1917b2bcb7acd1041 Mon Sep 17 00:00:00 2001 From: Aolin Date: Tue, 28 Nov 2023 20:14:11 +0800 Subject: [PATCH 3/3] add note Signed-off-by: Aolin --- 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 b2183ccca3ab..557ecf070dae 100644 --- a/migrate-from-tidb-to-tidb.md +++ b/migrate-from-tidb-to-tidb.md @@ -110,8 +110,8 @@ summary: 了解如何将数据从一个 TiDB 集群迁移至另一 TiDB 集群 > **注意：** > +> - `BACKUP` 和 `RESTORE` 语句目前为实验特性，不建议在生产环境中使用。该功能可能会在未事先通知的情况下发生变化或删除。如果发现 bug，请在 GitHub 上提 [issue](https://github.com/pingcap/tidb/issues) 反馈。 > - 在生产集群中，关闭 GC 机制和备份操作会一定程度上降低集群的读性能，建议在业务低峰期进行备份，并设置合适的 `RATE_LIMIT` 限制备份操作对线上业务的影响。 -> > - 上下游集群版本不一致时，应检查 BR 工具的[兼容性](/br/backup-and-restore-overview.md#使用须知)。本文假设上下游集群版本相同。 1. 关闭 GC。 diff --git a/replicate-between-primary-and-secondary-clusters.md b/replicate-between-primary-and-secondary-clusters.md index 6e6d625eccf9..b27355e9d385 100644 --- a/replicate-between-primary-and-secondary-clusters.md +++ b/replicate-between-primary-and-secondary-clusters.md @@ -105,8 +105,8 @@ summary: 了解如何配置一个 TiDB 集群以及该集群的 TiDB 或 MySQL > **注意：** > +> - `BACKUP` 和 `RESTORE` 语句目前为实验特性，不建议在生产环境中使用。该功能可能会在未事先通知的情况下发生变化或删除。如果发现 bug，请在 GitHub 上提 [issue](https://github.com/pingcap/tidb/issues) 反馈。 > - 在生产集群中，关闭 GC 机制和备份操作会一定程度上降低集群的读性能，建议在业务低峰期进行备份，并设置合适的 `RATE_LIMIT` 限制备份操作对线上业务的影响。 -> > - 上下游集群版本不一致时，应检查 BR 工具的[兼容性](/br/backup-and-restore-overview.md#使用建议)。本文假设上下游集群版本相同。 1. 关闭 GC。