[doc](backup)Modify backup and restore documentation #1906
Conversation
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
morrySnow
reviewed
Jan 22, 2025
| ... | ||
| ) | ||
| PROPERTIES ("key"="value", ...); | ||
| BACKUP SNAPSHOT <db_name>.{<snapshot_name>} |
There was a problem hiding this comment.
这个花括号，应该是方括号？
Suggested change
| BACKUP SNAPSHOT <db_name>.{<snapshot_name>} | |
| BACKUP SNAPSHOT <db_name>[.<snapshot_name>] |
| PROPERTIES ("key"="value", ...); | ||
| BACKUP SNAPSHOT <db_name>.{<snapshot_name>} | ||
| TO `<repository_name>` | ||
| [ON|EXCLUDE] |
There was a problem hiding this comment.
这个方括号，应该是花括号？然后 ON 后面都是可选的？所以在 ON 前面应该有个方括号？
Suggested change
| [ON|EXCLUDE] | |
| [ { ON | EXCLUDE } |
| illustrate: | ||
| ## Required Parameters | ||
|
|
||
| `<db_name>` |
There was a problem hiding this comment.
- 需要加粗
- 需要序号
Suggested change
| `<db_name>` | |
| ** 1. `<db_name>`** |
| ( <table_name> [ PARTITION ( <partition_name> [, ...] ) ] | ||
| [, ...] ) ] | ||
|
|
||
| [PROPERTIES ("key" = "value" [,...])]; |
There was a problem hiding this comment.
Suggested change
| [PROPERTIES ("key" = "value" [,...])]; | |
| [ PROPERTIES ( "<key>" = "<value>" [ , ... ] )]]; |
|
|
||
| The name of the partition to be backed up. If not specified, all partitions of the corresponding table will be backed up. | ||
|
|
||
| `<PROPERTIES>` |
There was a problem hiding this comment.
Suggested change
| `<PROPERTIES>` | |
| `[ PROPERTIES ( "<key>" = "<value>" [ , ... ] ) ]` |
|
|
||
| ```sql | ||
| RESTORE SNAPSHOT [db_name].{snapshot_name} | ||
| FROM `repository_name` | ||
| RESTORE SNAPSHOT [<db_name>].{<snapshot_name>} |
| illustrate: | ||
| ## Parameters | ||
|
|
||
| `<db_name>` |
| 2. brief: only show key information of RESTORE tasks, columns RestoreObjs, Progress, TaskErrMsg will not show | ||
|
|
||
|
|
||
| ## Parameters |
| 2. brief: only show key information of RESTORE tasks, columns RestoreObjs, Progress, TaskErrMsg will not show | ||
|
|
||
|
|
||
| ## Parameters |
There was a problem hiding this comment.
注意，语法章节，需要区分必选参数(Required Parameters)和可选参数(Optional Parameters)，分成两个小节
| SHOW SNAPSHOT ON example_repo | ||
| WHERE SNAPSHOT = "backup1" AND TIMESTAMP = "2018-05-05-15-34-26"; | ||
| ``` | ||
| | Column | Note | |
There was a problem hiding this comment.
Suggested change
| | Column | Note | | |
| | Column | Description | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Versions
Languages
Docs Checklist