[Doc] Fix database related documentation #1927
Open
+1,326
−1,030
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 24, 2025
| @@ -27,79 +27,70 @@ under the License. | |||
|
|
|||
| ## Description | |||
|
|
|||
| This statement is used to set properties of the specified database. (administrator only) | |||
| This statement is used to set the properties of the specified database. (For administrators only) | |||
There was a problem hiding this comment.
Suggested change
| This statement is used to set the properties of the specified database. (For administrators only) | |
| This statement is used to set the properties of the specified database. |
|
|
||
| ```sql | ||
| ALTER DATABASE db_name SET DATA QUOTA quota; | ||
| ALTER DATABASE <db_name> RENAME|SET DATA QUOTA|REPLICA QUOT <new_db_name>|<quota> [PROPERTIES ("<key>"="<value>", ...)] |
There was a problem hiding this comment.
这语法不太对。其实是三个语法
- rename
- set quota
- set properties
现在这个语法和实际的对不上
Suggested change
| ALTER DATABASE <db_name> RENAME|SET DATA QUOTA|REPLICA QUOT <new_db_name>|<quota> [PROPERTIES ("<key>"="<value>", ...)] | |
| ALTER DATABASE <db_name> RENAME <new_name> | |
| ALTER DATABASE <db_name> SET { DATA | REPLICA | TRANSACTION } QUOTA <quota> | |
| ALTER DATABASE <db_name> SET PROPERTIES ("<key>" = "<value>" [, ...]) |
| @@ -27,79 +27,70 @@ under the License. | |||
|
|
|||
| ## Description | |||
|
|
|||
| This statement is used to set properties of the specified database. (administrator only) | |||
| This statement is used to set the properties of the specified database. (For administrators only) | |||
There was a problem hiding this comment.
描述和语义不符。alter database 不止可以设置属性，还能改动 db 名字，以及设定 db 的多种 quota。需要在描述中，把上面的内容都涉及到
| CREATE DATABASE [IF NOT EXISTS] db_name | ||
| [PROPERTIES ("key"="value", ...)]; | ||
| CREATE DATABASE [IF NOT EXISTS] <db_name> | ||
| [PROPERTIES ("<key>"="<value>", ...)]; |
There was a problem hiding this comment.
Suggested change
| [PROPERTIES ("<key>"="<value>", ...)]; | |
| [PROPERTIES ("<key>"="<value>" [ , ... ])]; |
|
|
||
| ```sql | ||
| DROP DATABASE [IF EXISTS] db_name [FORCE]; | ||
| DROP DATABASE [IF EXISTS] <db_name> [<FORCE>]; |
There was a problem hiding this comment.
不是参数的部分，不用加尖括号
Suggested change
| DROP DATABASE [IF EXISTS] <db_name> [<FORCE>]; | |
| DROP DATABASE [IF EXISTS] <db_name> [FORCE]; |
| ## Example | ||
| ## Optional parameters | ||
|
|
||
| ** 1. `<FORCE>`** |
There was a problem hiding this comment.
Suggested change
| ** 1. `<FORCE>`** | |
| ** 1. `FORCE`** |
|
|
||
| ```sql | ||
| SHOW CREATE DATABASE db_name; | ||
| SHOW CREATE DATABASE [<catalog>].<db_name>; |
There was a problem hiding this comment.
Suggested change
| SHOW CREATE DATABASE [<catalog>].<db_name>; | |
| SHOW CREATE DATABASE [<catalog_name>.]<db_name>; |
Comment on lines
+50
to
+52
| | Database | Create Database | | ||
| |:---------|:-----------| | ||
| | Database Name | Corresponding database creation statement | |
There was a problem hiding this comment.
Suggested change
| | Database | Create Database | | |
| |:---------|:-----------| | |
| | Database Name | Corresponding database creation statement | | |
| | Column | Description | | |
| |:---------|:-----------| | |
| | Database | Database name | | |
| | Create Database | Corresponding database creation statement | |
Comment on lines
+45
to
+47
| | DbName | | ||
| |:---------| | ||
| | Database Name | |
Comment on lines
+48
to
+50
| | Database | | ||
| |:-------| | ||
| | Database Name | |
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