[Doc] fix descriptions, add guide link (#54620)

(cherry picked from commit dc79ada) # Conflicts: # docs/en/cover_pages/functions_utility.mdx # docs/en/sql-reference/sql-statements/backup_restore/RECOVER.md # docs/en/sql-reference/sql-statements/data-definition/BACKUP.md # docs/en/sql-reference/sql-statements/data-definition/CANCEL_BACKUP.md # docs/en/sql-reference/sql-statements/data-definition/CANCEL_RESTORE.md # docs/en/sql-reference/sql-statements/data-definition/CREATE_REPOSITORY.md # docs/en/sql-reference/sql-statements/data-definition/DROP_REPOSITORY.md # docs/en/sql-reference/sql-statements/data-definition/RESTORE.md # docs/en/sql-reference/sql-statements/data-manipulation/SHOW_BACKUP.md # docs/en/sql-reference/sql-statements/data-manipulation/SHOW_RESTORE.md # docs/en/sql-reference/sql-statements/data-manipulation/SHOW_SNAPSHOT.md # docs/zh/sql-reference/sql-statements/backup_restore/RECOVER.md # docs/zh/sql-reference/sql-statements/data-definition/BACKUP.md # docs/zh/sql-reference/sql-statements/data-definition/CANCEL_BACKUP.md # docs/zh/sql-reference/sql-statements/data-definition/CANCEL_RESTORE.md # docs/zh/sql-reference/sql-statements/data-definition/CREATE_REPOSITORY.md # docs/zh/sql-reference/sql-statements/data-definition/DROP_REPOSITORY.md # docs/zh/sql-reference/sql-statements/data-definition/RESTORE.md # docs/zh/sql-reference/sql-statements/data-manipulation/SHOW_BACKUP.md # docs/zh/sql-reference/sql-statements/data-manipulation/SHOW_RESTORE.md
StarRocks · Jan 2, 2025 · 45074f6 · 45074f6
1 parent b5721df
commit 45074f6
Show file tree

Hide file tree

Showing 21 changed files with 214 additions and 4 deletions.
diff --git a/docs/en/sql-reference/sql-statements/backup_restore/RECOVER.md b/docs/en/sql-reference/sql-statements/backup_restore/RECOVER.md
@@ -0,0 +1,54 @@
+---
+displayed_sidebar: docs
+---
+
+# RECOVER
+
+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.
+
+## Syntax
+
+1. Recover a database.
+
+    ```sql
+    RECOVER DATABASE <db_name>
+    ```
+
+2. Recover a table.
+
+    ```sql
+    RECOVER TABLE [<db_name>.]<table_name>
+    ```
+
+3. Recover a partition.
+
+    ```sql
+    RECOVER PARTITION <partition_name> FROM [<db_name>.]<table_name>
+    ```
+
+Note:
+
+1. This command can only recover metadata deleted some time ago (1 day by default). You can change the duration by adjusting the FE parameter `catalog_trash_expire_second`.
+2. If the metadata is deleted with identical metadata created, the previous one will not be recovered.
+
+## Examples
+
+1. Recover database `example_db`.
+
+    ```sql
+    RECOVER DATABASE example_db;
+    ```
+
+2. Recover table `example_tbl`.
+
+    ```sql
+    RECOVER TABLE example_db.example_tbl;
+    ```
+
+3. Recover partition `p1` in the `example_tbl` table.
+
+    ```sql
+    RECOVER PARTITION p1 FROM example_tbl;
+    ```
diff --git a/docs/en/sql-reference/sql-statements/data-definition/BACKUP.md b/docs/en/sql-reference/sql-statements/data-definition/BACKUP.md
@@ -4,11 +4,21 @@ displayed_sidebar: "English"
 
 # BACKUP
 
+<<<<<<< HEAD:docs/en/sql-reference/sql-statements/data-definition/BACKUP.md
 ## Description
 
 Backs up data in a specified database, table, or partition. Currently, StarRocks only supports backing up data in OLAP tables. For more information, see [data backup and restoration](../../../administration/Backup_and_restore.md).
 
 BACKUP is an asynchronous operation. You can check the status of a BACKUP job status using [SHOW BACKUP](../data-manipulation/SHOW_BACKUP.md), or cancel a BACKUP job using [CANCEL BACKUP](../data-definition/CANCEL_BACKUP.md). You can view the snapshot information using [SHOW SNAPSHOT](../data-manipulation/SHOW_SNAPSHOT.md).
+=======
+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).
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/en/sql-reference/sql-statements/backup_restore/BACKUP.md
 
 > **CAUTION**
 >

