[iotdb] branch master updated: [IOTDB-4468] Add CLI special command in user guide (#7498)

[haonan]

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 777878d34d [IOTDB-4468] Add CLI special command in user guide (#7498)
777878d34d is described below

commit 777878d34d42ace9e4c7ff27adf7eb16974821a8
Author: wanghui42 <105700158+wanghu...@users.noreply.github.com>
AuthorDate: Fri Sep 30 17:23:16 2022 +0800

    [IOTDB-4468] Add CLI special command in user guide (#7498)
    
    Co-authored-by: Haonan <hhao...@outlook.com>
---
 docs/UserGuide/QuickStart/Command-Line-Interface.md    | 14 ++++++++++++++
 docs/zh/UserGuide/QuickStart/Command-Line-Interface.md | 14 ++++++++++++++
 2 files changed, 28 insertions(+)

diff --git a/docs/UserGuide/QuickStart/Command-Line-Interface.md 
b/docs/UserGuide/QuickStart/Command-Line-Interface.md
index cf3abe28ac..b09d6caf6d 100644
--- a/docs/UserGuide/QuickStart/Command-Line-Interface.md
+++ b/docs/UserGuide/QuickStart/Command-Line-Interface.md
@@ -103,6 +103,20 @@ The Windows system startup commands are as follows:
 Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root 
-disableISO8601 -maxPRC 10
 ```
 
+### CLI Special Command
+Special commands of Cli are below.
+| Command | Description / Example |
+|:---|:---|
+| `set time_display_type=xxx` | eg. long, default, ISO8601, yyyy-MM-dd 
HH:mm:ss |
+| `show time_display_type` | show time display type |
+| `set time_zone=xxx` | eg. +08:00, Asia/Shanghai |
+| `show time_zone` | show cli time zone |
+| `set fetch_size=xxx` | set fetch size when querying data from server |
+| `show fetch_size` |  show fetch size |
+| `set max_display_num=xxx` |  set max lines for cli to output, -1 equals to 
unlimited |
+| `help` |  Get hints for CLI special commands |
+| `exit/quit` |  Exit CLI |
+
 ### Note on using the CLI with OpenID Connect Auth enabled on Server side
 
 Openid connect (oidc) uses keycloack as the authority authentication service 
of oidc service
diff --git a/docs/zh/UserGuide/QuickStart/Command-Line-Interface.md 
b/docs/zh/UserGuide/QuickStart/Command-Line-Interface.md
index e4b56c7479..98e0a7eed1 100644
--- a/docs/zh/UserGuide/QuickStart/Command-Line-Interface.md
+++ b/docs/zh/UserGuide/QuickStart/Command-Line-Interface.md
@@ -90,6 +90,20 @@ Windows 系统启动命令如下：
 Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root 
-disableISO8601 -maxPRC 10
 ```
 
+### CLI 特殊命令
+下面列举了一些CLI的特殊命令。
+| 命令 | 描述 / 例子 |
+|:---|:---|
+| `set time_display_type=xxx` | 例如： long, default, ISO8601, yyyy-MM-dd 
HH:mm:ss |
+| `show time_display_type` | 显示时间显示方式 |
+| `set time_zone=xxx` | 例如： +08:00, Asia/Shanghai |
+| `show time_zone` | 显示CLI的时区 |
+| `set fetch_size=xxx` | 设置从服务器查询数据时的读取条数 |
+| `show fetch_size` |  显示读取条数的大小 |
+| `set max_display_num=xxx` | 设置 CLI 一次展示的最大数据条数， 设置为-1表示无限制 |
+| `help` | 获取CLI特殊命令的提示 |
+| `exit/quit` | 退出CLI |
+
 ### 使用 OpenID 作为用户名认证登录
 
 OpenID Connect (OIDC) 使用 keycloack 作为 OIDC 服务权限认证服务。