Add a Data Model document (#138)

apache · Jul 7, 2024 · ae9df85 · ae9df85
1 parent 39f0289
commit ae9df85
Show file tree

Hide file tree

Showing 4 changed files with 140 additions and 1 deletion.
diff --git a/docs/src/.vuepress/sidebar/V1.0.x/en.ts b/docs/src/.vuepress/sidebar/V1.0.x/en.ts
@@ -38,6 +38,10 @@ export const enSidebar = {
       //   { text: 'Quick Start', link: 'QuickStart' },
       // ],
     },
-
+    {
+      text: 'Data Model',
+      collapsible: true,
+      link: 'QuickStart/Data-Model',
+    },
   ]
 };
diff --git a/docs/src/.vuepress/sidebar/V1.0.x/zh.ts b/docs/src/.vuepress/sidebar/V1.0.x/zh.ts
@@ -38,5 +38,10 @@ export const zhSidebar = {
       //   { text: '快速上手', link: 'QuickStart' },
       // ],
     },
+    {
+      text: '数据模型',
+      collapsible: true,
+      link: 'QuickStart/Data-Model',
+    },
   ]
 };
diff --git a/docs/src/UserGuide/latest/QuickStart/Data-Model.md b/docs/src/UserGuide/latest/QuickStart/Data-Model.md
@@ -0,0 +1,65 @@
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+    
+        http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+-->
+# Data Model
+
+## Basic Concepts
+
+To manage industrial IoT timing data, the measurement point data model of TsFile includes the following information
+
+- DeviceId（String）：Device Name
+- MeasurementSchema：Measurement points
+  - measurementId（String）：Measurement Point Name
+  - tsDataType（TSDataType）：Data Type
+
+For the above detailed introduction, please refer to：[Entering Time Series Data](https://tsfile.apache.org/UserGuide/latest/QuickStart/Navigating_Time_Series_Data.html)
+
+## Example
+
+![](https://alioss.timecho.com/docs/img/20240502164237-dkcm.png)
+
+In the above example, the metadata (Scheme) of TsFile contains 2 devices and 5 time series, and is established as a table structure as shown in the following figure:
+
+<table>       
+  <tr>             
+    <th rowspan="1">Device ID</th>             
+    <th rowspan="1">Measurement points</th>                          
+  </tr>       
+  <tr>             
+    <th rowspan="2">Solar panel 1</th> 
+    <th>Voltage（FLOAT）</th>                     
+  </tr>  
+  <tr>
+  <th>Current（FLOAT）</th>
+  </tr>
+  <tr>
+    <th rowspan="4">Fan1</th>  
+  </tr> 
+  <tr>             
+    <th>Voltage（FLOAT）</th>
+  </tr> 
+  <tr> 
+    <th>Current（FLOAT）</th>
+  </tr> 
+  <tr> 
+    <th>Wind Speed（FLOAT）</th> 
+  </tr> 
+</table>
+
diff --git a/docs/src/zh/UserGuide/latest/QuickStart/Data-Model.md b/docs/src/zh/UserGuide/latest/QuickStart/Data-Model.md
@@ -0,0 +1,65 @@
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+    
+        http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+-->
+# TsFile 数据模型
+
+## 基本概念
+
+为管理工业物联网时序数据，TsFile 的测点数据模型包含如下信息
+
+- DeviceId（String）：设备名
+- MeasurementSchema：测点
+  - measurementId（String）：测点名
+  - tsDataType（TSDataType）：数据类型
+
+有关上述详细介绍，参见：[走进时序数据](https://tsfile.apache.org/zh/UserGuide/latest/QuickStart/Navigating_Time_Series_Data.html)
+
+## 示例
+
+![](https://alioss.timecho.com/docs/img/tsfile%E6%95%B0%E6%8D%AE%E6%A8%A1%E5%9E%8B.png)
+
+在上述示例中，TsFile 的元数据（Schema）共包含 2 个设备，5条时间序列，建立为表结构如下图：
+
+<table>       
+  <tr>             
+    <th rowspan="1">设备ID</th>             
+    <th rowspan="1">测点</th>                          
+  </tr>       
+  <tr>             
+    <th rowspan="2">太阳能板1</th> 
+    <th>电压（FLOAT）</th>                     
+  </tr>  
+  <tr>
+  <th>电流（FLOAT）</th>
+  </tr>
+  <tr>
+    <th rowspan="4">风机1</th>  
+  </tr> 
+  <tr>             
+    <th>电压（FLOAT）</th>
+  </tr> 
+  <tr> 
+    <th>电流（FLOAT）</th>
+  </tr> 
+  <tr> 
+    <th>风速（FLOAT）</th> 
+  </tr> 
+</table>
+