diff --git a/docs/en/sql-reference/sql-statements/data-definition/CANCEL_BACKUP.md b/docs/en/sql-reference/sql-statements/data-definition/CANCEL_BACKUP.md
@@ -4,9 +4,13 @@ displayed_sidebar: "English"
 
 # CANCEL BACKUP
 
+<<<<<<< HEAD:docs/en/sql-reference/sql-statements/data-definition/CANCEL_BACKUP.md
 ## Description
 
 Cancels an on-going BACKUP task in a specified database. For more information, see [data backup and restoration](../../../administration/Backup_and_restore.md).
+=======
+Cancels an ongoing BACKUP task in a specified database.
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/en/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md
 
 ## Syntax
 

diff --git a/docs/en/sql-reference/sql-statements/data-definition/CANCEL_RESTORE.md b/docs/en/sql-reference/sql-statements/data-definition/CANCEL_RESTORE.md
@@ -4,9 +4,13 @@ displayed_sidebar: "English"
 
 # CANCEL RESTORE
 
+<<<<<<< HEAD:docs/en/sql-reference/sql-statements/data-definition/CANCEL_RESTORE.md
 ## Description
 
 Cancels an on-going RESTORE task in a specified database. For more information, see [data backup and restoration](../../../administration/Backup_and_restore.md).
+=======
+Cancels an ongoing RESTORE task in a specified database.
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/en/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md
 
 > **CAUTION**
 >

diff --git a/docs/en/sql-reference/sql-statements/data-definition/CREATE_REPOSITORY.md b/docs/en/sql-reference/sql-statements/data-definition/CREATE_REPOSITORY.md
@@ -4,9 +4,17 @@ displayed_sidebar: "English"
 
 # CREATE REPOSITORY
 
+<<<<<<< HEAD:docs/en/sql-reference/sql-statements/data-definition/CREATE_REPOSITORY.md
 ## Description
 
 Creates a repository in a remote storage system that is used to store data snapshots for [backing up and restoring data](../../../administration/Backup_and_restore.md).
+=======
+Creates a repository in a remote storage system that is used to store data snapshots for backing up and restoring data.
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/en/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md
+
+:::tip
+For an overview of backup and restore please see the [backup and restore guide](../../../administration/management/Backup_and_restore.md).
+:::
 
 > **CAUTION**
 >

diff --git a/docs/en/sql-reference/sql-statements/data-definition/DROP_REPOSITORY.md b/docs/en/sql-reference/sql-statements/data-definition/DROP_REPOSITORY.md
@@ -4,9 +4,13 @@ displayed_sidebar: "English"
 
 # DROP REPOSITORY
 
+<<<<<<< HEAD:docs/en/sql-reference/sql-statements/data-definition/DROP_REPOSITORY.md
 ## Description
 
 Deletes a repository. Repositories are used to store data snapshots for [data backup and restoration](../../../administration/Backup_and_restore.md).
+=======
+Deletes a repository. Repositories are used to store data snapshots for data backup and restoration.
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/en/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md
 
 > **CAUTION**
 >

diff --git a/docs/en/sql-reference/sql-statements/data-definition/RESTORE.md b/docs/en/sql-reference/sql-statements/data-definition/RESTORE.md
@@ -4,11 +4,21 @@ displayed_sidebar: "English"
 
 # RESTORE
 
+<<<<<<< HEAD:docs/en/sql-reference/sql-statements/data-definition/RESTORE.md
 ## Description
 
 Restores data to a specified database, table, or partition. Currently, StarRocks only supports restoring data to OLAP tables. For more information, see [data backup and restoration](../../../administration/Backup_and_restore.md).
 
 RESTORE is an asynchronous operation. You can check the status of a RESTORE job using [SHOW RESTORE](../data-manipulation/SHOW_RESTORE.md), or cancel a RESTORE job using [CANCEL RESTORE](../data-definition/CANCEL_RESTORE.md).
+=======
+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).
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/en/sql-reference/sql-statements/backup_restore/RESTORE.md
 
 > **CAUTION**
 >

