From dc79ada1d722deb0b2e7847e96f765bacde6edfe Mon Sep 17 00:00:00 2001 From: Dan Roscigno Date: Thu, 2 Jan 2025 18:13:22 -0500 Subject: [PATCH] [Doc] fix descriptions, add guide link (#54620) --- .../sql-statements/backup_restore/BACKUP.md | 6 ++++-- .../sql-statements/backup_restore/CANCEL_BACKUP.md | 2 -- .../sql-statements/backup_restore/CANCEL_RESTORE.md | 2 -- .../sql-statements/backup_restore/CREATE_REPOSITORY.md | 6 ++++-- .../sql-statements/backup_restore/DROP_REPOSITORY.md | 2 -- .../sql-statements/backup_restore/RECOVER.md | 2 -- .../sql-statements/backup_restore/RESTORE.md | 6 ++++-- .../sql-statements/backup_restore/SHOW_BACKUP.md | 2 -- .../sql-statements/backup_restore/SHOW_REPOSITORIES.md | 2 -- .../sql-statements/backup_restore/SHOW_RESTORE.md | 2 -- .../sql-statements/backup_restore/SHOW_SNAPSHOT.md | 2 -- .../sql-statements/backup_restore/backup_restore.mdx | 8 -------- .../sql-statements/backup_restore/BACKUP.md | 6 ++++-- .../sql-statements/backup_restore/CANCEL_BACKUP.md | 2 -- .../sql-statements/backup_restore/CANCEL_RESTORE.md | 2 -- .../sql-statements/backup_restore/CREATE_REPOSITORY.md | 6 ++++-- .../sql-statements/backup_restore/DROP_REPOSITORY.md | 2 -- .../sql-statements/backup_restore/RECOVER.md | 2 -- .../sql-statements/backup_restore/RESTORE.md | 6 ++++-- .../sql-statements/backup_restore/SHOW_BACKUP.md | 2 -- .../sql-statements/backup_restore/SHOW_REPOSITORIES.md | 2 -- .../sql-statements/backup_restore/SHOW_RESTORE.md | 2 -- .../sql-statements/backup_restore/backup_restore.mdx | 9 --------- 23 files changed, 24 insertions(+), 59 deletions(-) delete mode 100644 docs/en/sql-reference/sql-statements/backup_restore/backup_restore.mdx delete mode 100644 docs/zh/sql-reference/sql-statements/backup_restore/backup_restore.mdx diff --git a/docs/en/sql-reference/sql-statements/backup_restore/BACKUP.md b/docs/en/sql-reference/sql-statements/backup_restore/BACKUP.md index ae225900914e9..65090143cd799 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/BACKUP.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/BACKUP.md @@ -4,10 +4,12 @@ displayed_sidebar: docs # BACKUP -## Description - Backs up data in a specified database, table, or partition. Currently, StarRocks only supports backing up data in OLAP tables. +:::tip +For an overview of backup and restore please see the [backup and restore guide](../../../administration/management/Backup_and_restore.md). +::: + BACKUP is an asynchronous operation. You can check the status of a BACKUP job status using [SHOW BACKUP](./SHOW_BACKUP.md), or cancel a BACKUP job using [CANCEL BACKUP](./CANCEL_BACKUP.md). You can view the snapshot information using [SHOW SNAPSHOT](./SHOW_SNAPSHOT.md). > **CAUTION** diff --git a/docs/en/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md b/docs/en/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md index 53608afa6d222..bb20391bce47c 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # CANCEL BACKUP -## Description - Cancels an ongoing BACKUP task in a specified database. ## Syntax diff --git a/docs/en/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md b/docs/en/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md index 1e45e4f6fa68c..eff69f63efde8 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # CANCEL RESTORE -## Description - Cancels an ongoing RESTORE task in a specified database. > **CAUTION** diff --git a/docs/en/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md b/docs/en/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md index ecc441b83f3f1..08f21ddce51b8 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md @@ -4,10 +4,12 @@ displayed_sidebar: docs # CREATE REPOSITORY -## Description - Creates a repository in a remote storage system that is used to store data snapshots for backing up and restoring data. +:::tip +For an overview of backup and restore please see the [backup and restore guide](../../../administration/management/Backup_and_restore.md). +::: + > **CAUTION** > > Only users with the ADMIN privilege can create a repository. diff --git a/docs/en/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md b/docs/en/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md index be804276bd21f..9f1deea769846 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # DROP REPOSITORY -## Description - Deletes a repository. Repositories are used to store data snapshots for data backup and restoration. > **CAUTION** diff --git a/docs/en/sql-reference/sql-statements/backup_restore/RECOVER.md b/docs/en/sql-reference/sql-statements/backup_restore/RECOVER.md index 4b256303c0af6..3f960b031e596 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/RECOVER.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/RECOVER.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # RECOVER -## Description - Recovers a database, table, or partition that was dropped by using the DROP command. The dropped database, table, or partition can be recovered within the period specified by the FE parameter `catalog_trash_expire_second` (1 day by default). Data deleted by using [TRUNCATE TABLE](../table_bucket_part_index/TRUNCATE_TABLE.md) cannot be recovered. diff --git a/docs/en/sql-reference/sql-statements/backup_restore/RESTORE.md b/docs/en/sql-reference/sql-statements/backup_restore/RESTORE.md index caf6a19b25057..6dbb807c5f684 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/RESTORE.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/RESTORE.md @@ -4,10 +4,12 @@ displayed_sidebar: docs # RESTORE -## Description - Restores data to a specified database, table, or partition. Currently, StarRocks only supports restoring data to OLAP tables. +:::tip +For an overview of backup and restore please see the [backup and restore guide](../../../administration/management/Backup_and_restore.md). +::: + RESTORE is an asynchronous operation. You can check the status of a RESTORE job using [SHOW RESTORE](./SHOW_RESTORE.md), or cancel a RESTORE job using [CANCEL RESTORE](./CANCEL_RESTORE.md). > **CAUTION** diff --git a/docs/en/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md b/docs/en/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md index 9ee788e87f828..f5a9392c8629d 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # SHOW BACKUP -## Description - Views the last BACKUP task in a specified database. > **NOTE** diff --git a/docs/en/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md b/docs/en/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md index 6610f9c2e4deb..b38f2817a6af2 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # SHOW REPOSITORIES -## Description - Views the repositories created in StarRocks. ## Syntax diff --git a/docs/en/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md b/docs/en/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md index eeee01de276b9..ddd522922b944 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # SHOW RESTORE -## Description - Views the last RESTORE task in a specified database. > **NOTE** diff --git a/docs/en/sql-reference/sql-statements/backup_restore/SHOW_SNAPSHOT.md b/docs/en/sql-reference/sql-statements/backup_restore/SHOW_SNAPSHOT.md index 620e2d5ff6c22..91a4c3b7f11b5 100644 --- a/docs/en/sql-reference/sql-statements/backup_restore/SHOW_SNAPSHOT.md +++ b/docs/en/sql-reference/sql-statements/backup_restore/SHOW_SNAPSHOT.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # SHOW SNAPSHOT -## Description - Views data snapshots in a specified repository. For more information, see [data backup and restoration](../../../administration/management/Backup_and_restore.md). ## Syntax diff --git a/docs/en/sql-reference/sql-statements/backup_restore/backup_restore.mdx b/docs/en/sql-reference/sql-statements/backup_restore/backup_restore.mdx deleted file mode 100644 index 9983b2f1462b6..0000000000000 --- a/docs/en/sql-reference/sql-statements/backup_restore/backup_restore.mdx +++ /dev/null @@ -1,8 +0,0 @@ ---- -displayed_sidebar: docs ---- - -# Backup and restore - -import DocCardList from '@theme/DocCardList'; - diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/BACKUP.md b/docs/zh/sql-reference/sql-statements/backup_restore/BACKUP.md index c2cf4b2973860..09f1b9f8d8f90 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/BACKUP.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/BACKUP.md @@ -5,10 +5,12 @@ keywords: ['beifen'] # BACKUP -## 功能 - 备份指定数据库、表或分区的数据。当前 StarRocks 仅支持备份 OLAP 类型表。更多信息,请见 备份和恢复。 +:::tip +有关备份和恢复的概述,请参阅 [备份和恢复指南](../../../administration/management/Backup_and_restore.md) 中。 +::: + 数据备份为异步操作。您可以通过 [SHOW BACKUP](./SHOW_BACKUP.md) 语句查看备份作业状态,或通过 [CANCEL BACKUP](./CANCEL_BACKUP.md) 语句取消备份作业。作业成功后,您可以通过 [SHOW SNAPSHOT](./SHOW_SNAPSHOT.md) 查看特定仓库对应的数据快照信息。 > **注意** diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md b/docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md index 967ffff1b7ce2..16bb395044b28 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md @@ -5,8 +5,6 @@ keywords: ['beifen'] # CANCEL BACKUP -## 功能 - 取消指定数据库中一个正在进行的备份任务。更多信息,请见 备份和恢复。 ## 语法 diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md b/docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md index a7bfaed4480d4..088aa5877c32d 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md @@ -5,8 +5,6 @@ keywords: ['beifen'] # CANCEL RESTORE -## 功能 - 取消指定数据库中一个正在进行的恢复任务。更多信息,请见 备份和恢复。 > **注意** diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md b/docs/zh/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md index a503d0b8b6a26..ea2b760e71784 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md @@ -5,10 +5,12 @@ keywords: ['beifen'] # CREATE REPOSITORY -## 功能 - 基于远端存储系统创建用于存储数据快照的仓库。仓库用于 备份和恢复 数据库数据。 +:::tip +有关备份和恢复的概述,请参阅 [备份和恢复指南](../../../administration/management/Backup_and_restore.md) 中。 +::: + > **注意** > > 只有拥有 System 级 REPOSITORY 权限的用户才可以创建仓库。 diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md b/docs/zh/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md index cf8b9a4aa3592..38b168a5f840e 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md @@ -5,8 +5,6 @@ keywords: ['beifen'] # DROP REPOSITORY -## 功能 - 删除一个仓库。仓库用于 备份和恢复 数据库数据。 > **注意** diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/RECOVER.md b/docs/zh/sql-reference/sql-statements/backup_restore/RECOVER.md index 8fb572c2aa774..51eb984d4a9d1 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/RECOVER.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/RECOVER.md @@ -5,8 +5,6 @@ keywords: ['beifen'] # RECOVER -## 功能 - 恢复之前通过 DROP 操作删除的 database、table 或者 partition。DROP 操作后只有在指定的时间内才能通过 RECOVER 恢复数据,超过这个时间无法恢复。该时间由 FE 动态参数 `catalog_trash_expire_second` 控制,默认 1 天。 通过 [TRUNCATE TABLE](../table_bucket_part_index/TRUNCATE_TABLE.md) 命令删除的数据无法恢复。 diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/RESTORE.md b/docs/zh/sql-reference/sql-statements/backup_restore/RESTORE.md index 733e2d38e8cfd..84087af44baaf 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/RESTORE.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/RESTORE.md @@ -5,10 +5,12 @@ keywords: ['beifen'] # RESTORE -## 功能 - 恢复指定数据库、表或分区的数据。当前 StarRocks 仅支持恢复 OLAP 类型表。更多信息,请见 备份和恢复。 +:::tip +有关备份和恢复的概述,请参阅 [备份和恢复指南](../../../administration/management/Backup_and_restore.md) 中。 +::: + 数据恢复为异步操作。您可以通过 [SHOW RESTORE](./SHOW_RESTORE.md) 语句查看恢复作业状态,或通过 [CANCEL RESTORE](./CANCEL_RESTORE.md) 语句取消恢复作业。 > **注意** diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md b/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md index d104635ec14ad..c65bc5a3802fe 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # SHOW BACKUP -## 功能 - 查看指定数据库中的备份任务。更多信息,请见 备份和恢复。 > **说明** diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md b/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md index 89b4d18f0002f..3f328ff43cae4 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # SHOW REPOSITORIES -## 功能 - 查看当前已创建的仓库。 ## 语法 diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md b/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md index 28f7d943d184a..2f3f05aa017ec 100644 --- a/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md +++ b/docs/zh/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md @@ -4,8 +4,6 @@ displayed_sidebar: docs # SHOW RESTORE -## 功能 - 查看指定数据库中的恢复任务。更多信息,请见 备份和恢复。 > **说明** diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/backup_restore.mdx b/docs/zh/sql-reference/sql-statements/backup_restore/backup_restore.mdx deleted file mode 100644 index 45c23861b4635..0000000000000 --- a/docs/zh/sql-reference/sql-statements/backup_restore/backup_restore.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -displayed_sidebar: docs -keywords: ['beifen'] ---- - -# 备份与恢复 - -import DocCardList from '@theme/DocCardList'; -