Skip to content

Commit e616c8b

Browse files
leto-bbqCritasWang
authored andcommitted
adjust tree or table model to mode (apache#993)
1 parent 64372cd commit e616c8b

38 files changed

Lines changed: 405 additions & 406 deletions

src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_apache.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@
2525

2626
### 1.1 sql_dialect
2727

28-
IoTDB supports two time-series data models (SQL dialects), both managing devices and measurement points:
28+
IoTDB supports two time-series data mode (SQL dialects), both managing devices and measurement points:
2929

30-
- **Tree** **Model**: Organizes data in a hierarchical path structure, where each path represents a measurement point of a device.
31-
- **Table** **Model**: Organizes data in a relational table format, where each table corresponds to a type of device.
30+
- **Tree** **Mode**: Organizes data in a hierarchical path structure, where each path represents a measurement point of a device.
31+
- **Table** **Mode**: Organizes data in a relational table format, where each table corresponds to a type of device.
3232

33-
Each dialect comes with its own SQL syntax and query patterns tailored to its data model.
33+
Each dialect comes with its own SQL syntax and query patterns tailored to its data mode.
3434

3535
### 1.2 Schema
3636

@@ -73,7 +73,7 @@ An IoTDB cluster consists of three types of nodes, each with distinct responsibi
7373

7474
- **ConfigNode (Management Node)** Manages cluster metadata, configuration, user permissions, schema, and partitioning. It also handles distributed scheduling and load balancing. All ConfigNodes are replicated for high availability.
7575
- **DataNode (Storage and Computation Node)** Handles client requests, stores data, and executes computations.
76-
- **AINode (Analytics Node)** Provides machine learning capabilities, allowing users to register pre-trained models and perform inference via SQL. It includes built-in time-series models and common ML algorithms for tasks like prediction and anomaly detection.
76+
- **AINode (Analytics Node)** Provides machine learning capabilities, allowing users to register pre-trained models and perform inference via SQL. It includes built-in time-series mode and common ML algorithms for tasks like prediction and anomaly detection.
7777

7878
### 2.3 Data Partitioning
7979

src/UserGuide/Master/Table/Background-knowledge/Cluster-Concept_timecho.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@
2525

2626
### 1.1 sql_dialect
2727

28-
IoTDB supports two time-series data models (SQL dialects), both managing devices and measurement points:
28+
IoTDB supports two time-series data mode (SQL dialects), both managing devices and measurement points:
2929

30-
- **Tree** **Model**: Organizes data in a hierarchical path structure, where each path represents a measurement point of a device.
31-
- **Table** **Model**: Organizes data in a relational table format, where each table corresponds to a type of device.
30+
- **Tree** **Mode**: Organizes data in a hierarchical path structure, where each path represents a measurement point of a device.
31+
- **Table** **Mode**: Organizes data in a relational table format, where each table corresponds to a type of device.
3232

33-
Each dialect comes with its own SQL syntax and query patterns tailored to its data model.
33+
Each dialect comes with its own SQL syntax and query patterns tailored to its data mode.
3434

3535
### 1.2 Schema
3636

@@ -74,7 +74,7 @@ An IoTDB cluster consists of three types of nodes, each with distinct responsibi
7474

7575
- **ConfigNode (Management Node)** Manages cluster metadata, configuration, user permissions, schema, and partitioning. It also handles distributed scheduling and load balancing. All ConfigNodes are replicated for high availability.
7676
- **DataNode (Storage and Computation Node)** Handles client requests, stores data, and executes computations.
77-
- **AINode (Analytics Node)** Provides machine learning capabilities, allowing users to register pre-trained models and perform inference via SQL. It includes built-in time-series models and common ML algorithms for tasks like prediction and anomaly detection.
77+
- **AINode (Analytics Node)** Provides machine learning capabilities, allowing users to register pre-trained models and perform inference via SQL. It includes built-in time-series modes and common ML algorithms for tasks like prediction and anomaly detection.
7878

7979
### 2.3 Data Partitioning
8080

src/UserGuide/Master/Table/Background-knowledge/Data-Model-and-Terminology_apache.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -21,31 +21,31 @@
2121

2222
# Modeling Scheme Design
2323

24-
This section introduces how to transform time series data application scenarios into IoTDB time series modeling.
24+
This section introduces how to transform time series data application scenarios into IoTDB time series mode.
2525

26-
## 1. Time Series Data Model
26+
## 1. Time Series Data Mode
2727

28-
Before designing an IoTDB data model, it's essential to understand time series data and its underlying structure. For more details, refer to: [Time Series Data Model](../Background-knowledge/Navigating_Time_Series_Data.md)
28+
Before designing an IoTDB data mode, it's essential to understand time series data and its underlying structure. For more details, refer to: [Time Series Data Mode](../Background-knowledge/Navigating_Time_Series_Data.md)
2929

30-
## 2. Two Time Series Model in IoTDB
30+
## 2. Two Time Series Mode in IoTDB
3131

32-
IoTDB offers two data modeling syntaxes—tree model and table model, each with its distinct characteristics as follows:
32+
IoTDB offers two data mode syntaxes—tree mode and table mode, each with its distinct characteristics as follows:
3333

34-
**Tree Model**: It manages data points as objects, with each data point corresponding to a time series. The data point names, segmented by dots, form a tree-like directory structure that corresponds one-to-one with the physical world, making the read and write operations on data points straightforward and intuitive.
34+
**Tree Mode**: It manages data points as objects, with each data point corresponding to a time series. The data point names, segmented by dots, form a tree-like directory structure that corresponds one-to-one with the physical world, making the read and write operations on data points straightforward and intuitive.
3535

36-
**Table Model**: It is recommended to create a table for each type of device. The collection of physical quantities from devices of the same type shares certain commonalities (such as the collection of temperature and humidity physical quantities), allowing for flexible and rich data analysis.
36+
**Table Mode**: It is recommended to create a table for each type of device. The collection of physical quantities from devices of the same type shares certain commonalities (such as the collection of temperature and humidity physical quantities), allowing for flexible and rich data analysis.
3737

38-
### 2.1 Model Characteristics
38+
### 2.1 Mode Characteristics
3939

40-
Both model syntaxes have their own applicable scenarios.
40+
Both mode syntaxes have their own applicable scenarios.
4141

42-
The following table compares the tree model and the table model from various dimensions, including applicable scenarios and typical operations. Users can choose the appropriate model based on their specific usage requirements to achieve efficient data storage and management.
42+
The following table compares the tree mode and the table mode from various dimensions, including applicable scenarios and typical operations. Users can choose the appropriate mode based on their specific usage requirements to achieve efficient data storage and management.
4343

4444
<table style="text-align: center;">
4545
<tr>
4646
<td>Dimension</td>
47-
<td>Tree Model</td>
48-
<td>Table Model</td>
47+
<td>Tree Mode</td>
48+
<td>Table Mode</td>
4949
</tr>
5050
<tr>
5151
<td>Applicable Scenarios</td>
@@ -75,20 +75,20 @@ The following table compares the tree model and the table model from various dim
7575

7676
**Notes:**
7777

78-
- Both model spaces can coexist within the same cluster instance. Each model follows distinct syntax and database naming conventions, and they remain isolated by default.
78+
- Both mode spaces can coexist within the same cluster instance. Each mode follows distinct syntax and database naming conventions, and they remain isolated by default.
7979

80-
- When establishing a database connection via client tools (Cli) or SDKs, specify the model syntax using the `sql_dialect` parameter (Tree syntax is used by default).
80+
- When establishing a database connection via client tools (Cli) or SDKs, specify the mode syntax using the `sql_dialect` parameter (Tree syntax is used by default).
8181

8282

8383
## 3. Application Scenarios
8484

8585
The application scenarios mainly include two categories:
8686

87-
- Scenario 1: Using the tree model for data reading and writing.
87+
- Scenario 1: Using the tree mode for data reading and writing.
8888

89-
- Scenario 2: Using the table model for data reading and writing.
89+
- Scenario 2: Using the table mode for data reading and writing.
9090

91-
### 3.1 Scenario 1: Tree Model
91+
### 3.1 Scenario 1: Tree Mode
9292

9393
#### 3.1.1 Characteristics
9494

@@ -106,38 +106,38 @@ The application scenarios mainly include two categories:
106106
| **Time Series (Data Point)** | **Definition**:<br>A path prefixed with the database path, segmented by `.`, and can contain any number of levels, such as `root.db.turbine.device1.metric1`.<br>Each time series can have different data types.<br>**Naming Recommendation**:<br>Only include unique identifiers (similar to a composite primary key) in the path, generally not exceeding 10 levels.<br>Typically, place tags with low cardinality (fewer distinct values) at the front to facilitate system compression of common prefixes.<br>**Quantity Recommendation**:<br>The total number of time series manageable by the cluster is related to total memory; refer to the resource recommendation section.<br>There is no limit to the number of child nodes at any level.<br>**Creation Method**: Can be created manually or automatically during data writing. |
107107
| **Device** | **Definition**: The second-to-last level is the device, such as `device1` in `root.db.turbine.device1.metric1`.<br>**Creation Method**: Cannot create a device alone; it exists as time series are created. |
108108

109-
#### 3.1.3 Modeling Examples
109+
#### 3.1.3 Mode Examples
110110

111-
##### 3.1.3.1 How to model when managing multiple types of devices?
111+
##### 3.1.3.1 How to mode when managing multiple types of devices?
112112

113113
- If different types of devices in the scenario have different hierarchical paths and data point sets, create branches under the database node by device type. Each device type can have a different data point structure.
114114

115115
<div style="text-align: center;">
116116
<img src="/img/data-model-new-1-en.png" alt="" style="width: 70%;"/>
117117
</div>
118118

119-
##### 3.1.3.2 How to model when there are no devices, only data points?
119+
##### 3.1.3.2 How to mode when there are no devices, only data points?
120120

121121
- For example, in a monitoring system for a station, each data point has a unique number but does not correspond to any specific device.
122122

123123
<div style="text-align: center;">
124124
<img src="/img/Data-model-en02.png" alt="" style="width: 70%;"/>
125125
</div>
126126

127-
##### 3.1.3.3 How to model when a device has both sub-devices and data points?
127+
##### 3.1.3.3 How to mode when a device has both sub-devices and data points?
128128

129-
- For example, in an energy storage scenario, each layer of the structure monitors its voltage and current. The following modeling approach can be used.
129+
- For example, in an energy storage scenario, each layer of the structure monitors its voltage and current. The following mode approach can be used.
130130

131131
<div style="text-align: center;">
132132
<img src="/img/Data-model-en03.png" alt="" style="width: 70%;"/>
133133
</div>
134134

135135

136-
### 3.2 Scenario 2: Table Model
136+
### 3.2 Scenario 2: Table Mode
137137

138138
#### 3.2.1 Characteristics
139139

140-
- Models and manages device time series data using time series tables, facilitating analysis with standard SQL.
140+
- Modes and manages device time series data using time series tables, facilitating analysis with standard SQL.
141141

142142
- Suitable for device data analysis or migrating data from other databases to IoTDB.
143143

@@ -156,9 +156,9 @@ The application scenarios mainly include two categories:
156156

157157
**Data Filtering Efficiency**: Time Column = Tag Column > Attribute Column > Data Point Column.
158158

159-
#### 3.2.3 Modeling Examples
159+
#### 3.2.3 Mode Examples
160160

161-
##### 3.2.3.1 How to model when managing multiple types of devices?
161+
##### 3.2.3.1 How to mode when managing multiple types of devices?
162162

163163
- Recommended to create a table for each type of device, with each table having different tags and data point sets.
164164

@@ -168,15 +168,15 @@ The application scenarios mainly include two categories:
168168
<img src="/img/data-model-new-2-en.png" alt="" style="width: 70%;"/>
169169
</div>
170170

171-
##### 3.2.3.2 How to model when there are no device identifier columns or attribute columns?
171+
##### 3.2.3.2 How to mode when there are no device identifier columns or attribute columns?
172172

173173
- There is no limit to the number of columns; it can reach hundreds of thousands.
174174

175175
<div style="text-align: center;">
176176
<img src="/img/Data-model-en05.png" alt="" style="width: 70%;"/>
177177
</div>
178178

179-
##### 3.2.3.3 How to model when a device has both sub-devices and data points?
179+
##### 3.2.3.3 How to mode when a device has both sub-devices and data points?
180180

181181
- Each device has multiple sub-devices and data point information. It is recommended to create a table for each type of device for management.
182182

0 commit comments

Comments
 (0)