diff --git a/docs/en/sql-reference/sql-statements/data-manipulation/SHOW_BACKUP.md b/docs/en/sql-reference/sql-statements/data-manipulation/SHOW_BACKUP.md
@@ -4,9 +4,13 @@ displayed_sidebar: "English"
 
 # SHOW BACKUP
 
+<<<<<<< HEAD:docs/en/sql-reference/sql-statements/data-manipulation/SHOW_BACKUP.md
 ## Description
 
 Views the last BACKUP task in a specified database. For more information, see [data backup and restoration](../../../administration/Backup_and_restore.md).
+=======
+Views the last BACKUP task in a specified database.
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/en/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md
 
 > **NOTE**
 >

diff --git a/docs/en/sql-reference/sql-statements/data-manipulation/SHOW_REPOSITORIES.md b/docs/en/sql-reference/sql-statements/data-manipulation/SHOW_REPOSITORIES.md
@@ -4,8 +4,6 @@ displayed_sidebar: "English"
 
 # SHOW REPOSITORIES
 
-## Description
-
 Views the repositories created in StarRocks.
 
 ## Syntax

diff --git a/docs/en/sql-reference/sql-statements/data-manipulation/SHOW_RESTORE.md b/docs/en/sql-reference/sql-statements/data-manipulation/SHOW_RESTORE.md
@@ -4,9 +4,13 @@ displayed_sidebar: "English"
 
 # SHOW RESTORE
 
+<<<<<<< HEAD:docs/en/sql-reference/sql-statements/data-manipulation/SHOW_RESTORE.md
 ## Description
 
 Views the last RESTORE task in a specified database. For more information, see [data backup and restoration](../../../administration/Backup_and_restore.md).
+=======
+Views the last RESTORE task in a specified database.
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/en/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md
 
 > **NOTE**
 >

diff --git a/docs/en/sql-reference/sql-statements/data-manipulation/SHOW_SNAPSHOT.md b/docs/en/sql-reference/sql-statements/data-manipulation/SHOW_SNAPSHOT.md
@@ -4,9 +4,13 @@ displayed_sidebar: "English"
 
 # SHOW SNAPSHOT
 
+<<<<<<< HEAD:docs/en/sql-reference/sql-statements/data-manipulation/SHOW_SNAPSHOT.md
 ## Description
 
 Views data snapshots in a specified repository. For more information, see [data backup and restoration](../../../administration/Backup_and_restore.md).
+=======
+Views data snapshots in a specified repository. For more information, see [data backup and restoration](../../../administration/management/Backup_and_restore.md).
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/en/sql-reference/sql-statements/backup_restore/SHOW_SNAPSHOT.md
 
 ## Syntax
 

diff --git a/docs/zh/sql-reference/sql-statements/backup_restore/RECOVER.md b/docs/zh/sql-reference/sql-statements/backup_restore/RECOVER.md
@@ -0,0 +1,60 @@
+---
+displayed_sidebar: docs
+keywords: ['beifen']
+---
+
+# RECOVER
+
+恢复之前通过 DROP 操作删除的 database、table 或者 partition。DROP 操作后只有在指定的时间内才能通过 RECOVER 恢复数据，超过这个时间无法恢复。该时间由 FE 动态参数 `catalog_trash_expire_second` 控制，默认 1 天。
+
+通过 [TRUNCATE TABLE](../table_bucket_part_index/TRUNCATE_TABLE.md) 命令删除的数据无法恢复。
+
+> **注意**
+>
+> 只有拥有 default_catalog 的 CREATE DATABASE 权限才可以恢复数据库；同时需要拥有对应数据库的 CREATE TABLE 和对应表的 DROP 权限。
+
+## 语法
+
+### 恢复 database
+
+```sql
+RECOVER DATABASE <db_name>
+```
+
+### 恢复 table
+
+```sql
+RECOVER TABLE [db_name.]table_name;
+```
+
+### 恢复 partition
+
+```sql
+RECOVER PARTITION partition_name FROM [db_name.]table_name;
+```
+
+说明：
+
+1. 该操作仅能恢复之前一段时间内删除的元信息，默认为 1 天。（可通过 `fe.conf` 中 `catalog_trash_expire_second` 参数配置。）
+
+2. 如果删除元信息后新建了同名同类型的元信息，则之前删除的元信息不能被恢复。
+
+## 示例
+
+1. 恢复名为 `example_db` 的 database。
+
+    ```sql
+    RECOVER DATABASE example_db;
+    ```
+
+2. 恢复名为 `example_tbl` 的 table。
+
+    ```sql
+    RECOVER TABLE example_db.example_tbl;
+    ```
+
+3. 恢复表 `example_tbl` 中名为 `p1` 的 partition。
+
+    ```sql
+    RECOVER PARTITION p1 FROM example_tbl;
+    ```
diff --git a/docs/zh/sql-reference/sql-statements/data-definition/BACKUP.md b/docs/zh/sql-reference/sql-statements/data-definition/BACKUP.md
@@ -4,11 +4,21 @@ displayed_sidebar: "Chinese"
 
 # BACKUP
 
