morrySnow commented on code in PR #1906:
URL: https://github.com/apache/doris-website/pull/1906#discussion_r1928554548
##########
docs/sql-manual/sql-statements/data-modification/backup-and-restore/BACKUP.md:
##########
@@ -28,30 +28,64 @@ under the License.
## Description
-This statement is used to back up the data under the specified database. This
command is an asynchronous operation. After the submission is successful, you
need to check the progress through the SHOW BACKUP command. Only backing up
tables of type OLAP is supported.
+This statement is used to back up the data under the specified database. This
command is an asynchronous operation. After the submission is successful, you
need to check the progress through the [SHOW BACKUP](./SHOW-BACKUP.md) command.
- Only root or superuser users can create repositories.
-
-grammar:
+## Syntax
```sql
-BACKUP SNAPSHOT [db_name].{snapshot_name}
-TO `repository_name`
-[ON|EXCLUDE] (
- `table_name` [PARTITION (`p1`, ...)],
- ...
-)
-PROPERTIES ("key"="value", ...);
+BACKUP SNAPSHOT <db_name>.<snapshot_name>
+TO `<repository_name>`
+[ {ON|EXCLUDE]}
Review Comment:
```suggestion
[ { ON | EXCLUDE } ]
```
##########
docs/sql-manual/sql-statements/data-modification/backup-and-restore/BACKUP.md:
##########
@@ -28,30 +28,64 @@ under the License.
## Description
-This statement is used to back up the data under the specified database. This
command is an asynchronous operation. After the submission is successful, you
need to check the progress through the SHOW BACKUP command. Only backing up
tables of type OLAP is supported.
+This statement is used to back up the data under the specified database. This
command is an asynchronous operation. After the submission is successful, you
need to check the progress through the [SHOW BACKUP](./SHOW-BACKUP.md) command.
- Only root or superuser users can create repositories.
-
-grammar:
+## Syntax
```sql
-BACKUP SNAPSHOT [db_name].{snapshot_name}
-TO `repository_name`
-[ON|EXCLUDE] (
- `table_name` [PARTITION (`p1`, ...)],
- ...
-)
-PROPERTIES ("key"="value", ...);
+BACKUP SNAPSHOT <db_name>.<snapshot_name>
Review Comment:
```suggestion
BACKUP SNAPSHOT [<db_name>.]<snapshot_name>
```
##########
docs/sql-manual/sql-statements/data-modification/backup-and-restore/BACKUP.md:
##########
@@ -28,30 +28,64 @@ under the License.
## Description
-This statement is used to back up the data under the specified database. This
command is an asynchronous operation. After the submission is successful, you
need to check the progress through the SHOW BACKUP command. Only backing up
tables of type OLAP is supported.
+This statement is used to back up the data under the specified database. This
command is an asynchronous operation. After the submission is successful, you
need to check the progress through the [SHOW BACKUP](./SHOW-BACKUP.md) command.
- Only root or superuser users can create repositories.
-
-grammar:
+## Syntax
```sql
-BACKUP SNAPSHOT [db_name].{snapshot_name}
-TO `repository_name`
-[ON|EXCLUDE] (
- `table_name` [PARTITION (`p1`, ...)],
- ...
-)
-PROPERTIES ("key"="value", ...);
+BACKUP SNAPSHOT <db_name>.<snapshot_name>
+TO `<repository_name>`
+[ {ON|EXCLUDE]}
+ ( <table_name> [ PARTITION ( <partition_name> [, ...] ) ]
+ [, ...] ) ]
+
+[ PROPERTIES ( "<key>" = "<value>" [ , ... ] )]]
Review Comment:
这最后，是多了一个方括号吗？
##########
docs/sql-manual/sql-statements/data-modification/backup-and-restore/RESTORE.md:
##########
@@ -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 command. Restoring tables of type OLAP is only supported.
+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.
-grammar:
+## Syntax
```sql
-RESTORE SNAPSHOT [db_name].{snapshot_name}
-FROM `repository_name`
-[ON|EXCLUDE] (
- `table_name` [PARTITION (`p1`, ...)] [AS `tbl_alias`],
- ...
+RESTORE SNAPSHOT <db_name>.<snapshot_name>
+FROM `<repository_name>`
+[{ON|EXCLUDE]} (
+ `<table_name>` [PARTITION (`<partition_name>`, ...)] [AS `<table_alias>`]
+ [, ...] ) ]
)
-PROPERTIES ("key"="value", ...);
+[ PROPERTIES ( "<key>" = "<value>" [ , ... ] )]]
Review Comment:
最后多了个方括号吗？
##########
docs/sql-manual/sql-statements/data-modification/backup-and-restore/RESTORE.md:
##########
@@ -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 command. Restoring tables of type OLAP is only supported.
+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.
-grammar:
+## Syntax
```sql
-RESTORE SNAPSHOT [db_name].{snapshot_name}
-FROM `repository_name`
-[ON|EXCLUDE] (
- `table_name` [PARTITION (`p1`, ...)] [AS `tbl_alias`],
- ...
+RESTORE SNAPSHOT <db_name>.<snapshot_name>
+FROM `<repository_name>`
+[{ON|EXCLUDE]} (
Review Comment:
```suggestion
[ { ON | EXCLUDE } ] (
```
##########
docs/sql-manual/sql-statements/data-modification/backup-and-restore/SHOW-BACKUP.md:
##########
@@ -29,49 +29,47 @@ under the License.
This statement is used to view BACKUP tasks
-grammar:
+## Syntax
```sql
- SHOW BACKUP [FROM db_name]
- [WHERE SnapshotName ( LIKE | = ) 'snapshot name']
+ SHOW BACKUP [FROM <db_name>]
+ [WHERE SnapshotName ( LIKE | = ) '<snapshot_name>' ]
Review Comment:
```suggestion
[WHERE SnapshotName { LIKE | = } '<snapshot_name>' ]
```
##########
docs/sql-manual/sql-statements/data-modification/backup-and-restore/RESTORE.md:
##########
@@ -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 command. Restoring tables of type OLAP is only supported.
+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.
-grammar:
+## Syntax
```sql
-RESTORE SNAPSHOT [db_name].{snapshot_name}
-FROM `repository_name`
-[ON|EXCLUDE] (
- `table_name` [PARTITION (`p1`, ...)] [AS `tbl_alias`],
- ...
+RESTORE SNAPSHOT <db_name>.<snapshot_name>
Review Comment:
```suggestion
RESTORE SNAPSHOT [<db_name>.]<snapshot_name>
```
##########
docs/sql-manual/sql-statements/data-modification/backup-and-restore/BACKUP.md:
##########
@@ -28,30 +28,64 @@ under the License.
## Description
-This statement is used to back up the data under the specified database. This
command is an asynchronous operation. After the submission is successful, you
need to check the progress through the SHOW BACKUP command. Only backing up
tables of type OLAP is supported.
+This statement is used to back up the data under the specified database. This
command is an asynchronous operation. After the submission is successful, you
need to check the progress through the [SHOW BACKUP](./SHOW-BACKUP.md) command.
- Only root or superuser users can create repositories.
-
-grammar:
+## Syntax
```sql
-BACKUP SNAPSHOT [db_name].{snapshot_name}
-TO `repository_name`
-[ON|EXCLUDE] (
- `table_name` [PARTITION (`p1`, ...)],
- ...
-)
-PROPERTIES ("key"="value", ...);
+BACKUP SNAPSHOT <db_name>.<snapshot_name>
+TO `<repository_name>`
+[ {ON|EXCLUDE]}
+ ( <table_name> [ PARTITION ( <partition_name> [, ...] ) ]
+ [, ...] ) ]
+
+[ PROPERTIES ( "<key>" = "<value>" [ , ... ] )]]
```
-illustrate:
+## Required Parameters
+
+**1.`<db_name>`**
+
+The name of the database to which the data to be backed up belongs.
+
+**2.`<snapshot_name>`**
+
+Specify the data snapshot name. The snapshot name cannot be repeated and is
globally unique.
+
+**3.`<repository_name>`**
+
+Warehouse name. You can create a repository via [CREATE
REPOSITORY](./CREATE-REPOSITORY.md).
+
+## Optional Parameters
+
+**1.`<table_name>`**
+
+The name of the table to be backed up. If not specified, the entire database
will be backed up.
-- There can only be one executing BACKUP or RESTORE task under the same
database.
- The ON clause identifies the tables and partitions that need to be backed
up. If no partition is specified, all partitions of the table are backed up by
default
- Tables and partitions that do not require backup are identified in the
EXCLUDE clause. Back up all partition data for all tables in this database
except the specified table or partition.
-- PROPERTIES currently supports the following properties:
- - "type" = "full": indicates that this is a full update (default)
- - "timeout" = "3600": The task timeout period, the default is one day. in
seconds.
+
+**2.`<partition_name>`**
+
+The name of the partition to be backed up. If not specified, all partitions of
the corresponding table will be backed up.
+
+**3.`[ PROPERTIES ( "<key>" = "<value>" [ , ... ] ) ]`**
+
+Data snapshot attributes, in the format: `<key>` = `<value>`，currently
supports the following properties:
+
+- "type" = "full": indicates that this is a full update (default)
+- "timeout" = "3600": The task timeout period, the default is one day. in
seconds.
+
+## Access Control Requirements
+
+Only root or superuser users can create repositories.
Review Comment:
这里用权限来描述，是拥有什么权限的用户才能创建？
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
