This is an automated email from the ASF dual-hosted git repository.
kassiez pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 1e8a714ac01 Show frontend disk (#2003)
1e8a714ac01 is described below
commit 1e8a714ac01333d80ec1941ac55898c7dbf77365
Author: zhangdong <493738...@qq.com>
AuthorDate: Fri Feb 21 15:24:36 2025 +0800
Show frontend disk (#2003)
- show partition id
- show frontends disks
- SHOW ALTER TABLE MATERIALIZED VIEW
## Versions
- [x] dev
- [x] 3.0
- [x] 2.1
- [x] 2.0
## Languages
- [x] Chinese
- [x] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---
.../instance-management/SHOW-FRONTENDS-DISKS.md | 70 ++++++++-----
.../table-and-view/table/SHOW-PARTITION-ID.md | 39 +++----
.../instance-management/SHOW-FRONTENDS-DISKS.md | 70 ++++++++-----
.../table-and-view/table/SHOW-PARTITION-ID.md | 26 +++--
.../SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md | 110 +++++++++-----------
.../Show-Statements/SHOW-PARTITION-ID.md | 39 +++----
.../SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md | 110 +++++++++-----------
.../Show-Statements/SHOW-FRONTENDS-DISKS.md | 75 ++++++++------
.../Show-Statements/SHOW-PARTITION-ID.md | 39 +++----
.../instance-management/SHOW-FRONTENDS-DISKS.md | 58 +++++++----
.../table-and-view/table/SHOW-PARTITION-ID.md | 29 ++++--
.../instance-management/SHOW-FRONTENDS-DISKS.md | 72 +++++++------
.../table-and-view/table/SHOW-PARTITION-ID.md | 33 +++---
.../SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md | 113 +++++++++------------
.../Show-Statements/SHOW-PARTITION-ID.md | 41 ++++----
.../SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md | 113 +++++++++------------
.../Show-Statements/SHOW-FRONTENDS-DISKS.md | 76 +++++++-------
.../Show-Statements/SHOW-PARTITION-ID.md | 41 ++++----
.../instance-management/SHOW-FRONTENDS-DISKS.md | 61 ++++++-----
.../table-and-view/table/SHOW-PARTITION-ID.md | 33 +++---
.../instance-management/SHOW-FRONTENDS-DISKS.md | 70 ++++++++-----
.../table-and-view/table/SHOW-PARTITION-ID.md | 41 ++++----
22 files changed, 726 insertions(+), 633 deletions(-)
diff --git
a/docs/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
b/docs/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
index 3dc6ac4f3ce..8c439e64e0a 100644
---
a/docs/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
+++
b/docs/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW FRONTENDS DISKS",
- "language": "en"
+"title": "SHOW FRONTENDS DISKS",
+"language": "en"
}
---
@@ -24,10 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-
## Description
-This statement is used to view FE nodes's important paths' disk information,
such as meta, log, audit-log and temp dir.
+This statement is used to view the disk information of important directories
on the FE node, such as metadata, logs, audit logs, and temporary directories.
## Syntax
@@ -35,22 +34,44 @@ This statement is used to view FE nodes's important paths'
disk information, suc
SHOW FRONTENDS DISKS;
```
-illustrate:
-
-1. Name indicates the name of the FE node in bdbje.
-2. Host indicates the ip of the FE node.
-3. DirType indicates the type of dir type, such as meta, log, audit-log temp
and deploy dir.
-4. Dir indicates the dir path of FE node dir in which type.
-5. FileSystem indicates the dir path in which file system on the linux
operation system.
-6. Capacity indicates total capacity of the filesystem.
-7. Used indicates the size of the filesystem already used.
-8. Available indicates the size of the filesystem remained.
-9. UseRate indicates File system usage capacity ratio.
-10. MountOn indicates the mount dir of the filesystem.
-
-## Example
-`
-mysql> show frontends disks;
+## Return Value
+
+| Column | Note |
+|--------------------|-------------------------------------------------|
+| Name | The name of the FE node in bdbje
|
+| Host | The IP address of the FE node.
|
+| DirType | The types of directories to be displayed include the
following four categories: meta, log, audit-log, temp, and deploy. |
+| Dir | The directories for the types of directories to be
displayed. |
+| FileSystem | The file system in the Linux system where the types of
directories to be displayed are located. |
+| Capacity | The capacity of the file system.
|
+| Used | The used size of the file system.
|
+| Available | The remaining capacity of the file system.
|
+| UseRate | The usage percentage of the file system capacity.
|
+| MountOn | The mount directory of the file system.
|
+
+## Access Control Requirements
+
+The user who executes this SQL must have at least the following permissions:
+
+| Privilege | Object | Notes |
+|-------------------------|----|----|
+| ADMIN_PRIV or NODE_PRIV | | |
+
+## Usage Notes
+
+If further filtering of the query results is required, the table-valued
function
[frontends_disks()](../../../sql-functions/table-valued-functions/frontends_disks.md)
can be used. SHOW BACKENDS is equivalent to the following statement:
+
+```sql
+SELECT * FROM FRONTENDS_DISKS();
+```
+
+## Examples
+
+```sql
+SHOW FRONTENDS DISKS;
+```
+
+```text
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
| Name | Host | DirType | Dir
| Filesystem | Capacity | Used | Available | UseRate |
MountOn |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
@@ -60,11 +81,4 @@ mysql> show frontends disks;
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | temp |
/home/disk/output/fe/temp_dir | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | deploy |
/home/disk/output/fe | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
-5 rows in set (0.00 sec)
-`
-
-## Keywords
-
-SHOW, FRONTENDS
-
-
+```
diff --git
a/docs/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
b/docs/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
index c7e2f1e3698..63029f70d39 100644
--- a/docs/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
+++ b/docs/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
@@ -1,6 +1,6 @@
---
{
- "title": "SHOW-PARTITION-ID",
+ "title": "SHOW PARTITION ID",
"language": "en"
}
---
@@ -24,32 +24,35 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-PARTITION-ID
+## Description
-### Name
+This statement is used to find the corresponding database name, table name,
and partition name based on the partition ID.
-SHOW PARTITION ID
+## Syntax
-### Description
+```sql
+SHOW PARTITION <partition_id>
+```
-This statement is used to find the corresponding database name, table name,
partition name according to the partition id (only for administrators)
+## Required Parameters
- grammar:
+**1. `<partition_id>`**
-```sql
-SHOW PARTITION [partition_id]
-```
-### Example
+> partition id
-1. Find the corresponding database name, table name, partition name according
to the partition id
+## Access Control Requirements
- ```sql
- SHOW PARTITION 10002;
- ```
+The user who executes this SQL must have at least the following permissions:
+
+| Privilege | Object | Notes |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
-### Keywords
+## Examples
- SHOW, PARTITION, ID
+1. To find the corresponding database name, table name, and partition name
based on the partition ID.
-### Best Practice
+ ```sql
+ SHOW PARTITION 10002;
+ ```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
index fcda0d90430..dcb0198b100 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
@@ -1,6 +1,6 @@
---
{
- "title": "SHOW-FRONTENDS-DISKS",
+ "title": "SHOW FRONTENDS DISKS",
"language": "zh-CN"
}
---
@@ -24,32 +24,54 @@ specific language governing permissions and limitations
under the License.
-->
-
## 描述
- 该语句用于查看 FE 节点的重要目录如：元数据、日志、审计日志、临时目录对应的磁盘信息
+该语句用于查看 FE 节点的重要目录如：元数据、日志、审计日志、临时目录对应的磁盘信息
- 语法：
+## 语法
```sql
SHOW FRONTENDS DISKS;
```
-说明：
-1. Name 表示该 FE 节点在 bdbje 中的名称。
-2. Host 表示该 FE 节点的 IP。
-3. DirType 表示要展示的目录类型，分别有四种类型：meta、log、audit-log、temp、deploy。
-4. Dir 表示要展示的目录类型的目录。
-5. FileSystem 表示要展示的目录类型所在的 linux 系统的文件系统。
-6. Capacity 文件系统的容量。
-7. Used 文件系统已用大小。
-8. Available 文件系统剩余容量。
-9. UseRate 文件系统使用容量占比。
-10. MountOn 文件系统挂在目录。
-
-### 示例
-`
-mysql> show frontends disks;
+## 返回值
+
+| 列名 | 说明 |
+|--------------------|-------------------------------------------------|
+| Name | 该 FE 节点在 bdbje 中的名称 |
+| Host | 该 FE 节点的 IP |
+| DirType | 要展示的目录类型，分别有四种类型：meta、log、audit-log、temp、deploy |
+| Dir | 要展示的目录类型的目录 |
+| FileSystem | 要展示的目录类型所在的 linux 系统的文件系统 |
+| Capacity | 文件系统的容量 |
+| Used | 文件系统已用大小 |
+| Available | 文件系统剩余容量 |
+| UseRate | 文件系统使用容量占比 |
+| MountOn | 文件系统挂载目录 |
+
+## 权限控制
+
+执行此 SQL 命令的用户必须至少具有以下权限：
+
+| 权限 | 对象 | 说明 |
+|------------------------|----|----|
+| ADMIN_PRIV 或 NODE_PRIV | | |
+
+## 注意事项
+
+如果需要对查询结果进行进一步的过滤，可以使用表值函数[frontends_disks()](../../../sql-functions/table-valued-functions/frontends_disks.md)。`SHOW
FRONTENDS DISKS` 与下面语句等价：
+
+```sql
+SELECT * FROM FRONTENDS_DISKS();
+```
+
+## 示例
+
+```sql
+SHOW FRONTENDS DISKS;
+```
+
+```text
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
| Name | Host | DirType | Dir
| Filesystem | Capacity | Used | Available | UseRate |
MountOn |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
@@ -59,12 +81,4 @@ mysql> show frontends disks;
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | temp |
/home/disk/output/fe/temp_dir | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | deploy |
/home/disk/output/fe | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
-5 rows in set (0.00 sec)
-`
-
-### 关键词
-
- SHOW, FRONTENDS
-
-### Best Practice
-
+```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
index a029d180f1e..7fda8f2e27f 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
@@ -24,17 +24,30 @@ specific language governing permissions and limitations
under the License.
-->
-
## 描述
-该语句用于根据 partition id 查找对应的 database name, table name, partition name（仅管理员使用）
+该语句用于根据 partition id 查找对应的 database name, table name, partition name
-语法：
+## 语法
```sql
- SHOW PARTITION [partition_id]
+SHOW PARTITION <partition_id>
```
+## 必选参数
+
+**1. `<partition_id>`**
+
+> 分区 id
+
+## 权限控制
+
+执行此 SQL 命令的用户必须至少具有以下权限：
+
+| 权限 | 对象 | 说明 |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
+
## 示例
1. 根据 partition id 查找对应的 database name, table name, partition name
@@ -42,10 +55,7 @@ under the License.
```sql
SHOW PARTITION 10002;
```
-
-## 关键词
-
- SHOW, PARTITION, ID
+
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
index 5ceda114bfc..5049cfe26d9 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW ALTER TABLE MATERIALIZED VIEW",
- "language": "zh-CN"
+"title": "SHOW ALTER TABLE MATERIALIZED VIEW",
+"language": "zh-CN"
}
---
@@ -24,97 +24,83 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW ALTER TABLE MATERIALIZED VIEW
-
-### Name
-
-SHOW ALTER TABLE MATERIALIZED VIEW
-
## 描述
-该命令用于查看通过
[CREATE-MATERIALIZED-VIEW](../../sql-reference/Data-Definition-Statements/Create/CREATE-MATERIALIZED-VIEW.md)
语句提交的创建物化视图作业的执行情况。
+该命令用于查看通过
[CREATE-MATERIALIZED-VIEW](../../../sql-statements/table-and-view/materialized-view/CREATE-MATERIALIZED-VIEW.md)
语句提交的创建物化视图作业的执行情况。
> 该语句等同于 `SHOW ALTER TABLE ROLLUP`;
+## 语法
+
```sql
SHOW ALTER TABLE MATERIALIZED VIEW
-[FROM database]
-[WHERE]
-[ORDER BY]
-[LIMIT OFFSET]
+[FROM <database>]
+[<where_clause>]
+[ORDER BY <order_by_key> [, ...]]
+[LIMIT <limit_rows> [ OFFSET <offset_rows>]]
```
-- database：查看指定数据库下的作业。如不指定，使用当前数据库。
-- WHERE：可以对结果列进行筛选，目前仅支持对以下列进行筛选：
- - TableName：仅支持等值筛选。
- - State：仅支持等值筛选。
- - Createtime/FinishTime：支持 =，>=，<=，>，<，!=
-- ORDER BY：可以对结果集按任意列进行排序。
-- LIMIT：配合 ORDER BY 进行翻页查询。
+## 可选参数
-返回结果说明：
+**1. `FROM <database>`**
-```sql
-mysql> show alter table materialized view\G
-*************************** 1. row ***************************
- JobId: 11001
- TableName: tbl1
- CreateTime: 2020-12-23 10:41:00
- FinishTime: NULL
- BaseIndexName: tbl1
-RollupIndexName: r1
- RollupId: 11002
- TransactionId: 5070
- State: WAITING_TXN
- Msg:
- Progress: NULL
- Timeout: 86400
-1 row in set (0.00 sec)
-```
+> 查看指定数据库下的作业。如不指定，使用当前数据库。
-- `JobId`：作业唯一ID。
+**2. `<where_clause>`**
-- `TableName`：基表名称
+> 可以对结果列进行筛选，目前仅支持对以下列进行筛选：
+- TableName：仅支持等值筛选。
+- State：仅支持等值筛选。
+- Createtime/FinishTime：支持 =，>=，<=，>，<，!=
-- `CreateTime/FinishTime`：作业创建时间和结束时间。
+**3. `ORDER BY`**
-- `BaseIndexName/RollupIndexName`：基表名称和物化视图名称。
+> 可以对结果集按任意列进行排序。
-- `RollupId`：物化视图的唯一 ID。
+**4. `LIMIT <limit_rows> [ OFFSET <offset_rows>]`**
-- `TransactionId`：见 State 字段说明。
+> 翻页查询。
-- `State`：作业状态。
+## 返回值
- - PENDING：作业准备中。
+| 列名 | 说明 |
+|--------------------|--------------|
+| JobId | 作业唯一 ID |
+| TableName | 基表名称 |
+| CreateTime | 作业创建时间 |
+| FinishTime | 作业结束时间 |
+| BaseIndexName | 基表名称 |
+| RollupIndexName | 物化视图名称 |
+| RollupId | 物化视图的唯一 ID |
+| TransactionId | 见 State 字段说明 |
+| State | 作业状态。 |
+| Msg | 错误信息 |
+| Progress | 作业进度。这里的进度表示 `已完成的tablet数量/总tablet数量`。创建物化视图是按 tablet
粒度进行的 |
+| Timeout | 作业超时时间，单位秒 |
- - WAITING_TXN：
+State 说明：
+- PENDING：作业准备中。
- 在正式开始产生物化视图数据前，会等待当前这个表上的正在运行的导入事务完成。而 `TransactionId`
字段就是当前正在等待的事务ID。当这个ID之前的导入都完成后，就会实际开始作业。
+- WAITING_TXN： 在正式开始产生物化视图数据前，会等待当前这个表上的正在运行的导入事务完成。而 `TransactionId`
字段就是当前正在等待的事务 ID。当这个 ID 之前的导入都完成后，就会实际开始作业。
- - RUNNING：作业运行中。
+- RUNNING：作业运行中。
- - FINISHED：作业运行成功。
+- FINISHED：作业运行成功。
- - CANCELLED：作业运行失败。
+- CANCELLED：作业运行失败。
-- `Msg`：错误信息
+## 权限控制
-- `Progress`：作业进度。这里的进度表示 `已完成的tablet数量/总tablet数量`。创建物化视图是按 tablet 粒度进行的。
+执行此 SQL 命令的用户必须至少具有以下权限：
-- `Timeout`：作业超时时间，单位秒。
+| 权限 | 对象 | 说明 |
+|------------|-------|----|
+| ALTER_PRIV | table | |
-## 举例
+## 示例
1. 查看数据库 example_db 下的物化视图作业
```sql
SHOW ALTER TABLE MATERIALIZED VIEW FROM example_db;
```
-
-### Keywords
-
- SHOW, ALTER, TABLE, MATERIALIZED, VIEW
-
-### Best Practice
-
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
index 9032905f808..47a8a743748 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-PARTITION-ID",
- "language": "zh-CN"
+"title": "SHOW PARTITION ID",
+"language": "zh-CN"
}
---
@@ -24,33 +24,34 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-PARTITION-ID
-
-### Name
-
-SHOW PARTITION ID
-
## 描述
-该语句用于根据 partition id 查找对应的 database name, table name, partition name（仅管理员使用）
+该语句用于根据 partition id 查找对应的 database name, table name, partition name
-语法：
+## 语法
```sql
- SHOW PARTITION [partition_id]
+SHOW PARTITION <partition_id>
```
-## 举例
+## 必选参数
-1. 根据 partition id 查找对应的 database name, table name, partition name
+**1. `<partition_id>`**
- ```sql
- SHOW PARTITION 10002;
- ```
+> 分区 id
-### Keywords
+## 权限控制
- SHOW, PARTITION, ID
+执行此 SQL 命令的用户必须至少具有以下权限：
-### Best Practice
+| 权限 | 对象 | 说明 |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
+## 示例
+
+1. 根据 partition id 查找对应的 database name, table name, partition name
+
+ ```sql
+ SHOW PARTITION 10002;
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
index 5ceda114bfc..5049cfe26d9 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW ALTER TABLE MATERIALIZED VIEW",
- "language": "zh-CN"
+"title": "SHOW ALTER TABLE MATERIALIZED VIEW",
+"language": "zh-CN"
}
---
@@ -24,97 +24,83 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW ALTER TABLE MATERIALIZED VIEW
-
-### Name
-
-SHOW ALTER TABLE MATERIALIZED VIEW
-
## 描述
-该命令用于查看通过
[CREATE-MATERIALIZED-VIEW](../../sql-reference/Data-Definition-Statements/Create/CREATE-MATERIALIZED-VIEW.md)
语句提交的创建物化视图作业的执行情况。
+该命令用于查看通过
[CREATE-MATERIALIZED-VIEW](../../../sql-statements/table-and-view/materialized-view/CREATE-MATERIALIZED-VIEW.md)
语句提交的创建物化视图作业的执行情况。
> 该语句等同于 `SHOW ALTER TABLE ROLLUP`;
+## 语法
+
```sql
SHOW ALTER TABLE MATERIALIZED VIEW
-[FROM database]
-[WHERE]
-[ORDER BY]
-[LIMIT OFFSET]
+[FROM <database>]
+[<where_clause>]
+[ORDER BY <order_by_key> [, ...]]
+[LIMIT <limit_rows> [ OFFSET <offset_rows>]]
```
-- database：查看指定数据库下的作业。如不指定，使用当前数据库。
-- WHERE：可以对结果列进行筛选，目前仅支持对以下列进行筛选：
- - TableName：仅支持等值筛选。
- - State：仅支持等值筛选。
- - Createtime/FinishTime：支持 =，>=，<=，>，<，!=
-- ORDER BY：可以对结果集按任意列进行排序。
-- LIMIT：配合 ORDER BY 进行翻页查询。
+## 可选参数
-返回结果说明：
+**1. `FROM <database>`**
-```sql
-mysql> show alter table materialized view\G
-*************************** 1. row ***************************
- JobId: 11001
- TableName: tbl1
- CreateTime: 2020-12-23 10:41:00
- FinishTime: NULL
- BaseIndexName: tbl1
-RollupIndexName: r1
- RollupId: 11002
- TransactionId: 5070
- State: WAITING_TXN
- Msg:
- Progress: NULL
- Timeout: 86400
-1 row in set (0.00 sec)
-```
+> 查看指定数据库下的作业。如不指定，使用当前数据库。
-- `JobId`：作业唯一ID。
+**2. `<where_clause>`**
-- `TableName`：基表名称
+> 可以对结果列进行筛选，目前仅支持对以下列进行筛选：
+- TableName：仅支持等值筛选。
+- State：仅支持等值筛选。
+- Createtime/FinishTime：支持 =，>=，<=，>，<，!=
-- `CreateTime/FinishTime`：作业创建时间和结束时间。
+**3. `ORDER BY`**
-- `BaseIndexName/RollupIndexName`：基表名称和物化视图名称。
+> 可以对结果集按任意列进行排序。
-- `RollupId`：物化视图的唯一 ID。
+**4. `LIMIT <limit_rows> [ OFFSET <offset_rows>]`**
-- `TransactionId`：见 State 字段说明。
+> 翻页查询。
-- `State`：作业状态。
+## 返回值
- - PENDING：作业准备中。
+| 列名 | 说明 |
+|--------------------|--------------|
+| JobId | 作业唯一 ID |
+| TableName | 基表名称 |
+| CreateTime | 作业创建时间 |
+| FinishTime | 作业结束时间 |
+| BaseIndexName | 基表名称 |
+| RollupIndexName | 物化视图名称 |
+| RollupId | 物化视图的唯一 ID |
+| TransactionId | 见 State 字段说明 |
+| State | 作业状态。 |
+| Msg | 错误信息 |
+| Progress | 作业进度。这里的进度表示 `已完成的tablet数量/总tablet数量`。创建物化视图是按 tablet
粒度进行的 |
+| Timeout | 作业超时时间，单位秒 |
- - WAITING_TXN：
+State 说明：
+- PENDING：作业准备中。
- 在正式开始产生物化视图数据前，会等待当前这个表上的正在运行的导入事务完成。而 `TransactionId`
字段就是当前正在等待的事务ID。当这个ID之前的导入都完成后，就会实际开始作业。
+- WAITING_TXN： 在正式开始产生物化视图数据前，会等待当前这个表上的正在运行的导入事务完成。而 `TransactionId`
字段就是当前正在等待的事务 ID。当这个 ID 之前的导入都完成后，就会实际开始作业。
- - RUNNING：作业运行中。
+- RUNNING：作业运行中。
- - FINISHED：作业运行成功。
+- FINISHED：作业运行成功。
- - CANCELLED：作业运行失败。
+- CANCELLED：作业运行失败。
-- `Msg`：错误信息
+## 权限控制
-- `Progress`：作业进度。这里的进度表示 `已完成的tablet数量/总tablet数量`。创建物化视图是按 tablet 粒度进行的。
+执行此 SQL 命令的用户必须至少具有以下权限：
-- `Timeout`：作业超时时间，单位秒。
+| 权限 | 对象 | 说明 |
+|------------|-------|----|
+| ALTER_PRIV | table | |
-## 举例
+## 示例
1. 查看数据库 example_db 下的物化视图作业
```sql
SHOW ALTER TABLE MATERIALIZED VIEW FROM example_db;
```
-
-### Keywords
-
- SHOW, ALTER, TABLE, MATERIALIZED, VIEW
-
-### Best Practice
-
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-FRONTENDS-DISKS.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-FRONTENDS-DISKS.md
index ef3cd773f9a..4ca60abed91 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-FRONTENDS-DISKS.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-FRONTENDS-DISKS.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-FRONTENDS-DISKS",
- "language": "zh-CN"
+"title": "SHOW FRONTENDS DISKS",
+"language": "zh-CN"
}
---
@@ -24,37 +24,54 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-FRONTENDS-DISKS
+## 描述
-### Name
+该语句用于查看 FE 节点的重要目录如：元数据、日志、审计日志、临时目录对应的磁盘信息
-SHOW FRONTENDS DISKS
+## 语法
-## 描述
+```sql
+SHOW FRONTENDS DISKS;
+```
+
+## 返回值
+
+| 列名 | 说明 |
+|--------------------|-------------------------------------------------|
+| Name | 该 FE 节点在 bdbje 中的名称 |
+| Host | 该 FE 节点的 IP |
+| DirType | 要展示的目录类型，分别有四种类型：meta、log、audit-log、temp、deploy |
+| Dir | 要展示的目录类型的目录 |
+| FileSystem | 要展示的目录类型所在的 linux 系统的文件系统 |
+| Capacity | 文件系统的容量 |
+| Used | 文件系统已用大小 |
+| Available | 文件系统剩余容量 |
+| UseRate | 文件系统使用容量占比 |
+| MountOn | 文件系统挂载目录 |
+
+## 权限控制
+
+执行此 SQL 命令的用户必须至少具有以下权限：
+
+| 权限 | 对象 | 说明 |
+|------------------------|----|----|
+| ADMIN_PRIV 或 NODE_PRIV | | |
- 该语句用于查看 FE 节点的重要目录如：元数据、日志、审计日志、临时目录对应的磁盘信息
+## 注意事项
- 语法：
+如果需要对查询结果进行进一步的过滤，可以使用表值函数[frontends_disks()](../../../sql-functions/table-valued-functions/frontends_disks.md)。`SHOW
FRONTENDS DISKS` 与下面语句等价：
```sql
-SHOW FRONTENDS DISKS;
+SELECT * FROM FRONTENDS_DISKS();
+```
+
+## 示例
+
+```sql
+SHOW FRONTENDS DISKS;
```
-说明：
-1. Name 表示该 FE 节点在 bdbje 中的名称。
-2. Host 表示该 FE 节点的IP。
-3. DirType 表示要展示的目录类型，分别有四种类型：meta、log、audit-log、temp、deploy。
-4. Dir 表示要展示的目录类型的目录。
-5. FileSystem 表示要展示的目录类型所在的linux系统的文件系统。
-6. Capacity 文件系统的容量。
-7. Used 文件系统已用大小。
-8. Available 文件系统剩余容量。
-9. UseRate 文件系统使用容量占比。
-10. MountOn 文件系统挂在目录。
-
-## 举例
-`
-mysql> show frontends disks;
+```text
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
| Name | Host | DirType | Dir
| Filesystem | Capacity | Used | Available | UseRate |
MountOn |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
@@ -64,12 +81,4 @@ mysql> show frontends disks;
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | temp |
/home/disk/output/fe/temp_dir | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | deploy |
/home/disk/output/fe | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
-5 rows in set (0.00 sec)
-`
-
-### Keywords
-
- SHOW, FRONTENDS
-
-### Best Practice
-
+```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
index 9032905f808..47a8a743748 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-PARTITION-ID",
- "language": "zh-CN"
+"title": "SHOW PARTITION ID",
+"language": "zh-CN"
}
---
@@ -24,33 +24,34 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-PARTITION-ID
-
-### Name
-
-SHOW PARTITION ID
-
## 描述
-该语句用于根据 partition id 查找对应的 database name, table name, partition name（仅管理员使用）
+该语句用于根据 partition id 查找对应的 database name, table name, partition name
-语法：
+## 语法
```sql
- SHOW PARTITION [partition_id]
+SHOW PARTITION <partition_id>
```
-## 举例
+## 必选参数
-1. 根据 partition id 查找对应的 database name, table name, partition name
+**1. `<partition_id>`**
- ```sql
- SHOW PARTITION 10002;
- ```
+> 分区 id
-### Keywords
+## 权限控制
- SHOW, PARTITION, ID
+执行此 SQL 命令的用户必须至少具有以下权限：
-### Best Practice
+| 权限 | 对象 | 说明 |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
+## 示例
+
+1. 根据 partition id 查找对应的 database name, table name, partition name
+
+ ```sql
+ SHOW PARTITION 10002;
+ ```
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
index adef90e6dc2..4ca60abed91 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW FRONTENDS DISKS",
- "language": "zh-CN"
+"title": "SHOW FRONTENDS DISKS",
+"language": "zh-CN"
}
---
@@ -24,7 +24,6 @@ specific language governing permissions and limitations
under the License.
-->
-
## 描述
该语句用于查看 FE 节点的重要目录如：元数据、日志、审计日志、临时目录对应的磁盘信息
@@ -35,22 +34,44 @@ under the License.
SHOW FRONTENDS DISKS;
```
-说明：
-1. Name 表示该 FE 节点在 bdbje 中的名称。
-2. Host 表示该 FE 节点的 IP。
-3. DirType 表示要展示的目录类型，分别有四种类型：meta、log、audit-log、temp、deploy。
-4. Dir 表示要展示的目录类型的目录。
-5. FileSystem 表示要展示的目录类型所在的 linux 系统的文件系统。
-6. Capacity 文件系统的容量。
-7. Used 文件系统已用大小。
-8. Available 文件系统剩余容量。
-9. UseRate 文件系统使用容量占比。
-10. MountOn 文件系统挂在目录。
+## 返回值
+
+| 列名 | 说明 |
+|--------------------|-------------------------------------------------|
+| Name | 该 FE 节点在 bdbje 中的名称 |
+| Host | 该 FE 节点的 IP |
+| DirType | 要展示的目录类型，分别有四种类型：meta、log、audit-log、temp、deploy |
+| Dir | 要展示的目录类型的目录 |
+| FileSystem | 要展示的目录类型所在的 linux 系统的文件系统 |
+| Capacity | 文件系统的容量 |
+| Used | 文件系统已用大小 |
+| Available | 文件系统剩余容量 |
+| UseRate | 文件系统使用容量占比 |
+| MountOn | 文件系统挂载目录 |
+
+## 权限控制
+
+执行此 SQL 命令的用户必须至少具有以下权限：
+
+| 权限 | 对象 | 说明 |
+|------------------------|----|----|
+| ADMIN_PRIV 或 NODE_PRIV | | |
+
+## 注意事项
+
+如果需要对查询结果进行进一步的过滤，可以使用表值函数[frontends_disks()](../../../sql-functions/table-valued-functions/frontends_disks.md)。`SHOW
FRONTENDS DISKS` 与下面语句等价：
+
+```sql
+SELECT * FROM FRONTENDS_DISKS();
+```
## 示例
```sql
-mysql> show frontends disks;
+SHOW FRONTENDS DISKS;
+```
+
+```text
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
| Name | Host | DirType | Dir
| Filesystem | Capacity | Used | Available | UseRate |
MountOn |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
@@ -60,11 +81,4 @@ mysql> show frontends disks;
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | temp |
/home/disk/output/fe/temp_dir | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | deploy |
/home/disk/output/fe | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
-5 rows in set (0.00 sec)
```
-
-## Keywords
-
-SHOW, FRONTENDS
-
-
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
index ae6ac69fae9..335f71c1494 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-PARTITION-ID",
- "language": "zh-CN"
+"title": "SHOW PARTITION ID",
+"language": "zh-CN"
}
---
@@ -24,17 +24,30 @@ specific language governing permissions and limitations
under the License.
-->
-
## 描述
-该语句用于根据 partition id 查找对应的 database name, table name, partition name（仅管理员使用）
+该语句用于根据 partition id 查找对应的 database name, table name, partition name
## 语法
```sql
-SHOW PARTITION [partition_id]
+SHOW PARTITION <partition_id>
```
+## 必选参数
+
+**1. `<partition_id>`**
+
+> 分区 id
+
+## 权限控制
+
+执行此 SQL 命令的用户必须至少具有以下权限：
+
+| 权限 | 对象 | 说明 |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
+
## 示例
1. 根据 partition id 查找对应的 database name, table name, partition name
@@ -42,8 +55,4 @@ SHOW PARTITION [partition_id]
```sql
SHOW PARTITION 10002;
```
-
-## 关键词
-
-SHOW, PARTITION, ID
-
+
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
index fcda0d90430..4ca60abed91 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-FRONTENDS-DISKS",
- "language": "zh-CN"
+"title": "SHOW FRONTENDS DISKS",
+"language": "zh-CN"
}
---
@@ -24,32 +24,54 @@ specific language governing permissions and limitations
under the License.
-->
-
## 描述
- 该语句用于查看 FE 节点的重要目录如：元数据、日志、审计日志、临时目录对应的磁盘信息
+该语句用于查看 FE 节点的重要目录如：元数据、日志、审计日志、临时目录对应的磁盘信息
- 语法：
+## 语法
```sql
SHOW FRONTENDS DISKS;
```
-说明：
-1. Name 表示该 FE 节点在 bdbje 中的名称。
-2. Host 表示该 FE 节点的 IP。
-3. DirType 表示要展示的目录类型，分别有四种类型：meta、log、audit-log、temp、deploy。
-4. Dir 表示要展示的目录类型的目录。
-5. FileSystem 表示要展示的目录类型所在的 linux 系统的文件系统。
-6. Capacity 文件系统的容量。
-7. Used 文件系统已用大小。
-8. Available 文件系统剩余容量。
-9. UseRate 文件系统使用容量占比。
-10. MountOn 文件系统挂在目录。
-
-### 示例
-`
-mysql> show frontends disks;
+## 返回值
+
+| 列名 | 说明 |
+|--------------------|-------------------------------------------------|
+| Name | 该 FE 节点在 bdbje 中的名称 |
+| Host | 该 FE 节点的 IP |
+| DirType | 要展示的目录类型，分别有四种类型：meta、log、audit-log、temp、deploy |
+| Dir | 要展示的目录类型的目录 |
+| FileSystem | 要展示的目录类型所在的 linux 系统的文件系统 |
+| Capacity | 文件系统的容量 |
+| Used | 文件系统已用大小 |
+| Available | 文件系统剩余容量 |
+| UseRate | 文件系统使用容量占比 |
+| MountOn | 文件系统挂载目录 |
+
+## 权限控制
+
+执行此 SQL 命令的用户必须至少具有以下权限：
+
+| 权限 | 对象 | 说明 |
+|------------------------|----|----|
+| ADMIN_PRIV 或 NODE_PRIV | | |
+
+## 注意事项
+
+如果需要对查询结果进行进一步的过滤，可以使用表值函数[frontends_disks()](../../../sql-functions/table-valued-functions/frontends_disks.md)。`SHOW
FRONTENDS DISKS` 与下面语句等价：
+
+```sql
+SELECT * FROM FRONTENDS_DISKS();
+```
+
+## 示例
+
+```sql
+SHOW FRONTENDS DISKS;
+```
+
+```text
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
| Name | Host | DirType | Dir
| Filesystem | Capacity | Used | Available | UseRate |
MountOn |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
@@ -59,12 +81,4 @@ mysql> show frontends disks;
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | temp |
/home/disk/output/fe/temp_dir | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | deploy |
/home/disk/output/fe | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
-5 rows in set (0.00 sec)
-`
-
-### 关键词
-
- SHOW, FRONTENDS
-
-### Best Practice
-
+```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
index a029d180f1e..335f71c1494 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW PARTITION ID",
- "language": "zh-CN"
+"title": "SHOW PARTITION ID",
+"language": "zh-CN"
}
---
@@ -24,28 +24,35 @@ specific language governing permissions and limitations
under the License.
-->
-
## 描述
-该语句用于根据 partition id 查找对应的 database name, table name, partition name（仅管理员使用）
+该语句用于根据 partition id 查找对应的 database name, table name, partition name
-语法：
+## 语法
```sql
- SHOW PARTITION [partition_id]
+SHOW PARTITION <partition_id>
```
-## 示例
+## 必选参数
-1. 根据 partition id 查找对应的 database name, table name, partition name
+**1. `<partition_id>`**
- ```sql
- SHOW PARTITION 10002;
- ```
+> 分区 id
-## 关键词
+## 权限控制
- SHOW, PARTITION, ID
+执行此 SQL 命令的用户必须至少具有以下权限：
+| 权限 | 对象 | 说明 |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
+## 示例
+
+1. 根据 partition id 查找对应的 database name, table name, partition name
+ ```sql
+ SHOW PARTITION 10002;
+ ```
+
\ No newline at end of file
diff --git
a/versioned_docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
b/versioned_docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
index ac8ecd3cf05..a6a8a64ea2c 100644
---
a/versioned_docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
+++
b/versioned_docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW ALTER TABLE MATERIALIZED VIEW",
- "language": "en"
+"title": "SHOW ALTER TABLE MATERIALIZED VIEW",
+"language": "en"
}
---
@@ -24,97 +24,84 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW ALTER TABLE MATERIALIZED VIEW
+## Description
-### Name
-
-SHOW ALTER TABLE MATERIALIZED VIEW
-
-### Description
-
-This command is used to view the execution of the Create Materialized View job
submitted through the
[CREATE-MATERIALIZED-VIEW](../../sql-reference/Data-Definition-Statements/Create/CREATE-MATERIALIZED-VIEW.md)
statement.
+This command is used to check the execution status of the materialized view
creation job submitted via statement
[CREATE-MATERIALIZED-VIEW](../../../sql-statements/table-and-view/materialized-view/CREATE-MATERIALIZED-VIEW.md)
> This statement is equivalent to `SHOW ALTER TABLE ROLLUP`;
+## Syntax
+
```sql
SHOW ALTER TABLE MATERIALIZED VIEW
-[FROM database]
-[WHERE]
-[ORDER BY]
-[LIMIT OFFSET]
+[FROM <database>]
+[<where_clause>]
+[ORDER BY <order_by_key> [, ...]]
+[LIMIT <limit_rows> [ OFFSET <offset_rows>]]
```
-- database: View jobs under the specified database. If not specified, the
current database is used.
-- WHERE: You can filter the result column, currently only the following
columns are supported:
- - TableName: Only equal value filtering is supported.
- - State: Only supports equivalent filtering.
- - Createtime/FinishTime: Support =, >=, <=, >, <, !=
-- ORDER BY: The result set can be sorted by any column.
-- LIMIT: Use ORDER BY to perform page-turning query.
+## Optional Parameters
-Return result description:
+**1. `FROM <database>`**
-```sql
-mysql> show alter table materialized view\G
-**************************** 1. row ******************** ******
- JobId: 11001
- TableName: tbl1
- CreateTime: 2020-12-23 10:41:00
- FinishTime: NULL
- BaseIndexName: tbl1
-RollupIndexName: r1
- RollupId: 11002
- TransactionId: 5070
- State: WAITING_TXN
- Msg:
- Progress: NULL
- Timeout: 86400
-1 row in set (0.00 sec)
-```
+> View jobs under the specified database. If not specified, the current
database will be used.
-- `JobId`: Job unique ID.
+**2. `<where_clause>`**
-- `TableName`: base table name
+> You can filter the result columns, and currently, only the following columns
are supported for filtering:
+- TableName: Only supports equality filtering.
+- State: Only supports equality filtering.
+- Createtime/FinishTime: Supports =, >=, <=, >, <, !=.
-- `CreateTime/FinishTime`: Job creation time and end time.
+**3. `ORDER BY`**
-- `BaseIndexName/RollupIndexName`: Base table name and materialized view name.
+> You can sort the result set by any column.
-- `RollupId`: The unique ID of the materialized view.
+**4. `LIMIT <limit_rows> [ OFFSET <offset_rows>]`**
-- `TransactionId`: See the description of the State field.
+> For pagination queries.
-- `State`: job status.
+## Return Value
- - PENDING: The job is in preparation.
+| Column | Note
|
+|--------------------|-------------------------------------------------------------|
+| JobId | Job unique ID.
|
+| TableName | Base table name.
|
+| CreateTime | Job creation time.
|
+| FinishTime | Job finish time.
|
+| BaseIndexName | Base table name.
|
+| RollupIndexName | Materialized view name.
|
+| RollupId | The unique ID of the materialized view. |
+| TransactionId | See the description of the State field
|
+| State | Job status.
|
+| Msg | Error msg |
+| Progress | Progress of the assignment. Here, progress refers to the
"number of completed tablets / total number of tablets". The creation of
materialized views is performed on a tablet granularity basis. |
+| Timeout | Job timeout duration, measured in seconds.
|
- - WAITING_TXN:
+State Description:
+- PENDING: The job is in preparation.
- Before officially starting to generate materialized view data, it will
wait for the current running import transaction on this table to complete. And
the `TransactionId` field is the current waiting transaction ID. When all
previous imports for this ID are complete, the job will actually start.
+- WAITING_TXN: Before officially starting to generate materialized view data,
the system will wait for the ongoing import transactions on the current table
to complete. The TransactionId field indicates the ID of the transaction
currently being waited for. The job will actually start once all imports with
transaction IDs prior to this one have been completed.
- - RUNNING: The job is running.
+- RUNNING: The job is currently in progress.
- - FINISHED: The job ran successfully.
+- FINISHED: The job has been successfully completed.
- - CANCELLED: The job failed to run.
+- CANCELLED: The job failed to run.
-- `Msg`: error message
+## Access Control Requirements
-- `Progress`: job progress. The progress here means `completed tablets/total
tablets`. Materialized views are created at tablet granularity.
+The user who executes this SQL must have at least the following permissions:
-- `Timeout`: Job timeout, in seconds.
+| Privilege | Object | Notes |
+|------------|--------|----|
+| ALTER_PRIV | table | |
-### Example
+## Examples
-1. View the materialized view jobs under the database example_db
+1. View materialized view jobs under the database example_db.
```sql
SHOW ALTER TABLE MATERIALIZED VIEW FROM example_db;
```
-### Keywords
-
- SHOW, ALTER, TABLE, MATERIALIZED, VIEW
-
-### Best Practice
-
diff --git
a/versioned_docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
b/versioned_docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
index c7e2f1e3698..e81867e1a8a 100644
---
a/versioned_docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
+++
b/versioned_docs/version-1.2/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-PARTITION-ID",
- "language": "en"
+"title": "SHOW PARTITION ID",
+"language": "en"
}
---
@@ -24,32 +24,35 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-PARTITION-ID
+## Description
-### Name
+This statement is used to find the corresponding database name, table name,
and partition name based on the partition ID.
-SHOW PARTITION ID
+## Syntax
-### Description
+```sql
+SHOW PARTITION <partition_id>
+```
-This statement is used to find the corresponding database name, table name,
partition name according to the partition id (only for administrators)
+## Required Parameters
- grammar:
+**1. `<partition_id>`**
-```sql
-SHOW PARTITION [partition_id]
-```
-### Example
+> partition id
-1. Find the corresponding database name, table name, partition name according
to the partition id
+## Access Control Requirements
- ```sql
- SHOW PARTITION 10002;
- ```
+The user who executes this SQL must have at least the following permissions:
+
+| Privilege | Object | Notes |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
-### Keywords
+## Examples
- SHOW, PARTITION, ID
+1. To find the corresponding database name, table name, and partition name
based on the partition ID.
-### Best Practice
+ ```sql
+ SHOW PARTITION 10002;
+ ```
diff --git
a/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
b/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
index ac8ecd3cf05..a6a8a64ea2c 100644
---
a/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
+++
b/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-ALTER-TABLE-MATERIALIZED-VIEW.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW ALTER TABLE MATERIALIZED VIEW",
- "language": "en"
+"title": "SHOW ALTER TABLE MATERIALIZED VIEW",
+"language": "en"
}
---
@@ -24,97 +24,84 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW ALTER TABLE MATERIALIZED VIEW
+## Description
-### Name
-
-SHOW ALTER TABLE MATERIALIZED VIEW
-
-### Description
-
-This command is used to view the execution of the Create Materialized View job
submitted through the
[CREATE-MATERIALIZED-VIEW](../../sql-reference/Data-Definition-Statements/Create/CREATE-MATERIALIZED-VIEW.md)
statement.
+This command is used to check the execution status of the materialized view
creation job submitted via statement
[CREATE-MATERIALIZED-VIEW](../../../sql-statements/table-and-view/materialized-view/CREATE-MATERIALIZED-VIEW.md)
> This statement is equivalent to `SHOW ALTER TABLE ROLLUP`;
+## Syntax
+
```sql
SHOW ALTER TABLE MATERIALIZED VIEW
-[FROM database]
-[WHERE]
-[ORDER BY]
-[LIMIT OFFSET]
+[FROM <database>]
+[<where_clause>]
+[ORDER BY <order_by_key> [, ...]]
+[LIMIT <limit_rows> [ OFFSET <offset_rows>]]
```
-- database: View jobs under the specified database. If not specified, the
current database is used.
-- WHERE: You can filter the result column, currently only the following
columns are supported:
- - TableName: Only equal value filtering is supported.
- - State: Only supports equivalent filtering.
- - Createtime/FinishTime: Support =, >=, <=, >, <, !=
-- ORDER BY: The result set can be sorted by any column.
-- LIMIT: Use ORDER BY to perform page-turning query.
+## Optional Parameters
-Return result description:
+**1. `FROM <database>`**
-```sql
-mysql> show alter table materialized view\G
-**************************** 1. row ******************** ******
- JobId: 11001
- TableName: tbl1
- CreateTime: 2020-12-23 10:41:00
- FinishTime: NULL
- BaseIndexName: tbl1
-RollupIndexName: r1
- RollupId: 11002
- TransactionId: 5070
- State: WAITING_TXN
- Msg:
- Progress: NULL
- Timeout: 86400
-1 row in set (0.00 sec)
-```
+> View jobs under the specified database. If not specified, the current
database will be used.
-- `JobId`: Job unique ID.
+**2. `<where_clause>`**
-- `TableName`: base table name
+> You can filter the result columns, and currently, only the following columns
are supported for filtering:
+- TableName: Only supports equality filtering.
+- State: Only supports equality filtering.
+- Createtime/FinishTime: Supports =, >=, <=, >, <, !=.
-- `CreateTime/FinishTime`: Job creation time and end time.
+**3. `ORDER BY`**
-- `BaseIndexName/RollupIndexName`: Base table name and materialized view name.
+> You can sort the result set by any column.
-- `RollupId`: The unique ID of the materialized view.
+**4. `LIMIT <limit_rows> [ OFFSET <offset_rows>]`**
-- `TransactionId`: See the description of the State field.
+> For pagination queries.
-- `State`: job status.
+## Return Value
- - PENDING: The job is in preparation.
+| Column | Note
|
+|--------------------|-------------------------------------------------------------|
+| JobId | Job unique ID.
|
+| TableName | Base table name.
|
+| CreateTime | Job creation time.
|
+| FinishTime | Job finish time.
|
+| BaseIndexName | Base table name.
|
+| RollupIndexName | Materialized view name.
|
+| RollupId | The unique ID of the materialized view. |
+| TransactionId | See the description of the State field
|
+| State | Job status.
|
+| Msg | Error msg |
+| Progress | Progress of the assignment. Here, progress refers to the
"number of completed tablets / total number of tablets". The creation of
materialized views is performed on a tablet granularity basis. |
+| Timeout | Job timeout duration, measured in seconds.
|
- - WAITING_TXN:
+State Description:
+- PENDING: The job is in preparation.
- Before officially starting to generate materialized view data, it will
wait for the current running import transaction on this table to complete. And
the `TransactionId` field is the current waiting transaction ID. When all
previous imports for this ID are complete, the job will actually start.
+- WAITING_TXN: Before officially starting to generate materialized view data,
the system will wait for the ongoing import transactions on the current table
to complete. The TransactionId field indicates the ID of the transaction
currently being waited for. The job will actually start once all imports with
transaction IDs prior to this one have been completed.
- - RUNNING: The job is running.
+- RUNNING: The job is currently in progress.
- - FINISHED: The job ran successfully.
+- FINISHED: The job has been successfully completed.
- - CANCELLED: The job failed to run.
+- CANCELLED: The job failed to run.
-- `Msg`: error message
+## Access Control Requirements
-- `Progress`: job progress. The progress here means `completed tablets/total
tablets`. Materialized views are created at tablet granularity.
+The user who executes this SQL must have at least the following permissions:
-- `Timeout`: Job timeout, in seconds.
+| Privilege | Object | Notes |
+|------------|--------|----|
+| ALTER_PRIV | table | |
-### Example
+## Examples
-1. View the materialized view jobs under the database example_db
+1. View materialized view jobs under the database example_db.
```sql
SHOW ALTER TABLE MATERIALIZED VIEW FROM example_db;
```
-### Keywords
-
- SHOW, ALTER, TABLE, MATERIALIZED, VIEW
-
-### Best Practice
-
diff --git
a/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-FRONTENDS-DISKS.md
b/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-FRONTENDS-DISKS.md
index 17f196e6843..8c439e64e0a 100644
---
a/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-FRONTENDS-DISKS.md
+++
b/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-FRONTENDS-DISKS.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-FRONTENDS-DISKS",
- "language": "en"
+"title": "SHOW FRONTENDS DISKS",
+"language": "en"
}
---
@@ -24,38 +24,54 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-FRONTENDS-DISKS
+## Description
-### Name
+This statement is used to view the disk information of important directories
on the FE node, such as metadata, logs, audit logs, and temporary directories.
-SHOW FRONTENDS DISKS
+## Syntax
-### Description
+```sql
+SHOW FRONTENDS DISKS;
+```
+
+## Return Value
+
+| Column | Note |
+|--------------------|-------------------------------------------------|
+| Name | The name of the FE node in bdbje
|
+| Host | The IP address of the FE node.
|
+| DirType | The types of directories to be displayed include the
following four categories: meta, log, audit-log, temp, and deploy. |
+| Dir | The directories for the types of directories to be
displayed. |
+| FileSystem | The file system in the Linux system where the types of
directories to be displayed are located. |
+| Capacity | The capacity of the file system.
|
+| Used | The used size of the file system.
|
+| Available | The remaining capacity of the file system.
|
+| UseRate | The usage percentage of the file system capacity.
|
+| MountOn | The mount directory of the file system.
|
-This statement is used to view FE nodes's important paths' disk information,
such as meta, log, audit-log and temp dir.
+## Access Control Requirements
- grammar:
+The user who executes this SQL must have at least the following permissions:
+
+| Privilege | Object | Notes |
+|-------------------------|----|----|
+| ADMIN_PRIV or NODE_PRIV | | |
+
+## Usage Notes
+
+If further filtering of the query results is required, the table-valued
function
[frontends_disks()](../../../sql-functions/table-valued-functions/frontends_disks.md)
can be used. SHOW BACKENDS is equivalent to the following statement:
```sql
-SHOW FRONTENDS DISKS;
+SELECT * FROM FRONTENDS_DISKS();
```
-illustrate:
-
-1. Name indicates the name of the FE node in bdbje.
-2. Host indicates the ip of the FE node.
-3. DirType indicates the type of dir type, such as meta, log, audit-log temp
and deploy dir.
-4. Dir indicates the dir path of FE node dir in which type.
-5. FileSystem indicates the dir path in which file system on the linux
operation system.
-6. Capacity indicates total capacity of the filesystem.
-7. Used indicates the size of the filesystem already used.
-8. Available indicates the size of the filesystem remained.
-9. UseRate indicates File system usage capacity ratio.
-10. MountOn indicates the mount dir of the filesystem.
-
-### Example
-`
-mysql> show frontends disks;
+## Examples
+
+```sql
+SHOW FRONTENDS DISKS;
+```
+
+```text
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
| Name | Host | DirType | Dir
| Filesystem | Capacity | Used | Available | UseRate |
MountOn |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
@@ -65,12 +81,4 @@ mysql> show frontends disks;
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | temp |
/home/disk/output/fe/temp_dir | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | deploy |
/home/disk/output/fe | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
-5 rows in set (0.00 sec)
-`
-
-### Keywords
-
- SHOW, FRONTENDS
-
-### Best Practice
-
+```
diff --git
a/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
b/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
index c7e2f1e3698..e81867e1a8a 100644
---
a/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
+++
b/versioned_docs/version-2.0/sql-manual/sql-reference/Show-Statements/SHOW-PARTITION-ID.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-PARTITION-ID",
- "language": "en"
+"title": "SHOW PARTITION ID",
+"language": "en"
}
---
@@ -24,32 +24,35 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-PARTITION-ID
+## Description
-### Name
+This statement is used to find the corresponding database name, table name,
and partition name based on the partition ID.
-SHOW PARTITION ID
+## Syntax
-### Description
+```sql
+SHOW PARTITION <partition_id>
+```
-This statement is used to find the corresponding database name, table name,
partition name according to the partition id (only for administrators)
+## Required Parameters
- grammar:
+**1. `<partition_id>`**
-```sql
-SHOW PARTITION [partition_id]
-```
-### Example
+> partition id
-1. Find the corresponding database name, table name, partition name according
to the partition id
+## Access Control Requirements
- ```sql
- SHOW PARTITION 10002;
- ```
+The user who executes this SQL must have at least the following permissions:
+
+| Privilege | Object | Notes |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
-### Keywords
+## Examples
- SHOW, PARTITION, ID
+1. To find the corresponding database name, table name, and partition name
based on the partition ID.
-### Best Practice
+ ```sql
+ SHOW PARTITION 10002;
+ ```
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
index de275022152..8c439e64e0a 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW FRONTENDS DISKS",
- "language": "en"
+"title": "SHOW FRONTENDS DISKS",
+"language": "en"
}
---
@@ -24,10 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-
## Description
-This statement is used to view FE nodes's important paths' disk information,
such as meta, log, audit-log and temp dir.
+This statement is used to view the disk information of important directories
on the FE node, such as metadata, logs, audit logs, and temporary directories.
## Syntax
@@ -35,23 +34,44 @@ This statement is used to view FE nodes's important paths'
disk information, suc
SHOW FRONTENDS DISKS;
```
-Note:
+## Return Value
+
+| Column | Note |
+|--------------------|-------------------------------------------------|
+| Name | The name of the FE node in bdbje
|
+| Host | The IP address of the FE node.
|
+| DirType | The types of directories to be displayed include the
following four categories: meta, log, audit-log, temp, and deploy. |
+| Dir | The directories for the types of directories to be
displayed. |
+| FileSystem | The file system in the Linux system where the types of
directories to be displayed are located. |
+| Capacity | The capacity of the file system.
|
+| Used | The used size of the file system.
|
+| Available | The remaining capacity of the file system.
|
+| UseRate | The usage percentage of the file system capacity.
|
+| MountOn | The mount directory of the file system.
|
+
+## Access Control Requirements
+
+The user who executes this SQL must have at least the following permissions:
-1. Name indicates the name of the FE node in bdbje.
-2. Host indicates the ip of the FE node.
-3. DirType indicates the type of dir type, such as meta, log, audit-log temp
and deploy dir.
-4. Dir indicates the dir path of FE node dir in which type.
-5. FileSystem indicates the dir path in which file system on the linux
operation system.
-6. Capacity indicates total capacity of the filesystem.
-7. Used indicates the size of the filesystem already used.
-8. Available indicates the size of the filesystem remained.
-9. UseRate indicates File system usage capacity ratio.
-10. MountOn indicates the mount dir of the filesystem.
+| Privilege | Object | Notes |
+|-------------------------|----|----|
+| ADMIN_PRIV or NODE_PRIV | | |
-## Example
+## Usage Notes
+
+If further filtering of the query results is required, the table-valued
function
[frontends_disks()](../../../sql-functions/table-valued-functions/frontends_disks.md)
can be used. SHOW BACKENDS is equivalent to the following statement:
```sql
-mysql> show frontends disks;
+SELECT * FROM FRONTENDS_DISKS();
+```
+
+## Examples
+
+```sql
+SHOW FRONTENDS DISKS;
+```
+
+```text
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
| Name | Host | DirType | Dir
| Filesystem | Capacity | Used | Available | UseRate |
MountOn |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
@@ -61,11 +81,4 @@ mysql> show frontends disks;
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | temp |
/home/disk/output/fe/temp_dir | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | deploy |
/home/disk/output/fe | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
-5 rows in set (0.00 sec)
```
-
-## Keywords
-
-SHOW, FRONTENDS
-
-
diff --git
a/versioned_docs/version-2.1/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
b/versioned_docs/version-2.1/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
index 9da0cdab2c9..e81867e1a8a 100644
---
a/versioned_docs/version-2.1/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
+++
b/versioned_docs/version-2.1/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-PARTITION-ID",
- "language": "en"
+"title": "SHOW PARTITION ID",
+"language": "en"
}
---
@@ -24,28 +24,35 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
-This statement is used to find the corresponding database name, table name,
partition name according to the partition id (only for administrators)
+This statement is used to find the corresponding database name, table name,
and partition name based on the partition ID.
## Syntax
```sql
-SHOW PARTITION [partition_id]
+SHOW PARTITION <partition_id>
```
-## Example
-1. Find the corresponding database name, table name, partition name according
to the partition id
+## Required Parameters
- ```sql
- SHOW PARTITION 10002;
- ```
+**1. `<partition_id>`**
+
+> partition id
-## Keywords
+## Access Control Requirements
-SHOW, PARTITION, ID
+The user who executes this SQL must have at least the following permissions:
+| Privilege | Object | Notes |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
+## Examples
+
+1. To find the corresponding database name, table name, and partition name
based on the partition ID.
+
+ ```sql
+ SHOW PARTITION 10002;
+ ```
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
index 3dc6ac4f3ce..8c439e64e0a 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/instance-management/SHOW-FRONTENDS-DISKS.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW FRONTENDS DISKS",
- "language": "en"
+"title": "SHOW FRONTENDS DISKS",
+"language": "en"
}
---
@@ -24,10 +24,9 @@ specific language governing permissions and limitations
under the License.
-->
-
## Description
-This statement is used to view FE nodes's important paths' disk information,
such as meta, log, audit-log and temp dir.
+This statement is used to view the disk information of important directories
on the FE node, such as metadata, logs, audit logs, and temporary directories.
## Syntax
@@ -35,22 +34,44 @@ This statement is used to view FE nodes's important paths'
disk information, suc
SHOW FRONTENDS DISKS;
```
-illustrate:
-
-1. Name indicates the name of the FE node in bdbje.
-2. Host indicates the ip of the FE node.
-3. DirType indicates the type of dir type, such as meta, log, audit-log temp
and deploy dir.
-4. Dir indicates the dir path of FE node dir in which type.
-5. FileSystem indicates the dir path in which file system on the linux
operation system.
-6. Capacity indicates total capacity of the filesystem.
-7. Used indicates the size of the filesystem already used.
-8. Available indicates the size of the filesystem remained.
-9. UseRate indicates File system usage capacity ratio.
-10. MountOn indicates the mount dir of the filesystem.
-
-## Example
-`
-mysql> show frontends disks;
+## Return Value
+
+| Column | Note |
+|--------------------|-------------------------------------------------|
+| Name | The name of the FE node in bdbje
|
+| Host | The IP address of the FE node.
|
+| DirType | The types of directories to be displayed include the
following four categories: meta, log, audit-log, temp, and deploy. |
+| Dir | The directories for the types of directories to be
displayed. |
+| FileSystem | The file system in the Linux system where the types of
directories to be displayed are located. |
+| Capacity | The capacity of the file system.
|
+| Used | The used size of the file system.
|
+| Available | The remaining capacity of the file system.
|
+| UseRate | The usage percentage of the file system capacity.
|
+| MountOn | The mount directory of the file system.
|
+
+## Access Control Requirements
+
+The user who executes this SQL must have at least the following permissions:
+
+| Privilege | Object | Notes |
+|-------------------------|----|----|
+| ADMIN_PRIV or NODE_PRIV | | |
+
+## Usage Notes
+
+If further filtering of the query results is required, the table-valued
function
[frontends_disks()](../../../sql-functions/table-valued-functions/frontends_disks.md)
can be used. SHOW BACKENDS is equivalent to the following statement:
+
+```sql
+SELECT * FROM FRONTENDS_DISKS();
+```
+
+## Examples
+
+```sql
+SHOW FRONTENDS DISKS;
+```
+
+```text
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
| Name | Host | DirType | Dir
| Filesystem | Capacity | Used | Available | UseRate |
MountOn |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
@@ -60,11 +81,4 @@ mysql> show frontends disks;
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | temp |
/home/disk/output/fe/temp_dir | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
| fe_a1daac68_5ec0_477c_b5e8_f90a33cdc1bb | 10.xx.xx.90 | deploy |
/home/disk/output/fe | /dev/sdf1 | 7T | 2T | 4T |
36% | /home/disk |
+-----------------------------------------+-------------+-----------+---------------------------------+------------+----------+------+-----------+---------+------------+
-5 rows in set (0.00 sec)
-`
-
-## Keywords
-
-SHOW, FRONTENDS
-
-
+```
diff --git
a/versioned_docs/version-3.0/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
b/versioned_docs/version-3.0/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
index c7e2f1e3698..e81867e1a8a 100644
---
a/versioned_docs/version-3.0/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
+++
b/versioned_docs/version-3.0/sql-manual/sql-statements/table-and-view/table/SHOW-PARTITION-ID.md
@@ -1,7 +1,7 @@
---
{
- "title": "SHOW-PARTITION-ID",
- "language": "en"
+"title": "SHOW PARTITION ID",
+"language": "en"
}
---
@@ -24,32 +24,35 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-PARTITION-ID
+## Description
-### Name
+This statement is used to find the corresponding database name, table name,
and partition name based on the partition ID.
-SHOW PARTITION ID
+## Syntax
-### Description
+```sql
+SHOW PARTITION <partition_id>
+```
-This statement is used to find the corresponding database name, table name,
partition name according to the partition id (only for administrators)
+## Required Parameters
- grammar:
+**1. `<partition_id>`**
-```sql
-SHOW PARTITION [partition_id]
-```
-### Example
+> partition id
-1. Find the corresponding database name, table name, partition name according
to the partition id
+## Access Control Requirements
- ```sql
- SHOW PARTITION 10002;
- ```
+The user who executes this SQL must have at least the following permissions:
+
+| Privilege | Object | Notes |
+|---------------------|----|----|
+| ADMIN_PRIV | | |
-### Keywords
+## Examples
- SHOW, PARTITION, ID
+1. To find the corresponding database name, table name, and partition name
based on the partition ID.
-### Best Practice
+ ```sql
+ SHOW PARTITION 10002;
+ ```
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
