You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ro...@apache.org on 2021/10/05 11:02:04 UTC

[iotdb] branch iotdb-1620 updated (cbbdc6c -> 3ef3591)

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

rong pushed a change to branch iotdb-1620
in repository https://gitbox.apache.org/repos/asf/iotdb.git.


    from cbbdc6c  fix cpp client ci on macos (#4074)
     new 0cc3473  site: set the sidebar depth of 'Data Concept' to 2
     new 3ef3591  cn user doc

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../Data-Concept/Data-Model-and-Terminology.md     | 45 ++++++++++++----------
 site/src/main/.vuepress/config.js                  |  2 +
 2 files changed, 27 insertions(+), 20 deletions(-)

[iotdb] 02/02: cn user doc

Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

rong pushed a commit to branch iotdb-1620
in repository https://gitbox.apache.org/repos/asf/iotdb.git

commit 3ef35916b220989b0b76727a56a53306cee10897
Author: Steve Yurong Su <ro...@apache.org>
AuthorDate: Tue Oct 5 19:01:25 2021 +0800

    cn user doc
---
 .../Data-Concept/Data-Model-and-Terminology.md     | 45 ++++++++++++----------
 1 file changed, 25 insertions(+), 20 deletions(-)

diff --git a/docs/zh/UserGuide/Data-Concept/Data-Model-and-Terminology.md b/docs/zh/UserGuide/Data-Concept/Data-Model-and-Terminology.md
index 8c2658f..85bd370 100644
--- a/docs/zh/UserGuide/Data-Concept/Data-Model-and-Terminology.md
+++ b/docs/zh/UserGuide/Data-Concept/Data-Model-and-Terminology.md
@@ -33,21 +33,21 @@ IoTDB 模型结构涉及的基本概念在下文将做详细叙述。
 
 ### 物理量、实体、存储组、路径
 
-* 物理量(Measurement,也称工况、字段 field)
+#### 物理量(Measurement,也称工况、字段 field)
 
 **一元或多元物理量**,是在实际场景中检测装置所记录的测量信息,且可以按一定规律变换成为电信号或其他所需形式的信息输出并发送给 IoTDB。在 IoTDB 当中,存储的所有数据及路径,都是以物理量为单位进行组织。
 
-* 物理分量(SubMeasurement、分量)
+#### 物理分量(SubMeasurement、分量)
 
 在多元物理量中,包括多个分量。如 GPS 是一个多元物理量,包含 3 个分量:经度、维度、海拔。多元物理量通常被同时采集,共享时间列。
 
 一元物理量则将分量名和物理量名字重合。如温度是一个一元物理量。
 
-* 实体(Entity,也称设备,device)
+#### 实体(Entity,也称设备,device)
 
 **一个物理实体**,是在实际场景中拥有物理量的设备或装置。在 IoTDB 当中,所有的物理量都有其对应的归属实体。
 
-* 存储组(Storage group)
+#### 存储组(Storage group)
 
 **一组物理实体**,用户可以将任意前缀路径设置成存储组。如有 4 条时间序列`root.ln.wf01.wt01.status`, `root.ln.wf01.wt01.temperature`, `root.ln.wf02.wt02.hardware`, `root.ln.wf02.wt02.status`,路径`root.ln`下的两个实体 `wt01`, `wt02`可能属于同一个业主,或者同一个制造商,这时候就可以将前缀路径`root.ln`指定为一个存储组。未来`root.ln`下增加了新的实体,也将属于该存储组。
 
@@ -63,35 +63,40 @@ IoTDB 模型结构涉及的基本概念在下文将做详细叙述。
 
 存储组节点名只支持中英文字符、数字、下划线和中划线的组合。例如`root. 存储组_1-组1` 。
 
-* 路径(Path)
+#### 路径(Path)
 
-在 IoTDB 中,路径是指符合以下约束的表达式:
+路径(`path`)是指符合以下约束的表达式:
 
 ```
-path: LayerName (DOT LayerName)+
-LayerName: Identifier | STAR
+path       : layer_name ('.' layer_name)*
+           ;
+layer_name : identifier 
+           | ('*' | '**')
+           ;
 ```
 
-其中 STAR 为 `*` 或 `**`,DOT 为 `.`。
+我们称一个路径中由 `'.'` 分割的部分叫做层级(`layer_name`)。例如:`root.a.b.c`为一个层级为 4 的路径。
 
-我们称一个路径中在两个“.”中间的部分叫做一个层级,则`root.a.b.c`为一个层级为 4 的路径。
+下面是对层级(`layer_name`)的约束:
 
-值得说明的是,在路径中,root 为一个保留字符,它只允许出现在下文提到的时间序列的开头,若其他层级出现 root,则无法解析,提示报错。
+* `root` 作为一个保留字符,它只允许出现在下文提到的时间序列的开头,若其他层级出现 `root`,则无法解析,提示报错。
 
-在路径中,不允许使用单引号。如果你想在 LayerName 中使用`.`等特殊字符,请使用双引号。例如,`root.sg."d.1"."s.1"`。双引号内支持使用转义符进行双引号的嵌套,如 `root.sg.d1."s.\"t\"1"`。
+* 除了时间序列的开头的层级(`root`)外,其他的层级支持的字符如下:
+  * 中文字符`"\u2E80"`到`"\u9FFF"`
+  * `"+","&","%","$","#","@","/","_","-",":"`
+  * `"A"`到`"Z"`,`"a"`到`"z"`,`"0"`到`"9"`
 
-除了 storage group 存储组,其他的 LayerName 中不用加双引号就支持的字符如下:
+  其中`'-'` 和` ':'` 不能放置在第一位,不能使用单个 `'+'`。
 
-* 中文字符"\u2E80"到"\u9FFF"
-* "+","&","%","$","#","@","/","_","-",":"
-* "A"到"Z","a"到"z","0"到"9"
+* 除了时间序列的开头的层级(`root`)和存储组层级外,层级还支持使用被  \`  或者 ` " ` 符号引用的特殊字符串作为其名称。需要注意的是,被引用的字符串不可带有 `.` 字符。下面是一些合法的例子:
 
-其中'-' 和 ':' 不能放置在第一位,不能使用单个 '+'。
+  * root.sg."select".""""."\$",5 个层级分别为 root, sg, select, "", \$
+  * root.sg.\`\`\`\`.\`from\`.\`\$\`,5 个层级分别为 root, sg, \`\`, from, \$
 
-> 注意:storage group 中的 LayerName 只支持数字,字母,汉字,下划线和中划线。另外,如果在 Windows 系统上部署,存储组层级名称是大小写不敏感的。例如同时创建`root.ln` 和 `root.LN` 是不被允许的。
+* 特别地,如果系统在 Windows 系统上部署,那么存储组层级名称是大小写不敏感的。例如,同时创建`root.ln` 和 `root.LN` 是不被允许的。
+
+#### 路径模式(Path Pattern)
 
-* 路径模式(Path Pattern)
-  
 为了使得在表达多个时间序列的时候更加方便快捷,IoTDB 为用户提供带通配符`*`或`**`的路径。用户可以利用两种通配符构造出期望的路径模式。通配符可以出现在路径中的任何层。
 
 `*`在路径中表示一层。例如`root.vehicle.*.sensor1`代表的是以`root.vehicle`为前缀,以`sensor1`为后缀,层次等于 4 层的路径。

[iotdb] 01/02: site: set the sidebar depth of 'Data Concept' to 2

Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

rong pushed a commit to branch iotdb-1620
in repository https://gitbox.apache.org/repos/asf/iotdb.git

commit 0cc347360cf8860e7a92383aa4eff49e694a3833
Author: Steve Yurong Su <ro...@apache.org>
AuthorDate: Tue Oct 5 10:36:49 2021 +0800

    site: set the sidebar depth of 'Data Concept' to 2
---
 site/src/main/.vuepress/config.js | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/site/src/main/.vuepress/config.js b/site/src/main/.vuepress/config.js
index 6a9d52b..786cc4d 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -664,6 +664,7 @@ var config = {
 					},
 					{
 						title: 'Data Concept',
+						sidebarDepth: 2,
 						children: [
 							['Data-Concept/Data-Model-and-Terminology','Data Model and Terminology'],
 							['Data-Concept/Measurement-Template','Measurement Template'],
@@ -1460,6 +1461,7 @@ var config = {
 					},
 					{
 						title: '数据模式与概念',
+						sidebarDepth: 2,
 						children: [
 							['Data-Concept/Data-Model-and-Terminology','数据模型'],
 							['Data-Concept/Measurement-Template','物理量模板'],