[doc](backup)Modify backup and restore documentation #1906
+1,450
−1,306
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| --- | ||
| { | ||
| "title": "CANCEL BACKUP", | ||
| "language": "en" | ||
| } | ||
| --- | ||
|
|
||
|
|
@@ -24,28 +24,26 @@ specific language governing permissions and limitations | |
| under the License. | ||
| --> | ||
|
|
||
| ## Description | ||
|
|
||
| This statement is used to cancel an ongoing BACKUP task. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```sql | ||
| CANCEL BACKUP FROM <db_name>; | ||
| ``` | ||
|
|
||
| ## Parameters | ||
|
|
||
| **1.`<db_name>`** | ||
|
|
||
| The name of the database to which the backup task belongs. | ||
|
|
||
|
|
||
| ## Example | ||
|
|
||
| 1. Cancel the BACKUP task under example_db. | ||
|
|
||
| ```sql | ||
| CANCEL BACKUP FROM example_db; | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,13 +30,19 @@ under the License. | |
|
|
||
| This statement is used to cancel an ongoing RESTORE task. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```sql | ||
| CANCEL RESTORE FROM <db_name>; | ||
|
|
||
| ``` | ||
|
|
||
| ## Parameters | ||
|
|
||
| **1.`<db_name>`** | ||
|
|
||
| The name of the database to which the recovery task belongs. | ||
|
|
||
| ## Usage Notes | ||
|
|
||
| - When cancellation is around a COMMIT or later stage of recovery, the table being recovered may be rendered inaccessible. At this time, data recovery can only be performed by executing the recovery job again. | ||
|
|
||
|
|
@@ -48,8 +54,3 @@ Notice: | |
| CANCEL RESTORE FROM example_db; | ||
| ``` | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,7 +1,7 @@ | ||||||
| --- | ||||||
| { | ||||||
| "title": "RESTORE", | ||||||
| "language": "en" | ||||||
| } | ||||||
|
|
||||||
| --- | ||||||
|
|
@@ -25,44 +25,76 @@ specific language governing permissions and limitations | |||||
| under the License. | ||||||
| --> | ||||||
|
|
||||||
| ## Description | ||||||
|
|
||||||
| This statement is used to restore the data backed up by the BACKUP command to the specified database. This command is an asynchronous operation. After the submission is successful, you need to check the progress through the [SHOW RESTORE](./SHOW-RESTORE.md) command. | ||||||
|
|
||||||
| ## Syntax | ||||||
|
|
||||||
| ```sql | ||||||
| RESTORE SNAPSHOT <db_name>.<snapshot_name> | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| FROM `<repository_name>` | ||||||
| [{ON|EXCLUDE]} ( | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| `<table_name>` [PARTITION (`<partition_name>`, ...)] [AS `<table_alias>`] | ||||||
| [, ...] ) ] | ||||||
| ) | ||||||
| [ PROPERTIES ( "<key>" = "<value>" [ , ... ] )]] | ||||||
|
|
||||||
| ``` | ||||||
|
|
||||||
| ## Required Parameters | ||||||
|
|
||||||
| **1.`<db_name>`** | ||||||
|
|
||||||
| The name of the database to which the data to be restored belongs | ||||||
|
|
||||||
| **2.`<snapshot_name>`** | ||||||
|
|
||||||
| Data snapshot name | ||||||
|
|
||||||
| **3.`<repository_name>`** | ||||||
|
|
||||||
| Warehouse name. You can create a repository via [CREATE REPOSITORY](./CREATE-REPOSITORY.md) | ||||||
|
|
||||||
| **4.`[ PROPERTIES ( "<key>" = "<value>" [ , ... ] ) ]`** | ||||||
|
|
||||||
| Restoration operation attributes, the format is `<key>` = `<value>`，currently supports the following properties: | ||||||
|
|
||||||
| - "backup_timestamp" = "2018-05-04-16-45-08": Specifies which time version of the corresponding backup to restore, required. This information can be obtained with the `SHOW SNAPSHOT ON repo;` statement. | ||||||
| - "replication_num" = "3": Specifies the number of replicas for the restored table or partition. Default is 3. If restoring an existing table or partition, the number of replicas must be the same as the number of replicas of the existing table or partition. At the same time, there must be enough hosts to accommodate multiple replicas. | ||||||
| - "reserve_replica" = "true": Default is false. When this property is true, the replication_num property is ignored and the restored table or partition will have the same number of replication as before the backup. Supports multiple tables or multiple partitions within a table with different replication number. | ||||||
| - "reserve_dynamic_partition_enable" = "true": Default is false. When this property is true, the restored table will have the same value of 'dynamic_partition_enable' as before the backup. if this property is not true, the restored table will set 'dynamic_partition_enable=false'. | ||||||
| - "timeout" = "3600": The task timeout period, the default is one day. in seconds. | ||||||
| - "meta_version" = 40: Use the specified meta_version to read the previously backed up metadata. Note that this parameter is used as a temporary solution and is only used to restore the data backed up by the old version of Doris. The latest version of the backup data already contains the meta version, no need to specify it. | ||||||
| - "clean_tables" : Indicates whether to clean up tables that do not belong to the restore target. For example, if the target db before the restore has tables that are not present in the snapshot, specifying `clean_tables` can drop these extra tables and move them into the recycle bin during the restore. | ||||||
| - This feature is supported since the Apache Doris 1.2.6 version | ||||||
| - "clean_partitions": Indicates whether to clean up partitions that do not belong to the restore target. For example, if the target table before the restore has partitions that are not present in the snapshot, specifying `clean_partitions` can drop these extra partitions and move them into the recycle bin during the restore. | ||||||
| - This feature is supported since the Apache Doris 1.2.6 version | ||||||
|
|
||||||
| ## Optional Parameters | ||||||
|
|
||||||
| **1.`<table_name>`** | ||||||
|
|
||||||
| The name of the table to be restored. If not specified, the entire database will be restored. | ||||||
|
|
||||||
| - The tables and partitions that need to be restored are identified in the ON clause. If no partition is specified, all partitions of the table are restored by default. The specified table and partition must already exist in the warehouse backup. | ||||||
| - Tables and partitions that do not require recovery are identified in the EXCLUDE clause. All partitions of all other tables in the warehouse except the specified table or partition will be restored. | ||||||
|
|
||||||
| **2.`<partition_name>`** | ||||||
|
|
||||||
| The name of the partition to be restored. If not specified, all partitions of the corresponding table will be restored. | ||||||
|
|
||||||
| **3.`<table_alias>`** | ||||||
|
|
||||||
| table alias | ||||||
|
|
||||||
| ## Usage Notes | ||||||
|
|
||||||
| - Restoring tables of type OLAP is only supported. | ||||||
| - There can only be one executing BACKUP or RESTORE task under the same database. | ||||||
| - You can restore the backed up tables in the warehouse to replace the existing tables of the same name in the database, but you must ensure that the table structures of the two tables are exactly the same. The table structure includes: table name, column, partition, Rollup, etc. | ||||||
| - You can specify some partitions of the recovery table, and the system will check whether the partition Range or List can match. | ||||||
| - The table name backed up in the warehouse can be restored to a new table through the AS statement. But the new table name cannot already exist in the database. The partition name cannot be modified. | ||||||
| - Efficiency of recovery operations:In the case of the same cluster size, the time-consuming of the restore operation is basically the same as the time-consuming of the backup operation. If you want to speed up the recovery operation, you can first restore only one copy by setting the `replication_num` parameter, and then adjust the number of copies by [ALTER TABLE PROPERTY](../../../../sql-manual/sql-statements/table-and-view/table/ALTER-TABLE-PROPERTY), complete the copy. | ||||||
|
|
||||||
| ## Example | ||||||
|
|
||||||
|
|
@@ -106,21 +138,3 @@ PROPERTIES | |||||
| "backup_timestamp"="2018-05-04-18-12-18" | ||||||
| ); | ||||||
| ``` | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -29,49 +29,47 @@ under the License. | |||||
|
|
||||||
| This statement is used to view BACKUP tasks | ||||||
|
|
||||||
| ## Syntax | ||||||
|
|
||||||
| ```sql | ||||||
| SHOW BACKUP [FROM <db_name>] | ||||||
| [WHERE SnapshotName ( LIKE | = ) '<snapshot_name>' ] | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| ``` | ||||||
|
|
||||||
| ## Parameters | ||||||
|
|
||||||
| **1.`<db_name>`** | ||||||
|
|
||||||
| The name of the database to which the backup task belongs. | ||||||
|
|
||||||
| **2.`<snapshot_name>`** | ||||||
|
|
||||||
| Backup name. | ||||||
|
|
||||||
| ## Return Value | ||||||
|
|
||||||
| | Column | Description | | ||||||
| | -- | -- | | ||||||
| | JobId | Unique job id | | ||||||
| | SnapshotName | The name of the backup | | ||||||
| | DbName | belongs to the database | | ||||||
| | State | current stage:<ul><li>PENDING: The initial state after submitting the job.</li><li>SNAPSHOTING: Executing snapshot.</li><li>UPLOAD_SNAPSHOT: Snapshot completed, ready to upload.</li><li>UPLOADING: Snapshot uploading.</li><li>SAVE_META: Save job meta information to a local file.</li><li>UPLOAD_INFO: Upload job meta information.</li><li>FINISHED: The job was successful.</li><li>CANCELLED: Job failed.</li></ul> | | ||||||
| | BackupObjs | Backed up tables and partitions | | ||||||
| | CreateTime | task submission time | | ||||||
| | SnapshotFinishedTime | Snapshot completion time | | ||||||
| | UploadFinishedTime | Snapshot upload completion time | | ||||||
| | FinishedTime | Job finish time | | ||||||
| | UnfinishedTasks | Displays unfinished subtask ids during SNAPSHOTING and UPLOADING stages | | ||||||
| | Progress | Task progress | | ||||||
| | TaskErrMsg | Display task error messages | | ||||||
| | Status | If the job fails, display the failure message | | ||||||
| | Timeout | Job timeout, in seconds | | ||||||
|
|
||||||
| ## Example | ||||||
|
|
||||||
| 1. View the last BACKUP task under example_db. | ||||||
|
|
||||||
| ```sql | ||||||
| SHOW BACKUP FROM example_db; | ||||||
| ``` | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.