morrySnow commented on code in PR #1904:
URL: https://github.com/apache/doris-website/pull/1904#discussion_r1928067317
##########
docs/sql-manual/sql-statements/table-and-view/table/ALTER-COLOCATE-GROUP.md:
##########
@@ -29,51 +29,53 @@ under the License.
## Description
-This statement is used to modify the colocation group.
+This statement is used to modify the properties of a Colocation Group.
-Syntax:
+## Syntax
```sql
-ALTER COLOCATE GROUP [database.]group
+ALTER COLOCATE GROUP [database.] <group_name>
SET (
- property_list
+ <property_list>
);
```
+## Required Parameters
-NOTE:
+**1. \<group_name\>**
Review Comment:
```suggestion
**1. `<group_name>`**
```
##########
docs/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITIONS.md:
##########
@@ -28,58 +28,125 @@ under the License.
-## Description
+## Descriptions
- This statement is used to display partition information for tables in
Internal catalog or Hive Catalog
+This statement is used to display partition information. It supports both
Internal catalog and Hive Catalog.
-grammar:
+For `Hive Catalog`:
-```SQL
- SHOW [TEMPORARY] PARTITIONS FROM [db_name.]table_name [WHERE] [ORDER BY]
[LIMIT];
+It supports returning all partitions, including multi-level partitions.
+## Syntax
+
+```sql
+SHOW [TEMPORARY] PARTITIONS FROM [db_name.] <table_name> [WHERE] [ORDER BY]
[LIMIT];
Review Comment:
```suggestion
SHOW [ TEMPORARY ] PARTITIONS
FROM [ <db_name>.]<table_name>
[ <where_clause> ]
[ ORDER BY <order_by_key> ]
[ LIMIT <limit_rows> ];
```
##########
docs/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITIONS.md:
##########
@@ -28,58 +28,125 @@ under the License.
-## Description
+## Descriptions
- This statement is used to display partition information for tables in
Internal catalog or Hive Catalog
+This statement is used to display partition information. It supports both
Internal catalog and Hive Catalog.
-grammar:
+For `Hive Catalog`:
-```SQL
- SHOW [TEMPORARY] PARTITIONS FROM [db_name.]table_name [WHERE] [ORDER BY]
[LIMIT];
+It supports returning all partitions, including multi-level partitions.
+## Syntax
+
+```sql
+SHOW [TEMPORARY] PARTITIONS FROM [db_name.] <table_name> [WHERE] [ORDER BY]
[LIMIT];
```
-illustrate:
+## Required Parameters
+**1. \<table_name\>**
-When used in Internal catalog:
+The name of the table for which partition information needs to be viewed must
be specified.
-1. Support the filtering of PartitionId, PartitionName, State, Buckets,
ReplicationNum, LastConsistencyCheckTime and other columns
-2. TEMPORARY specifies to list temporary partitions
+## Optional Parameters
+**1. \<TEMPORARY\>**
-when used in Hive Catalog:
-Will return all partitions' name. Support multilevel partition table
+Whether to query the information of temporary partitions.
+**2. \<db_name\>**
+The name of the database for which partition information needs to be viewed
must be specified.
-## Example
+**3. \<WHERE\>**
-1. Display all non-temporary partition information of the specified table
under the specified db
+Filter conditions, supporting filtering on columns such as PartitionId,
PartitionName, State, Buckets, ReplicationNum, LastConsistencyCheckTime, etc.
Review Comment:
需要说清楚 where_clause 的限制，比如只支持等值比较，列名必须在左侧，等等
##########
docs/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITIONS.md:
##########
@@ -28,58 +28,125 @@ under the License.
-## Description
+## Descriptions
- This statement is used to display partition information for tables in
Internal catalog or Hive Catalog
+This statement is used to display partition information. It supports both
Internal catalog and Hive Catalog.
-grammar:
+For `Hive Catalog`:
-```SQL
- SHOW [TEMPORARY] PARTITIONS FROM [db_name.]table_name [WHERE] [ORDER BY]
[LIMIT];
+It supports returning all partitions, including multi-level partitions.
+## Syntax
+
+```sql
+SHOW [TEMPORARY] PARTITIONS FROM [db_name.] <table_name> [WHERE] [ORDER BY]
[LIMIT];
```
-illustrate:
+## Required Parameters
+**1. \<table_name\>**
-When used in Internal catalog:
+The name of the table for which partition information needs to be viewed must
be specified.
-1. Support the filtering of PartitionId, PartitionName, State, Buckets,
ReplicationNum, LastConsistencyCheckTime and other columns
-2. TEMPORARY specifies to list temporary partitions
+## Optional Parameters
+**1. \<TEMPORARY\>**
-when used in Hive Catalog:
-Will return all partitions' name. Support multilevel partition table
+Whether to query the information of temporary partitions.
+**2. \<db_name\>**
+The name of the database for which partition information needs to be viewed
must be specified.
-## Example
+**3. \<WHERE\>**
-1. Display all non-temporary partition information of the specified table
under the specified db
+Filter conditions, supporting filtering on columns such as PartitionId,
PartitionName, State, Buckets, ReplicationNum, LastConsistencyCheckTime, etc.
+**4. \<ORDER BY\>**
+
+Sorting conditions, supporting sorting on columns such as PartitionId,
PartitionName, State, Buckets, ReplicationNum, LastConsistencyCheckTime, etc.
+
+**5. \<LIMIT\>**
+
+The maximum number of rows returned.
+
+## Return Value
+| Columns | DataType | Note
|
+|--------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| PartitionId | bigint | Partition ID
|
+| PartitionName | varchar | Partition Name
|
+| VisibleVersion | int | The maximum VisibleVersion of the
tablets in this partition.
|
+| VisibleVersionTime | datetime | The time of the most recent
VisibleVersion in this partition.
|
+| State | varchar | The State of this partition
|
+| PartitionKey | datetime | The partition key of this partition
|
+| Range | datetime | The Range of this partition
|
+| DistributionKey | varchar | The distribution key of this
partition
|
+| Buckets | int | The bucket num of this partition
|
+| ReplicationNum | int | The replica num of this partition
|
+| StorageMedium | varchar | The storage medium of this partition
|
+| CooldownTime | datetime | The cooldown time of this partition.
If there is no hot-cold separation, the value of this field is [9999-12-31
23:59:59], which means it is always hot data. |
+| RemoteStoragePolicy | varchar | The remote storage policy of this
partition.
|
+| LastConsistencyCheckTime | datetime | The time of the last partition
consistency check for this partition.
|
+| DataSize | int | The data size under this partition.
|
+| IsInMemory | boolean | Whether it is an in-memory partition,
the default is false.
|
+| ReplicaAllocation | varchar | The replica distribution strategy of
this partition.
|
+| IsMutable | boolean | Whether the partition is mutable, the
default is true.
|
+| SyncWithBaseTables | boolean | Whether the partition is synchronized
with the data of the base table.
|
+| UnsyncTables | varchar | Whether the partition is a partition
of an unsynchronized table.
|
+
+
+## Access Control Requirements
+The SHOW permission for the table to be viewed is required.
-```SQL
- SHOW PARTITIONS FROM example_db.table_name;
-```
-2. Display all temporary partition information of the specified table under
the specified db
- ```SQL
- SHOW TEMPORARY PARTITIONS FROM example_db.table_name;
- ```
+## Examples
-3. Display the information of the specified non-temporary partition of the
specified table under the specified db
+1. Show all non-temporary partition information for a specified table in a
specified database.
- ```SQL
- SHOW PARTITIONS FROM example_db.table_name WHERE PartitionName = "p1";
- ```
+```sql
+SHOW PARTITIONS FROM t_agg;
Review Comment:
```suggestion
SHOW PARTITIONS FROM t_agg;
```
##########
docs/sql-manual/sql-statements/table-and-view/table/ALTER-COLOCATE-GROUP.md:
##########
@@ -29,51 +29,53 @@ under the License.
## Description
-This statement is used to modify the colocation group.
+This statement is used to modify the properties of a Colocation Group.
-Syntax:
+## Syntax
```sql
-ALTER COLOCATE GROUP [database.]group
+ALTER COLOCATE GROUP [database.] <group_name>
Review Comment:
```suggestion
ALTER COLOCATE GROUP [<database.>] <group_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
