This is an automated email from the ASF dual-hosted git repository.
jianglongtao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 1c5d58cc932 Change show resources formulate. (#20990)
1c5d58cc932 is described below
commit 1c5d58cc932274c7414a9a066519382e6c22fec3
Author: Jieker <[email protected]>
AuthorDate: Thu Sep 15 16:53:56 2022 +0800
Change show resources formulate. (#20990)
---
...{show-resource.cn.md => show-database-resources.cn.md} | 15 +++++++++------
...{show-resource.en.md => show-database-resources.en.md} | 11 +++++++----
.../rql/resource-query/show-rules-used-resource.cn.md | 6 +++++-
.../rql/resource-query/show-rules-used-resource.en.md | 6 +++++-
.../syntax/rql/resource-query/show-unused-resource.cn.md | 8 ++++++--
.../syntax/rql/resource-query/show-unused-resource.en.md | 8 +++++---
6 files changed, 37 insertions(+), 17 deletions(-)
diff --git
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-resource.cn.md
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-database-resources.cn.md
similarity index 98%
rename from
docs/document/content/reference/distsql/syntax/rql/resource-query/show-resource.cn.md
rename to
docs/document/content/reference/distsql/syntax/rql/resource-query/show-database-resources.cn.md
index 83b2832178f..6cd11746604 100644
---
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-resource.cn.md
+++
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-database-resources.cn.md
@@ -1,16 +1,15 @@
+++
-title = "SHOW RESOURCE"
+title = "SHOW DATABASE RESOURCES"
weight = 2
+++
-
### 描述
-`SHOW RESOURCE` 语法用于查询指定逻辑库已经添加的资源。
+`SHOW DATABASE RESOURCES` 语法用于查询指定逻辑库已经添加的资源。
### 语法
-```SQL
+```sql
ShowResource ::=
'SHOW' 'DATABASE' 'RESOURCES' ('FROM' databaseName)?
@@ -22,7 +21,7 @@ databaseName ::=
- 未指定 `databaseName` 时,默认是当前使用的 `DATABASE`; 如未使用 `DATABASE` 则会提示 `No database
selected`。
- ### 返回值说明
+### 返回值说明
| 列 | 说明 |
| --------- | -------- |
@@ -33,12 +32,14 @@ databaseName ::=
| db | 数据库名称 |
| attribute | 数据源参数 |
- ### 示例
+### 示例
- 查询指定逻辑库的资源
+
```sql
SHOW DATABASE RESOURCES FROM sharding_db;
```
+
```sql
+------+-------+-----------+------+------+---------------------------------+---------------------------+---------------------------+---------------+---------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| name | type | host | port | db | connection_timeout_milliseconds |
idle_timeout_milliseconds | max_lifetime_milliseconds | max_pool_size |
min_pool_size | read_only | other_attributes
[...]
@@ -50,9 +51,11 @@ SHOW DATABASE RESOURCES FROM sharding_db;
```
- 查询当前逻辑库的资源
+
```sql
SHOW DATABASE RESOURCES;
```
+
```sql
+------+-------+-----------+------+------+---------------------------------+---------------------------+---------------------------+---------------+---------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| name | type | host | port | db | connection_timeout_milliseconds |
idle_timeout_milliseconds | max_lifetime_milliseconds | max_pool_size |
min_pool_size | read_only | other_attributes
[...]
diff --git
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-resource.en.md
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-database-resources.en.md
similarity index 98%
rename from
docs/document/content/reference/distsql/syntax/rql/resource-query/show-resource.en.md
rename to
docs/document/content/reference/distsql/syntax/rql/resource-query/show-database-resources.en.md
index 0a3e67a7037..233f9c89c70 100644
---
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-resource.en.md
+++
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-database-resources.en.md
@@ -1,15 +1,15 @@
+++
-title = "SHOW RESOURCE"
+title = "SHOW DATABASE RESOURCES"
weight = 2
+++
### Description
-The `SHOW RESOURCE` syntax is used to query the resources that have been added
to the specified database.
+The `SHOW DATABASE RESOURCES` syntax is used to query the resources that have
been added to the specified database.
### Syntax
-```SQL
+```sql
ShowResource ::=
'SHOW' 'DATABASE' 'RESOURCES' ('FROM' databaseName)?
@@ -21,7 +21,7 @@ databaseName ::=
- When `databaseName` is not specified, the default is the currently used
`DATABASE`; if `DATABASE` is not used, it will prompt `No database selected`.
- ### Return Value Description
+### Return Value Description
| Column | Description |
| --------- | --------------------- |
@@ -39,6 +39,7 @@ databaseName ::=
```sql
SHOW DATABASE RESOURCES FROM sharding_db;
```
+
```sql
+------+-------+-----------+------+------+---------------------------------+---------------------------+---------------------------+---------------+---------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| name | type | host | port | db | connection_timeout_milliseconds |
idle_timeout_milliseconds | max_lifetime_milliseconds | max_pool_size |
min_pool_size | read_only | other_attributes
[...]
@@ -50,9 +51,11 @@ SHOW DATABASE RESOURCES FROM sharding_db;
```
- Query resources for the current database
+
```sql
SHOW DATABASE RESOURCES;
```
+
```sql
+------+-------+-----------+------+------+---------------------------------+---------------------------+---------------------------+---------------+---------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| name | type | host | port | db | connection_timeout_milliseconds |
idle_timeout_milliseconds | max_lifetime_milliseconds | max_pool_size |
min_pool_size | read_only | other_attributes
[...]
diff --git
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-rules-used-resource.cn.md
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-rules-used-resource.cn.md
index 018511bafd9..1931a68288e 100644
---
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-rules-used-resource.cn.md
+++
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-rules-used-resource.cn.md
@@ -9,7 +9,7 @@ weight = 4
### 语法
-```SQL
+```sql
showRulesUsedResource ::=
'SHOW' 'RULES' 'USED' 'RESOURCES' resourceName ('FROM' databaseName)?
@@ -34,9 +34,11 @@ databaseName ::=
### 示例
- 查询指定逻辑库中使用指定资源的规则
+
```sql
SHOW RULES USED RESOURCE ds_0 FROM sharding_db;
```
+
```sql
+----------+--------------+
| type | name |
@@ -48,9 +50,11 @@ SHOW RULES USED RESOURCE ds_0 FROM sharding_db;
```
- 查询当前逻辑库中使用指定资源的规则
+
```sql
SHOW RULES USED RESOURCE ds_0;
```
+
```sql
+----------+--------------+
| type | name |
diff --git
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-rules-used-resource.en.md
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-rules-used-resource.en.md
index c89034b1fe4..baebe50448e 100644
---
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-rules-used-resource.en.md
+++
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-rules-used-resource.en.md
@@ -9,7 +9,7 @@ The `SHOW RULES USED RESOURCE` syntax is used to query the
rules that use the sp
### Syntax
-```SQL
+```sql
showRulesUsedResource ::=
'SHOW' 'RULES' 'USED' 'RESOURCES' resourceName ('FROM' databaseName)?
@@ -34,9 +34,11 @@ databaseName ::=
### Example
- Query the rules that use the specified resource in the specified database
+
```sql
SHOW RULES USED RESOURCE ds_0 FROM sharding_db;
```
+
```sql
+----------+--------------+
| type | name |
@@ -48,9 +50,11 @@ SHOW RULES USED RESOURCE ds_0 FROM sharding_db;
```
- Query the rules that use the specified resource in the current database
+
```sql
SHOW RULES USED RESOURCE ds_0;
```
+
```sql
+----------+--------------+
| type | name |
diff --git
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-unused-resource.cn.md
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-unused-resource.cn.md
index 12a7d2f583f..3ca4eefb8c8 100644
---
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-unused-resource.cn.md
+++
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-unused-resource.cn.md
@@ -9,7 +9,7 @@ weight = 3
### 语法
-```SQL
+```sql
ShowUnusedResource ::=
'SHOW' 'UNUSED' 'DATABASE'? 'RESOURCES' ('FROM' databaseName)?
@@ -21,7 +21,7 @@ databaseName ::=
- 未指定 `databaseName` 时,默认是当前使用的 `DATABASE`; 如未使用 `DATABASE` 则会提示 `No database
selected`。
- ### 返回值说明
+### 返回值说明
| 列 | 说明 |
| --------- | -------- |
@@ -35,9 +35,11 @@ databaseName ::=
### 示例
- 查询指定逻辑库的资源
+
```sql
SHOW UNUSED DATABASE RESOURCES FROM sharding_db;
```
+
```sql
+------+-------+-----------+------+------+---------------------------------+---------------------------+---------------------------+---------------+---------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| name | type | host | port | db | connection_timeout_milliseconds |
idle_timeout_milliseconds | max_lifetime_milliseconds | max_pool_size |
min_pool_size | read_only | other_attributes
[...]
@@ -48,9 +50,11 @@ SHOW UNUSED DATABASE RESOURCES FROM sharding_db;
```
- 查询当前逻辑库的资源
+
```sql
SHOW UNUSED DATABASE RESOURCES;
```
+
```sql
+------+-------+-----------+------+------+---------------------------------+---------------------------+---------------------------+---------------+---------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| name | type | host | port | db | connection_timeout_milliseconds |
idle_timeout_milliseconds | max_lifetime_milliseconds | max_pool_size |
min_pool_size | read_only | other_attributes
[...]
diff --git
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-unused-resource.en.md
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-unused-resource.en.md
index 1aa8d0d4381..47545a2bdd6 100644
---
a/docs/document/content/reference/distsql/syntax/rql/resource-query/show-unused-resource.en.md
+++
b/docs/document/content/reference/distsql/syntax/rql/resource-query/show-unused-resource.en.md
@@ -9,7 +9,7 @@ The `SHOW UNUSED RESOURCE` syntax is used to query resources in
the specified da
### Syntax
-```SQL
+```sql
ShowUnusedResource ::=
'SHOW' 'UNUSED' 'DATABASE'? 'RESOURCES' ('FROM' databaseName)?
@@ -21,7 +21,7 @@ databaseName ::=
- When `databaseName` is not specified, the default is the currently used
`DATABASE`; if `DATABASE` is not used, it will prompt `No database selected`.
- ### Return Value Description
+### Return Value Description
| Column | Description |
| --------- | --------------------- |
@@ -32,13 +32,14 @@ databaseName ::=
| db | Database name |
| attribute | Data source attribute |
- ### Example
+### Example
- Query resources for the specified database
```sql
SHOW UNUSED DATABASE RESOURCES FROM sharding_db;
```
+
```sql
+------+-------+-----------+------+------+---------------------------------+---------------------------+---------------------------+---------------+---------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| name | type | host | port | db | connection_timeout_milliseconds |
idle_timeout_milliseconds | max_lifetime_milliseconds | max_pool_size |
min_pool_size | read_only | other_attributes
[...]
@@ -53,6 +54,7 @@ SHOW UNUSED DATABASE RESOURCES FROM sharding_db;
```sql
SHOW UNUSED DATABASE RESOURCES;
```
+
```sql
+------+-------+-----------+------+------+---------------------------------+---------------------------+---------------------------+---------------+---------------+-----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| name | type | host | port | db | connection_timeout_milliseconds |
idle_timeout_milliseconds | max_lifetime_milliseconds | max_pool_size |
min_pool_size | read_only | other_attributes
[...]