This is an automated email from the ASF dual-hosted git repository.
leirui pushed a commit to branch rl
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/rl by this push:
new 2333b40 rename data-concept into basic-concept
2333b40 is described below
commit 2333b405bba09e9d6a1b739d93d1f601dfad3b6e
Author: Lei Rui <1010953...@qq.com>
AuthorDate: Tue Jul 25 20:51:59 2023 +0800
rename data-concept into basic-concept
---
.../Administration-Management/Administration.md | 2 +-
.../{Data-Concept => Basic-Concept}/Compression.md | 0
.../Data-Model-and-Terminology.md | 0
.../{Data-Concept => Basic-Concept}/Data-Type.md | 2 +-
.../Deadband-Process.md | 0
.../Encoding-and-Compression.md} | 30 ++++++++++++++++++++++
.../Schema-Template.md | 0
.../Time-Partition.md | 0
.../{Data-Concept => Basic-Concept}/Time-zone.md | 0
src/UserGuide/Master/Delete-Data/Delete-Data.md | 2 +-
.../Operate-Metadata/Auto-Create-MetaData.md | 2 +-
.../Master/Operate-Metadata/Timeseries.md | 2 +-
src/UserGuide/Master/Query-Data/Select-Into.md | 2 +-
src/UserGuide/Master/Query-Data/Where-Condition.md | 2 +-
.../Master/Syntax-Conventions/Literal-Values.md | 2 +-
src/UserGuide/Master/Write-Data/Write-Data.md | 2 +-
16 files changed, 39 insertions(+), 9 deletions(-)
diff --git a/src/UserGuide/Master/Administration-Management/Administration.md
b/src/UserGuide/Master/Administration-Management/Administration.md
index 2bf7d88..c963942 100644
--- a/src/UserGuide/Master/Administration-Management/Administration.md
+++ b/src/UserGuide/Master/Administration-Management/Administration.md
@@ -34,7 +34,7 @@ The user is the legal user of the database. A user
corresponds to a unique usern
### Privilege
-The database provides a variety of operations, and not all users can perform
all operations. If a user can perform an operation, the user is said to have
the privilege to perform the operation. privileges are divided into data
management privilege (such as adding, deleting and modifying data) and
authority management privilege (such as creation and deletion of users and
roles, granting and revoking of privileges, etc.). Data management privilege
often needs a path to limit its effective [...]
+The database provides a variety of operations, and not all users can perform
all operations. If a user can perform an operation, the user is said to have
the privilege to perform the operation. privileges are divided into data
management privilege (such as adding, deleting and modifying data) and
authority management privilege (such as creation and deletion of users and
roles, granting and revoking of privileges, etc.). Data management privilege
often needs a path to limit its effective [...]
### Role
diff --git a/src/UserGuide/Master/Data-Concept/Compression.md
b/src/UserGuide/Master/Basic-Concept/Compression.md
similarity index 100%
rename from src/UserGuide/Master/Data-Concept/Compression.md
rename to src/UserGuide/Master/Basic-Concept/Compression.md
diff --git a/src/UserGuide/Master/Data-Concept/Data-Model-and-Terminology.md
b/src/UserGuide/Master/Basic-Concept/Data-Model-and-Terminology.md
similarity index 100%
rename from src/UserGuide/Master/Data-Concept/Data-Model-and-Terminology.md
rename to src/UserGuide/Master/Basic-Concept/Data-Model-and-Terminology.md
diff --git a/src/UserGuide/Master/Data-Concept/Data-Type.md
b/src/UserGuide/Master/Basic-Concept/Data-Type.md
similarity index 96%
rename from src/UserGuide/Master/Data-Concept/Data-Type.md
rename to src/UserGuide/Master/Basic-Concept/Data-Type.md
index f45b601..d63d0e5 100644
--- a/src/UserGuide/Master/Data-Concept/Data-Type.md
+++ b/src/UserGuide/Master/Basic-Concept/Data-Type.md
@@ -34,7 +34,7 @@ IoTDB supports the following data types:
### Float Precision
-The time series of **FLOAT** and **DOUBLE** type can specify
(MAX\_POINT\_NUMBER, see [this page](../Reference/SQL-Reference.md) for more
information on how to specify), which is the number of digits after the decimal
point of the floating point number, if the encoding method is
[RLE](Encoding.md) or [TS\_2DIFF](Encoding.md). If MAX\_POINT\_NUMBER is not
specified, the system will use
[float\_precision](../Reference/DataNode-Config-Manual.md) in the configuration
file `iotdb-common.properties`.
+The time series of **FLOAT** and **DOUBLE** type can specify
(MAX\_POINT\_NUMBER, see [this page](../Reference/SQL-Reference.md) for more
information on how to specify), which is the number of digits after the decimal
point of the floating point number, if the encoding method is
[RLE](Encoding-and-Compression.md) or [TS\_2DIFF](Encoding-and-Compression.md).
If MAX\_POINT\_NUMBER is not specified, the system will use
[float\_precision](../Reference/DataNode-Config-Manual.md) in the config [...]
```sql
CREATE TIMESERIES root.vehicle.d0.s0 WITH DATATYPE=FLOAT, ENCODING=RLE,
'MAX_POINT_NUMBER'='2';
diff --git a/src/UserGuide/Master/Data-Concept/Deadband-Process.md
b/src/UserGuide/Master/Basic-Concept/Deadband-Process.md
similarity index 100%
rename from src/UserGuide/Master/Data-Concept/Deadband-Process.md
rename to src/UserGuide/Master/Basic-Concept/Deadband-Process.md
diff --git a/src/UserGuide/Master/Data-Concept/Encoding.md
b/src/UserGuide/Master/Basic-Concept/Encoding-and-Compression.md
similarity index 81%
rename from src/UserGuide/Master/Data-Concept/Encoding.md
rename to src/UserGuide/Master/Basic-Concept/Encoding-and-Compression.md
index b82aae3..b9dfbf4 100644
--- a/src/UserGuide/Master/Data-Concept/Encoding.md
+++ b/src/UserGuide/Master/Basic-Concept/Encoding-and-Compression.md
@@ -95,3 +95,33 @@ As shown below, the second-order difference encoding does
not support the Boolea
IoTDB> create timeseries root.ln.wf02.wt02.status WITH DATATYPE=BOOLEAN,
ENCODING=TS_2DIFF
Msg: 507: encoding TS_2DIFF does not support BOOLEAN
```
+# Compression
+
+When the time series is written and encoded as binary data according to the
specified type, IoTDB compresses the data using compression technology to
further improve space storage efficiency. Although both encoding and
compression are designed to improve storage efficiency, encoding techniques are
usually available only for specific data types (e.g., second-order differential
encoding is only suitable for INT32 or INT64 data type, and storing
floating-point numbers requires multiplying t [...]
+
+## Basic Compression Methods
+
+IoTDB allows you to specify the compression method of the column when creating
a time series, and supports the following compression methods:
+
+* UNCOMPRESSED
+
+* SNAPPY
+
+* LZ4
+
+* GZIP
+
+* ZSTD
+
+* LZMA2
+
+The specified syntax for compression is detailed in [Create Timeseries
Statement](../Reference/SQL-Reference.md).
+
+## Compression Ratio Statistics
+
+Compression ratio statistics file:
data/system/compression_ratio/Ratio-{ratio_sum}-{memtable_flush_time}
+
+* ratio_sum: sum of memtable compression ratios
+* memtable_flush_time: memtable flush times
+
+The average compression ratio can be calculated by `ratio_sum /
memtable_flush_time`
\ No newline at end of file
diff --git a/src/UserGuide/Master/Data-Concept/Schema-Template.md
b/src/UserGuide/Master/Basic-Concept/Schema-Template.md
similarity index 100%
rename from src/UserGuide/Master/Data-Concept/Schema-Template.md
rename to src/UserGuide/Master/Basic-Concept/Schema-Template.md
diff --git a/src/UserGuide/Master/Data-Concept/Time-Partition.md
b/src/UserGuide/Master/Basic-Concept/Time-Partition.md
similarity index 100%
rename from src/UserGuide/Master/Data-Concept/Time-Partition.md
rename to src/UserGuide/Master/Basic-Concept/Time-Partition.md
diff --git a/src/UserGuide/Master/Data-Concept/Time-zone.md
b/src/UserGuide/Master/Basic-Concept/Time-zone.md
similarity index 100%
rename from src/UserGuide/Master/Data-Concept/Time-zone.md
rename to src/UserGuide/Master/Basic-Concept/Time-zone.md
diff --git a/src/UserGuide/Master/Delete-Data/Delete-Data.md
b/src/UserGuide/Master/Delete-Data/Delete-Data.md
index 6b3579e..1e4a367 100644
--- a/src/UserGuide/Master/Delete-Data/Delete-Data.md
+++ b/src/UserGuide/Master/Delete-Data/Delete-Data.md
@@ -67,7 +67,7 @@ delete from root.ln.wf02.wt02.status
## Delete Multiple Timeseries
-If both the power supply status and hardware version of the ln group wf02
plant wt02 device before 2017-11-01 16:26:00 need to be deleted, [the prefix
path with broader meaning or the path with
star](../Data-Concept/Data-Model-and-Terminology.md) can be used to delete the
data. The SQL statement for this operation is:
+If both the power supply status and hardware version of the ln group wf02
plant wt02 device before 2017-11-01 16:26:00 need to be deleted, [the prefix
path with broader meaning or the path with
star](../Basic-Concept/Data-Model-and-Terminology.md) can be used to delete the
data. The SQL statement for this operation is:
```sql
delete from root.ln.wf02.wt02 where time <= 2017-11-01T16:26:00;
diff --git a/src/UserGuide/Master/Operate-Metadata/Auto-Create-MetaData.md
b/src/UserGuide/Master/Operate-Metadata/Auto-Create-MetaData.md
index 2449041..5ac9f94 100644
--- a/src/UserGuide/Master/Operate-Metadata/Auto-Create-MetaData.md
+++ b/src/UserGuide/Master/Operate-Metadata/Auto-Create-MetaData.md
@@ -109,4 +109,4 @@ Illustrated as the following figure:
* Encoding types can be configured as PLAIN, RLE, TS_2DIFF, GORILLA,
DICTIONARY.
-* The corresponding relationship between data types and encoding types is
detailed in [Encoding](../Data-Concept/Encoding.md).
\ No newline at end of file
+* The corresponding relationship between data types and encoding types is
detailed in [Encoding](../Basic-Concept/Encoding-and-Compression.md).
\ No newline at end of file
diff --git a/src/UserGuide/Master/Operate-Metadata/Timeseries.md
b/src/UserGuide/Master/Operate-Metadata/Timeseries.md
index b52a3b4..12c0b03 100644
--- a/src/UserGuide/Master/Operate-Metadata/Timeseries.md
+++ b/src/UserGuide/Master/Operate-Metadata/Timeseries.md
@@ -52,7 +52,7 @@ IoTDB > create timeseries root.ln.wf02.wt02.status WITH
DATATYPE=BOOLEAN, ENCODI
error: encoding TS_2DIFF does not support BOOLEAN
```
-Please refer to [Encoding](../Data-Concept/Encoding.md) for correspondence
between data type and encoding.
+Please refer to [Encoding](../Basic-Concept/Encoding-and-Compression.md) for
correspondence between data type and encoding.
## Create Aligned Timeseries
diff --git a/src/UserGuide/Master/Query-Data/Select-Into.md
b/src/UserGuide/Master/Query-Data/Select-Into.md
index a285afb..b39c3c1 100644
--- a/src/UserGuide/Master/Query-Data/Select-Into.md
+++ b/src/UserGuide/Master/Query-Data/Select-Into.md
@@ -269,7 +269,7 @@ This statement specifies that `root.sg_copy.d1` is an
unaligned device and `root
### Other points to note
- For general aggregation queries, the timestamp is meaningless, and the
convention is to use 0 to store.
-- When the target time-series exists, the data type of the source column and
the target time-series must be compatible. About data type compatibility, see
the document [Data Type](../Data-Concept/Data-Type.md#Data Type Compatibility).
+- When the target time-series exists, the data type of the source column and
the target time-series must be compatible. About data type compatibility, see
the document [Data Type](../Basic-Concept/Data-Type.md#Data Type Compatibility).
- When the target time series does not exist, the system automatically creates
it (including the database).
- When the queried time series does not exist, or the queried sequence does
not have data, the target time series will not be created automatically.
diff --git a/src/UserGuide/Master/Query-Data/Where-Condition.md
b/src/UserGuide/Master/Query-Data/Where-Condition.md
index 9811148..8f9fcc6 100644
--- a/src/UserGuide/Master/Query-Data/Where-Condition.md
+++ b/src/UserGuide/Master/Query-Data/Where-Condition.md
@@ -32,7 +32,7 @@ The supported operators are as follows:
## Time Filter
-Use time filters to filter data for a specific time range. For supported
formats of timestamps, please refer to
[Timestamp](../Data-Concept/Data-Type.md) .
+Use time filters to filter data for a specific time range. For supported
formats of timestamps, please refer to
[Timestamp](../Basic-Concept/Data-Type.md) .
An example is as follows:
diff --git a/src/UserGuide/Master/Syntax-Conventions/Literal-Values.md
b/src/UserGuide/Master/Syntax-Conventions/Literal-Values.md
index 48e608b..96e674b 100644
--- a/src/UserGuide/Master/Syntax-Conventions/Literal-Values.md
+++ b/src/UserGuide/Master/Syntax-Conventions/Literal-Values.md
@@ -144,7 +144,7 @@ An integer may be used in floating-point context; it is
interpreted as the equiv
## Timestamp Literals
-The timestamp is the time point at which data is produced. It includes
absolute timestamps and relative timestamps in IoTDB. For information about
timestamp support in IoTDB, see [Data Type Doc](../Data-Concept/Data-Type.md).
+The timestamp is the time point at which data is produced. It includes
absolute timestamps and relative timestamps in IoTDB. For information about
timestamp support in IoTDB, see [Data Type Doc](../Basic-Concept/Data-Type.md).
Specially, `NOW()` represents a constant timestamp that indicates the system
time at which the statement began to execute.
diff --git a/src/UserGuide/Master/Write-Data/Write-Data.md
b/src/UserGuide/Master/Write-Data/Write-Data.md
index a03c960..a8eb2f2 100644
--- a/src/UserGuide/Master/Write-Data/Write-Data.md
+++ b/src/UserGuide/Master/Write-Data/Write-Data.md
@@ -29,7 +29,7 @@ Writing a repeat timestamp covers the original timestamp
data, which can be rega
## Use of INSERT Statements
-The [INSERT SQL statement](../Reference/SQL-Reference.md) statement is used to
insert data into one or more specified timeseries created. For each point of
data inserted, it consists of a
[timestamp](../Data-Concept/Data-Model-and-Terminology.md) and a sensor
acquisition value (see [Data Type](../Data-Concept/Data-Type.md)).
+The [INSERT SQL statement](../Reference/SQL-Reference.md) statement is used to
insert data into one or more specified timeseries created. For each point of
data inserted, it consists of a
[timestamp](../Basic-Concept/Data-Model-and-Terminology.md) and a sensor
acquisition value (see [Data Type](../Basic-Concept/Data-Type.md)).
In the scenario of this section, take two timeseries
`root.ln.wf02.wt02.status` and `root.ln.wf02.wt02.hardware` as an example, and
their data types are BOOLEAN and TEXT, respectively.