+<<<<<<< HEAD:docs/zh/sql-reference/sql-statements/data-definition/BACKUP.md
 ## 功能
 
 备份指定数据库、表或分区的数据。当前 StarRocks 仅支持备份 OLAP 类型表。更多信息，请见 [备份和恢复](../../../administration/Backup_and_restore.md)。
 
 数据备份为异步操作。您可以通过 [SHOW BACKUP](../data-manipulation/SHOW_BACKUP.md) 语句查看备份作业状态，或通过 [CANCEL BACKUP](../data-definition/CANCEL_BACKUP.md) 语句取消备份作业。作业成功后，您可以通过 [SHOW SNAPSHOT](../data-manipulation/SHOW_SNAPSHOT.md) 查看特定仓库对应的数据快照信息。
+=======
+备份指定数据库、表或分区的数据。当前 StarRocks 仅支持备份 OLAP 类型表。更多信息，请见 备份和恢复。
+
+:::tip
+有关备份和恢复的概述，请参阅 [备份和恢复指南](../../../administration/management/Backup_and_restore.md) 中。
+:::
+
+数据备份为异步操作。您可以通过 [SHOW BACKUP](./SHOW_BACKUP.md) 语句查看备份作业状态，或通过 [CANCEL BACKUP](./CANCEL_BACKUP.md) 语句取消备份作业。作业成功后，您可以通过 [SHOW SNAPSHOT](./SHOW_SNAPSHOT.md) 查看特定仓库对应的数据快照信息。
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/zh/sql-reference/sql-statements/backup_restore/BACKUP.md
 
 > **注意**
 >

diff --git a/docs/zh/sql-reference/sql-statements/data-definition/CANCEL_BACKUP.md b/docs/zh/sql-reference/sql-statements/data-definition/CANCEL_BACKUP.md
@@ -4,9 +4,13 @@ displayed_sidebar: "Chinese"
 
 # CANCEL BACKUP
 
+<<<<<<< HEAD:docs/zh/sql-reference/sql-statements/data-definition/CANCEL_BACKUP.md
 ## 功能
 
 取消指定数据库中一个正在进行的备份任务。更多信息，请见 [备份和恢复](../../../administration/Backup_and_restore.md)。
+=======
+取消指定数据库中一个正在进行的备份任务。更多信息，请见 备份和恢复。
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md
 
 ## 语法
 

diff --git a/docs/zh/sql-reference/sql-statements/data-definition/CANCEL_RESTORE.md b/docs/zh/sql-reference/sql-statements/data-definition/CANCEL_RESTORE.md
@@ -4,9 +4,13 @@ displayed_sidebar: "Chinese"
 
 # CANCEL RESTORE
 
+<<<<<<< HEAD:docs/zh/sql-reference/sql-statements/data-definition/CANCEL_RESTORE.md
 ## 功能
 
 取消指定数据库中一个正在进行的恢复任务。更多信息，请见 [备份和恢复](../../../administration/Backup_and_restore.md)。
+=======
+取消指定数据库中一个正在进行的恢复任务。更多信息，请见 备份和恢复。
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md
 
 > **注意**
 >

diff --git a/docs/zh/sql-reference/sql-statements/data-definition/CREATE_REPOSITORY.md b/docs/zh/sql-reference/sql-statements/data-definition/CREATE_REPOSITORY.md
@@ -4,9 +4,17 @@ displayed_sidebar: "Chinese"
 
 # CREATE REPOSITORY
 
