morrySnow commented on code in PR #1903:
URL: https://github.com/apache/doris-website/pull/1903#discussion_r1942206308
##########
docs/sql-manual/sql-statements/catalog/ALTER-CATALOG.md:
##########
@@ -25,72 +25,87 @@ specific language governing permissions and limitations
under the License.
-->
+## Description
+This statement is used to set properties of the specified catalog.
+## Syntax
+1) Rename the catalog
-## Description
+ ```sql
+ ALTER CATALOG <catalog_name> RENAME <new_catalog_name>;
+ ```
-This statement is used to set properties of the specified catalog.
(administrator only)
+2) Modify / Add properties for the catalog
-1) Rename the catalog
+ ```sql
+ ALTER CATALOG <catalog_name> SET PROPERTIES ('<key1>' = '<value1>' [,
'<key2>' = '<value2>']);
Review Comment:
```suggestion
ALTER CATALOG <catalog_name> SET PROPERTIES ('<key>' = '<value>' [, ...
]);
```
##########
docs/sql-manual/sql-statements/catalog/ALTER-CATALOG.md:
##########
@@ -25,72 +25,87 @@ specific language governing permissions and limitations
under the License.
-->
+## Description
+This statement is used to set properties of the specified catalog.
+## Syntax
+1) Rename the catalog
-## Description
+ ```sql
+ ALTER CATALOG <catalog_name> RENAME <new_catalog_name>;
+ ```
-This statement is used to set properties of the specified catalog.
(administrator only)
+2) Modify / Add properties for the catalog
-1) Rename the catalog
+ ```sql
+ ALTER CATALOG <catalog_name> SET PROPERTIES ('<key1>' = '<value1>' [,
'<key2>' = '<value2>']);
+ ```
-```sql
-ALTER CATALOG catalog_name RENAME new_catalog_name;
-```
+3) Modify comment for the catalog
-illustrate:
+ ```sql
+ ALTER CATALOG <catalog_name> MODIFY COMMENT <"new catalog comment">;
Review Comment:
```suggestion
ALTER CATALOG <catalog_name> MODIFY COMMENT "<new catalog comment>";
```
##########
docs/sql-manual/sql-statements/catalog/ALTER-CATALOG.md:
##########
@@ -25,72 +25,87 @@ specific language governing permissions and limitations
under the License.
-->
+## Description
+This statement is used to set properties of the specified catalog.
+## Syntax
+1) Rename the catalog
-## Description
+ ```sql
+ ALTER CATALOG <catalog_name> RENAME <new_catalog_name>;
+ ```
-This statement is used to set properties of the specified catalog.
(administrator only)
+2) Modify / Add properties for the catalog
-1) Rename the catalog
+ ```sql
+ ALTER CATALOG <catalog_name> SET PROPERTIES ('<key1>' = '<value1>' [,
'<key2>' = '<value2>']);
+ ```
-```sql
-ALTER CATALOG catalog_name RENAME new_catalog_name;
-```
+3) Modify comment for the catalog
-illustrate:
+ ```sql
+ ALTER CATALOG <catalog_name> MODIFY COMMENT <"new catalog comment">;
+ ```
-- The builtin catalog `internal` cannot be renamed
-- Only the one who has at least Alter privilege can rename a catalog
-- After renaming the catalog, use the REVOKE and GRANT commands to modify the
appropriate user permissions
+## Required Parameters
-2) Modify / add properties for the catalog
+**1. `<catalog_name>`**
-```sql
-ALTER CATALOG catalog_name SET PROPERTIES ('key1' = 'value1' [, 'key' =
'value2']);
-```
+The name of the catalog that should be modified
-Update values of specified keys. If a key does not exist in the catalog
properties, it will be added.
+**2. `<new_catalog_name>`**
-illustrate:
+New catalog name after modification
-- property `type` cannot be modified.
-- properties of builtin catalog `internal` cannot be modified.
+**3. `'<key1>' = '<value1>'`**
-3) Modify comment for the catalog
+The key and value of the catalog properties that need to be modified / added
-```sql
-ALTER CATALOG catalog_name MODIFY COMMENT "new catalog comment";
-```
+**4. `<"new catalog comment">`**
Review Comment:
```suggestion
**4. `<new catalog comment>`**
```
##########
docs/sql-manual/sql-statements/catalog/CREATE-CATALOG.md:
##########
@@ -24,18 +24,35 @@ specific language governing permissions and limitations
under the License.
-->
-
## Description
This statement is used to create an external catalog
-Syntax:
+## Syntax
```sql
-CREATE CATALOG [IF NOT EXISTS] catalog_name [comment]
- PROPERTIES ("key"="value", ...);
+CREATE CATALOG [IF NOT EXISTS] <catalog_name> [ COMMENT <comment>]
+ PROPERTIES ("<key>"="<value>", ...);
Review Comment:
```suggestion
PROPERTIES ("<key>"="<value>" [, ... ]);
```
##########
docs/sql-manual/sql-statements/catalog/REFRESH.md:
##########
@@ -24,23 +24,40 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
This statement refreshes the metadata of the specified Catalog/Database/Table.
-syntax:
+## Syntax
```sql
-REFRESH CATALOG catalog_name;
-REFRESH DATABASE [catalog_name.]database_name;
-REFRESH TABLE [catalog_name.][database_name.]table_name;
+REFRESH CATALOG <catalog_name>;
+REFRESH DATABASE [<catalog_name.>]<database_name>;;
+REFRESH TABLE [[<catalog_name.>]<database_name>.]<table_name>;
```
-When the Catalog is refreshed, the object-related Cache is forced to be
invalidated.
+## Required Parameters
+
+**1. `<catalog_name>`**
+
+The name of the catalog that needs to be refreshed.
+
+**2. `<[catalog_name.]database_name>`**
Review Comment:
```suggestion
**2. `[<catalog_name>.]<database_name>`**
```
##########
docs/sql-manual/sql-statements/catalog/REFRESH.md:
##########
@@ -24,23 +24,40 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
This statement refreshes the metadata of the specified Catalog/Database/Table.
-syntax:
+## Syntax
```sql
-REFRESH CATALOG catalog_name;
-REFRESH DATABASE [catalog_name.]database_name;
-REFRESH TABLE [catalog_name.][database_name.]table_name;
+REFRESH CATALOG <catalog_name>;
+REFRESH DATABASE [<catalog_name.>]<database_name>;;
+REFRESH TABLE [[<catalog_name.>]<database_name>.]<table_name>;
```
-When the Catalog is refreshed, the object-related Cache is forced to be
invalidated.
+## Required Parameters
+
+**1. `<catalog_name>`**
+
+The name of the catalog that needs to be refreshed.
+
+**2. `<[catalog_name.]database_name>`**
+
+The name of the database within the catalog that needs to be refreshed.
-Including Partition Cache, Schema Cache, File Cache, etc.
+**3. `<[catalog_name.][database_name.]table_name>`**
Review Comment:
```suggestion
**3. `[[<catalog_name>.]<database_name>.]<table_name>`**
```
##########
docs/sql-manual/sql-statements/catalog/ALTER-CATALOG.md:
##########
@@ -25,72 +25,87 @@ specific language governing permissions and limitations
under the License.
-->
+## Description
+This statement is used to set properties of the specified catalog.
+## Syntax
+1) Rename the catalog
-## Description
+ ```sql
+ ALTER CATALOG <catalog_name> RENAME <new_catalog_name>;
+ ```
-This statement is used to set properties of the specified catalog.
(administrator only)
+2) Modify / Add properties for the catalog
-1) Rename the catalog
+ ```sql
+ ALTER CATALOG <catalog_name> SET PROPERTIES ('<key1>' = '<value1>' [,
'<key2>' = '<value2>']);
+ ```
-```sql
-ALTER CATALOG catalog_name RENAME new_catalog_name;
-```
+3) Modify comment for the catalog
-illustrate:
+ ```sql
+ ALTER CATALOG <catalog_name> MODIFY COMMENT <"new catalog comment">;
+ ```
-- The builtin catalog `internal` cannot be renamed
-- Only the one who has at least Alter privilege can rename a catalog
-- After renaming the catalog, use the REVOKE and GRANT commands to modify the
appropriate user permissions
+## Required Parameters
-2) Modify / add properties for the catalog
+**1. `<catalog_name>`**
-```sql
-ALTER CATALOG catalog_name SET PROPERTIES ('key1' = 'value1' [, 'key' =
'value2']);
-```
+The name of the catalog that should be modified
-Update values of specified keys. If a key does not exist in the catalog
properties, it will be added.
+**2. `<new_catalog_name>`**
-illustrate:
+New catalog name after modification
-- property `type` cannot be modified.
-- properties of builtin catalog `internal` cannot be modified.
+**3. `'<key1>' = '<value1>'`**
Review Comment:
```suggestion
**3. `'<key>' = '<value>'`**
```
##########
docs/sql-manual/sql-statements/catalog/REFRESH.md:
##########
@@ -24,23 +24,40 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
This statement refreshes the metadata of the specified Catalog/Database/Table.
-syntax:
+## Syntax
```sql
-REFRESH CATALOG catalog_name;
-REFRESH DATABASE [catalog_name.]database_name;
-REFRESH TABLE [catalog_name.][database_name.]table_name;
+REFRESH CATALOG <catalog_name>;
+REFRESH DATABASE [<catalog_name.>]<database_name>;;
+REFRESH TABLE [[<catalog_name.>]<database_name>.]<table_name>;
Review Comment:
```suggestion
REFRESH TABLE [[<catalog_name>.]<database_name>.]<table_name>;
```
##########
docs/sql-manual/sql-statements/catalog/CREATE-CATALOG.md:
##########
@@ -24,18 +24,35 @@ specific language governing permissions and limitations
under the License.
-->
-
## Description
This statement is used to create an external catalog
-Syntax:
+## Syntax
```sql
-CREATE CATALOG [IF NOT EXISTS] catalog_name [comment]
- PROPERTIES ("key"="value", ...);
+CREATE CATALOG [IF NOT EXISTS] <catalog_name> [ COMMENT <comment>]
Review Comment:
```suggestion
CREATE CATALOG [IF NOT EXISTS] <catalog_name> [ COMMENT "<comment>"]
```
##########
docs/sql-manual/sql-statements/catalog/REFRESH.md:
##########
@@ -24,23 +24,40 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
This statement refreshes the metadata of the specified Catalog/Database/Table.
-syntax:
+## Syntax
```sql
-REFRESH CATALOG catalog_name;
-REFRESH DATABASE [catalog_name.]database_name;
-REFRESH TABLE [catalog_name.][database_name.]table_name;
+REFRESH CATALOG <catalog_name>;
+REFRESH DATABASE [<catalog_name.>]<database_name>;;
Review Comment:
```suggestion
REFRESH DATABASE [<catalog_name>.]<database_name>;;
```
--
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
