Skip to content

Enhance doc content for Data-Model.md #499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/src/UserGuide/develop/QuickStart/Data-Model.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
To manage industrial IoT time series data, the data model of TsFile includes the following concepts

- Tag: The description of an IoT device of one dimension in the form of a string key-value pair. For example, "category=XT451" describes the category of a wind turbine is "XT451" and "year=2021" says it is built in the year 2021.
- Field: A variable that is being measured by a device. Like fan speed, voltage, temperature, wind speed, and so on. Unlike a Tagthat is currently fixed to STRING data type, Fields are supported by various data types.
- Field: A variable that is being measured by a device. Like fan speed, voltage, temperature, wind speed, and so on. Unlike a Tag that is currently fixed to STRING data type, Fields are supported by various data types.
- Timestamp and Timeseries: Each value of a FIELD measured by a device is associated with a unique timestamp. The sequence of the timestamps and values of a FIELD is a Timeseries.
- Schema: A set of Tags that can uniquely identify a kind of device, and the set of Fields that are measured by these devices. E.g., a wind turbine can be uniquely located by "Province," "City," "WindField," and "SerialNumber," so the TAG set of SCHEMA "wind_turbine" can be "Province," "City," "WindField," and "SerialNumber." While its the FIELD set contains "FanSpeed," "Voltage," "Temperature," "WindSpeed," and so on.
- Schema: A set of Tags that can uniquely identify a kind of device, and the set of Fields that are measured by these devices. E.g., a wind turbine can be uniquely located by "Province," "City," "WindField," and "SerialNumber," so the TAG set of SCHEMA "wind_turbine" can be "Province," "City," "WindField," and "SerialNumber." While the FIELD set contains "FanSpeed," "Voltage," "Temperature," "WindSpeed," and so on.
- DeviceId: The unique identifier of an IoT device, which consists of the schema name and all tag values. For example, for the Schema "wind_turbine" above, a DeviceId can be ("wind_turbine", "Beijing", "Beijing", "Field_1135", "T1523678").


Expand All @@ -38,15 +38,15 @@ To manage industrial IoT time series data, the data model of TsFile includes the
</tr>
<tr>
<th rowspan="1">table</th>
<th>A collection of devices with the same pattern.The storage table defined during modeling consists of three parts: identification column, time column, and physical quantity column.</th>
<th>A collection of devices with the same pattern. The storage table defined during modeling consists of three parts: identification column, time column, and physical quantity column.</th>
</tr>
<tr>
<th rowspan="1">TAG</th>
<th>The unique identifier of a device, which can contain 0 to multiple tag columns in a table. The composite value formed by combining the values of the tag columns in the column order when the table was created is called the identifier, and tags with the same composite value are called the same identifier.The data type of the tag column can currently only be String, which can be left unspecified and defaults to StringThe values of the identification column can all be emptyWhen writing, all tag columns must be specified (unspecified identity columns are filled with null by default)</th>
<th>The unique identifier of a device, which can contain 0 to multiple tag columns in a table. The composite value formed by combining the values of the tag columns in the column order when the table was created is called the identifier, and tags with the same composite value are called the same identifier. The data type of the tag column can currently only be STRING, which can be left unspecified and defaults to STRING. The values of the identification column can all be empty. When writing, all tag columns must be specified (unspecified identity columns are filled with null by default)</th>
</tr>
<tr>
<th rowspan="1">Time</th>
<th>A table must have a time column, and data with the same identifier value is sorted by time by default.The values in the time column cannot be empty and must be in sequence.</th>
<th>A table must have a time column, and data with the same identifier value is sorted by time by default. The values in the time column cannot be empty and must be in sequence.</th>
</tr>
<tr>
<th rowspan="1">FIELD</th>
Expand All @@ -61,7 +61,7 @@ To manage industrial IoT time series data, the data model of TsFile includes the

## Example

A schema describes is a collection of devices with the same pattern. As shown in the figure below, it models the management of factory equipment, and the physical variable collection of each device has certain commonalities (such as collecting temperature and humidity physical quantities, collecting physical quantities of the same device on the same frequency, etc.), so it can be managed on a device-by-device basis.
A schema describes a collection of devices with the same pattern. As shown in the figure below, it models the management of factory equipment, and the physical variable collection of each device has certain commonalities (such as collecting temperature and humidity physical quantities, collecting physical quantities of the same device on the same frequency, etc.), so it can be managed on a device-by-device basis.

At this point, a physical device can be uniquely identified through 3 Tags [Region] - [Factory] - [Equipment] (orange column in the figure below, also known as device identification information). The Fields collected by the device are [Temperature], [Humidity], [Status], and [Arrival Time] (blue column in the figure below).

Expand Down
2 changes: 1 addition & 1 deletion docs/src/zh/UserGuide/develop/QuickStart/Data-Model.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
</tr>
<tr>
<th rowspan="1">标识列</th>
<th>设备唯一标识,一个表内可包含0至多个标识列,标识列的值按建表时的列顺序组合形成的复合值称为标识,复合值相同的标识为同一标识。标识列的数据类型目前只能为String,可以不指定,默认为String标识列的值可以全为空写入时必须指定所有标识列(未指定的标识列默认使用 null 填充)</th>
<th>设备唯一标识,一个表内可包含0至多个标识列,标识列的值按建表时的列顺序组合形成的复合值称为标识,复合值相同的标识为同一标识。标识列的数据类型目前只能为STRING,可以不指定,默认为STRING标识列的值可以全为空写入时必须指定所有标识列(未指定的标识列默认使用 null 填充)</th>
</tr>
<tr>
<th rowspan="1">时间戳</th>
Expand Down