+<<<<<<< HEAD:docs/zh/sql-reference/sql-statements/data-definition/CREATE_REPOSITORY.md
 ## 功能
 
 基于远端存储系统创建用于存储数据快照的仓库。仓库用于 [备份和恢复](../../../administration/Backup_and_restore.md) 数据库数据。
+=======
+基于远端存储系统创建用于存储数据快照的仓库。仓库用于 备份和恢复 数据库数据。
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/zh/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md
+
+:::tip
+有关备份和恢复的概述，请参阅 [备份和恢复指南](../../../administration/management/Backup_and_restore.md) 中。
+:::
 
 > **注意**
 >

diff --git a/docs/zh/sql-reference/sql-statements/data-definition/DROP_REPOSITORY.md b/docs/zh/sql-reference/sql-statements/data-definition/DROP_REPOSITORY.md
@@ -4,9 +4,13 @@ displayed_sidebar: "Chinese"
 
 # DROP REPOSITORY
 
+<<<<<<< HEAD:docs/zh/sql-reference/sql-statements/data-definition/DROP_REPOSITORY.md
 ## 功能
 
 删除一个仓库。仓库用于 [备份和恢复](../../../administration/Backup_and_restore.md) 数据库数据。
+=======
+删除一个仓库。仓库用于 备份和恢复 数据库数据。
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/zh/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md
 
 > **注意**
 >

diff --git a/docs/zh/sql-reference/sql-statements/data-definition/RESTORE.md b/docs/zh/sql-reference/sql-statements/data-definition/RESTORE.md
@@ -4,11 +4,21 @@ displayed_sidebar: "Chinese"
 
 # RESTORE
 
+<<<<<<< HEAD:docs/zh/sql-reference/sql-statements/data-definition/RESTORE.md
 ## 功能
 
 恢复指定数据库、表或分区的数据。当前 StarRocks 仅支持恢复 OLAP 类型表。更多信息，请见 [备份和恢复](../../../administration/Backup_and_restore.md)。
 
 数据恢复为异步操作。您可以通过 [SHOW RESTORE](../data-manipulation/SHOW_RESTORE.md) 语句查看恢复作业状态，或通过 [CANCEL RESTORE](../data-definition/CANCEL_RESTORE.md) 语句取消恢复作业。
+=======
+恢复指定数据库、表或分区的数据。当前 StarRocks 仅支持恢复 OLAP 类型表。更多信息，请见 备份和恢复。
+
+:::tip
+有关备份和恢复的概述，请参阅 [备份和恢复指南](../../../administration/management/Backup_and_restore.md) 中。
+:::
+
+数据恢复为异步操作。您可以通过 [SHOW RESTORE](./SHOW_RESTORE.md) 语句查看恢复作业状态，或通过 [CANCEL RESTORE](./CANCEL_RESTORE.md) 语句取消恢复作业。
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/zh/sql-reference/sql-statements/backup_restore/RESTORE.md
 
 > **注意**
 >

diff --git a/docs/zh/sql-reference/sql-statements/data-manipulation/SHOW_BACKUP.md b/docs/zh/sql-reference/sql-statements/data-manipulation/SHOW_BACKUP.md
@@ -4,9 +4,13 @@ displayed_sidebar: "Chinese"
 
 # SHOW BACKUP
 
+<<<<<<< HEAD:docs/zh/sql-reference/sql-statements/data-manipulation/SHOW_BACKUP.md
 ## 功能
 
 查看指定数据库中的备份任务。更多信息，请见 [备份和恢复](../../../administration/Backup_and_restore.md)。
+=======
+查看指定数据库中的备份任务。更多信息，请见 备份和恢复。
+>>>>>>> dc79ada1d7 ([Doc] fix descriptions, add guide link (#54620)):docs/zh/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md
 
 > **说明**
 >

diff --git a/docs/zh/sql-reference/sql-statements/data-manipulation/SHOW_REPOSITORIES.md b/docs/zh/sql-reference/sql-statements/data-manipulation/SHOW_REPOSITORIES.md
@@ -4,8 +4,6 @@ displayed_sidebar: "Chinese"
 
 # SHOW REPOSITORIES
 
-## 功能
-
 查看当前已创建的仓库。
 
 ## 语法