You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by qi...@apache.org on 2020/02/06 12:17:57 UTC

[incubator-iotdb] branch master updated: [IoTDB-463] [doc] Fix documents in progress version (#775)

This is an automated email from the ASF dual-hosted git repository.

qiaojialin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git


The following commit(s) were added to refs/heads/master by this push:
     new f461ba2  [IoTDB-463] [doc] Fix documents in progress version (#775)
f461ba2 is described below

commit f461ba21eac0cff5ccd2cedc1f549a297357da95
Author: Xiangwei Wei <34...@users.noreply.github.com>
AuthorDate: Thu Feb 6 20:17:46 2020 +0800

    [IoTDB-463] [doc] Fix documents in progress version (#775)
    
    * [IoTDB-463] Show devices grammar is incomplete
---
 .../1-DDL (Data Definition Language).md                |  8 +++++++-
 .../UserGuide/5-Operation Manual/4-SQL Reference.md    | 13 ++++++++++++-
 .../1-DDL (Data Definition Language).md                |  9 +++++++--
 .../UserGuide/5-Operation Manual/4-SQL Reference.md    | 18 +++++++++++++++---
 4 files changed, 41 insertions(+), 7 deletions(-)

diff --git a/docs/Documentation-CHN/UserGuide/5-Operation Manual/1-DDL (Data Definition Language).md b/docs/Documentation-CHN/UserGuide/5-Operation Manual/1-DDL (Data Definition Language).md
index 762269e..b0e7eaa 100644
--- a/docs/Documentation-CHN/UserGuide/5-Operation Manual/1-DDL (Data Definition Language).md	
+++ b/docs/Documentation-CHN/UserGuide/5-Operation Manual/1-DDL (Data Definition Language).md	
@@ -148,9 +148,15 @@ IoTDB> delete timeseries root.ln.wf02.*
 ```
 
 ### 查看设备
-我们可以通过使用`SHOW DEVICES`语句查看当前所有设备。SQL语句如下所示:
+
+与 `Show Timeseries` 相似,IoTDB 目前也支持两种方式查看设备。
+* `SHOW DEVICES` 语句显示当前所有的设备信息,等价于 `SHOW DEVICES root`。
+* `SHOW DEVICES <PrefixPath>` 语句规定了 `PrefixPath`,返回在给定的前缀路径下的设备信息。
+
+SQL语句如下所示:
 ```
 IoTDB> show devices
+IoTDB> show devices root.ln
 ```
 
 ## TTL
diff --git a/docs/Documentation-CHN/UserGuide/5-Operation Manual/4-SQL Reference.md b/docs/Documentation-CHN/UserGuide/5-Operation Manual/4-SQL Reference.md
index cec69a9..2507c71 100644
--- a/docs/Documentation-CHN/UserGuide/5-Operation Manual/4-SQL Reference.md	
+++ b/docs/Documentation-CHN/UserGuide/5-Operation Manual/4-SQL Reference.md	
@@ -143,7 +143,7 @@ Note: The path can be prefix path or timeseries path.
 Note: This statement can be used in IoTDB Client and JDBC.
 ```
 
-* 显示设备语句
+* 显示所有设备语句
 
 ```
 SHOW DEVICES
@@ -151,6 +151,17 @@ Eg: IoTDB > SHOW DEVICES
 Note: This statement can be used in IoTDB Client and JDBC.
 ```
 
+* 显示特定设备语句
+
+```
+SHOW DEVICES <PrefixPath>
+Eg: IoTDB > SHOW DEVICES root
+Eg: IoTDB > SHOW DEVICES root.ln
+Eg: IoTDB > SHOW DEVICES root.*.wf01
+Note: The path can be prefix path or star path.
+Note: This statement can be used in IoTDB Client and JDBC.
+```
+
 * 显示ROOT节点的子节点名称语句
 
 ```
diff --git a/docs/Documentation/UserGuide/5-Operation Manual/1-DDL (Data Definition Language).md b/docs/Documentation/UserGuide/5-Operation Manual/1-DDL (Data Definition Language).md
index 4d31060..54a99ed 100644
--- a/docs/Documentation/UserGuide/5-Operation Manual/1-DDL (Data Definition Language).md	
+++ b/docs/Documentation/UserGuide/5-Operation Manual/1-DDL (Data Definition Language).md	
@@ -91,7 +91,7 @@ The results are shown below respectly:
 It is worth noting that when the queried path does not exist, the system will return no timeseries.  
 
 ### Count Timeseries
-IoTDB is able to use `COUNT TIMESERIES<Path>` to count the number of timeseries in the path. SQL statements are as follows:
+IoTDB is able to use `COUNT TIMESERIES <Path>` to count the number of timeseries in the path. SQL statements are as follows:
 ```
 IoTDB > COUNT TIMESERIES root
 IoTDB > COUNT TIMESERIES root.ln
@@ -146,10 +146,15 @@ IoTDB> delete timeseries root.ln.wf02.*
 ```
 
 ### Show Devices
-IoTDB supports users to check the devices using  `SHOW DEVICES` statement.
+
+Similar to `Show Timeseries`, IoTDB also supports two ways of viewing devices:
+
+* `SHOW DEVICES` statement presents all devices information, which is equal to `SHOW DEVICES root`.
+* `SHOW DEVICES <PrefixPath>` statement specifies the `PrefixPath` and returns the devices information under the given level.
 SQL statement is as follows:
 ```
 IoTDB> show devices
+IoTDB> show devices root.ln
 ```
 
 ## TTL
diff --git a/docs/Documentation/UserGuide/5-Operation Manual/4-SQL Reference.md b/docs/Documentation/UserGuide/5-Operation Manual/4-SQL Reference.md
index cb1b49d..d9d70e5 100644
--- a/docs/Documentation/UserGuide/5-Operation Manual/4-SQL Reference.md	
+++ b/docs/Documentation/UserGuide/5-Operation Manual/4-SQL Reference.md	
@@ -152,10 +152,22 @@ Note: The path can be prefix path or timeseries path.
 Note: This statement can be used in IoTDB Client and JDBC.
 ```
 
-* Show Devices Statement
+* Show All Devices Statement
+
+```
+SHOW Devices
+Eg: IoTDB > SHOW Devices
+Note: This statement can be used in IoTDB Client and JDBC.
+```
+
+* Show Specific Devices Statement
+
 ```
-SHOW DEVICES
-Eg: IoTDB > SHOW DEVICES
+SHOW DEVICES <PrefixPath>
+Eg: IoTDB > SHOW DEVICES root
+Eg: IoTDB > SHOW DEVICES root.ln
+Eg: IoTDB > SHOW DEVICES root.*.wf01
+Note: The path can be prefix path or star path.
 Note: This statement can be used in IoTDB Client and JDBC.
 ```