Skip to content

Commit e7074e2

Browse files
authored
Fix document fragmentation issue (#423)
* Fix document fragmentation issue * Revise the 404 issue
1 parent 14295b8 commit e7074e2

File tree

19 files changed

+301
-161
lines changed

19 files changed

+301
-161
lines changed

src/UserGuide/Master/Basic-Concept/Cluster-data-partitioning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The time partitioning algorithm converts a given timestamp to the corresponding
4545

4646
$$\left\lfloor\frac{\text{Timestamp}-\text{StartTimestamp}}{\text{TimePartitionInterval}}\right\rfloor.$$
4747

48-
In this equation, both $\text{StartTimestamp}$ and $\text{TimePartitionInterval}$ are configurable parameters to accommodate various production environments. The $\text{StartTimestamp}$ represents the starting time of the first time partition, while the $\text{TimePartitionInterval}$ defines the duration of each time partition. By default, the $\text{TimePartitionInterval}$ is set to one day.
48+
In this equation, both $\text{StartTimestamp}$ and $\text{TimePartitionInterval}$ are configurable parameters to accommodate various production environments. The $\text{StartTimestamp}$ represents the starting time of the first time partition, while the $\text{TimePartitionInterval}$ defines the duration of each time partition. By default, the $\text{TimePartitionInterval}$ is set to seven day.
4949

5050
#### Schema Partitioning
5151
Since the series partitioning algorithm evenly partitions the time series, each series partition corresponds to a schema partition. These schema partitions are then evenly allocated across the SchemaRegionGroups to achieve a balanced schema distribution.

src/UserGuide/Master/Reference/UDF-Libraries.md

Lines changed: 80 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct
3434
| UDF-1.3.3.zip | V1.3.3 and above | [UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.3.zip) |
3535
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | [UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.2.zip) |
3636

37-
2. Place the library-udf.jar file in the compressed file obtained in the directory `/ext/udf ` of all nodes in the IoTDB cluster
37+
2. Place the `library-udf.jar` file in the compressed file obtained in the directory `/ext/udf ` of all nodes in the IoTDB cluster
3838
3. In the SQL command line terminal (CLI) or visualization console (Workbench) SQL operation interface of IoTDB, execute the corresponding function registration statement as follows.
3939
4. Batch registration: Two registration methods: registration script or SQL full statement
4040
- Register Script
41-
- Copy the registration script (register-UDF.sh or register-UDF.bat) from the compressed package to the `tools` directory of IoTDB as needed, and modify the parameters in the script (default is host=127.0.0.1, rpcPort=6667, user=root, pass=root);
41+
- Copy the registration script (`register-UDF.sh` or `register-UDF.bat`) from the compressed package to the `tools` directory of IoTDB as needed, and modify the parameters in the script (default is host=127.0.0.1, rpcPort=6667, user=root, pass=root);
4242
- Start IoTDB service, run registration script to batch register UDF
4343

4444
- All SQL statements
@@ -3934,26 +3934,86 @@ Output series:
39343934

39353935
Note: The input is $y=sin(2\pi t/4)+2sin(2\pi t/5)$ with a length of 20. Thus, the output is $y=2sin(2\pi t/5)$ after low-pass filtering.
39363936

3937-
<!--
39383937

3939-
​ Licensed to the Apache Software Foundation (ASF) under one
3940-
​ or more contributor license agreements. See the NOTICE file
3941-
​ distributed with this work for additional information
3942-
​ regarding copyright ownership. The ASF licenses this file
3943-
​ to you under the Apache License, Version 2.0 (the
3944-
​ "License"); you may not use this file except in compliance
3945-
​ with the License. You may obtain a copy of the License at
3946-
3947-
​ http://www.apache.org/licenses/LICENSE-2.0
3948-
3949-
​ Unless required by applicable law or agreed to in writing,
3950-
​ software distributed under the License is distributed on an
3951-
​ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
3952-
​ KIND, either express or implied. See the License for the
3953-
​ specific language governing permissions and limitations
3954-
​ under the License.
3938+
### Envelope
3939+
3940+
#### Registration statement
3941+
3942+
```sql
3943+
create function envelope as 'org.apache.iotdb.library.frequency.UDFEnvelopeAnalysis'
3944+
```
3945+
3946+
#### Usage
3947+
3948+
This function achieves signal demodulation and envelope extraction by inputting a one-dimensional floating-point array and a user specified modulation frequency. The goal of demodulation is to extract the parts of interest from complex signals, making them easier to understand. For example, demodulation can be used to find the envelope of the signal, that is, the trend of amplitude changes.
3949+
3950+
**Name:** Envelope
3951+
3952+
**Input:** Only supports a single input sequence, with types INT32/INT64/FLOAT/DOUBLE
3953+
3954+
3955+
**Parameters:**
3956+
3957+
+ `frequency`: Frequency (optional, positive number. If this parameter is not filled in, the system will infer the frequency based on the time interval corresponding to the sequence).
3958+
+ `amplification`: Amplification factor (optional, positive integer. The output of the Time column is a set of positive integers and does not output decimals. When the frequency is less than 1, this parameter can be used to amplify the frequency to display normal results).
3959+
3960+
**Output:**
3961+
+ `Time`: The meaning of the value returned by this column is frequency rather than time. If the output format is time format (e.g. 1970-01-01T08:00: 19.000+08:00), please convert it to a timestamp value.
3962+
3963+
3964+
+ `Envelope(Path, 'frequency'='{frequency}')`:Output a single sequence of type DOUBLE, which is the result of envelope analysis.
3965+
3966+
**Note:** When the values of the demodulated original sequence are discontinuous, this function will treat it as continuous processing. It is recommended that the analyzed time series be a complete time series of values. It is also recommended to specify a start time and an end time.
3967+
3968+
#### Examples
3969+
3970+
Input series:
3971+
3972+
3973+
```
3974+
+-----------------------------+---------------+
3975+
| Time|root.test.d1.s1|
3976+
+-----------------------------+---------------+
3977+
|1970-01-01T08:00:01.000+08:00| 1.0 |
3978+
|1970-01-01T08:00:02.000+08:00| 2.0 |
3979+
|1970-01-01T08:00:03.000+08:00| 3.0 |
3980+
|1970-01-01T08:00:04.000+08:00| 4.0 |
3981+
|1970-01-01T08:00:05.000+08:00| 5.0 |
3982+
|1970-01-01T08:00:06.000+08:00| 6.0 |
3983+
|1970-01-01T08:00:07.000+08:00| 7.0 |
3984+
|1970-01-01T08:00:08.000+08:00| 8.0 |
3985+
|1970-01-01T08:00:09.000+08:00| 9.0 |
3986+
|1970-01-01T08:00:10.000+08:00| 10.0 |
3987+
+-----------------------------+---------------+
3988+
```
3989+
3990+
SQL for query:
3991+
3992+
```sql
3993+
set time_display_type=long;
3994+
select envelope(s1),envelope(s1,'frequency'='1000'),envelope(s1,'amplification'='10') from root.test.d1;
3995+
```
3996+
3997+
Output series:
3998+
3999+
4000+
```
4001+
+----+-------------------------+---------------------------------------------+-----------------------------------------------+
4002+
|Time|envelope(root.test.d1.s1)|envelope(root.test.d1.s1, "frequency"="1000")|envelope(root.test.d1.s1, "amplification"="10")|
4003+
+----+-------------------------+---------------------------------------------+-----------------------------------------------+
4004+
| 0| 6.284350808484124| 6.284350808484124| 6.284350808484124|
4005+
| 100| 1.5581923657404393| 1.5581923657404393| null|
4006+
| 200| 0.8503211038340728| 0.8503211038340728| null|
4007+
| 300| 0.512808785945551| 0.512808785945551| null|
4008+
| 400| 0.26361156774506744| 0.26361156774506744| null|
4009+
|1000| null| null| 1.5581923657404393|
4010+
|2000| null| null| 0.8503211038340728|
4011+
|3000| null| null| 0.512808785945551|
4012+
|4000| null| null| 0.26361156774506744|
4013+
+----+-------------------------+---------------------------------------------+-----------------------------------------------+
4014+
4015+
```
39554016

3956-
-->
39574017

39584018
## Data Matching
39594019

src/UserGuide/Master/SQL-Manual/SQL-Manual.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ IoTDB > select * from root.sg1.d1
444444

445445
### Load External TsFile Tool
446446

447-
For more details, see document [Import-Export-Tool](../Tools-System/TsFile-Import-Export-Tool.md).
447+
For more details, see document [Data Import](../Tools-System/Data-Import-Tool.md).
448448

449449
#### Load with SQL
450450

src/UserGuide/Master/User-Manual/Write-Delete-Data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,11 +185,11 @@ In different scenarios, the IoTDB provides a variety of methods for importing da
185185

186186
### TsFile Batch Load
187187

188-
TsFile is the file format of time series used in IoTDB. You can directly import one or more TsFile files with time series into another running IoTDB instance through tools such as CLI. For details, see [Import-Export-Tool](../Tools-System/TsFile-Import-Export-Tool.md).
188+
TsFile is the file format of time series used in IoTDB. You can directly import one or more TsFile files with time series into another running IoTDB instance through tools such as CLI. For details, see [Data Import](../Tools-System/Data-Import-Tool.md).
189189

190190
### CSV Batch Load
191191

192-
CSV stores table data in plain text. You can write multiple formatted data into a CSV file and import the data into the IoTDB in batches. Before importing data, you are advised to create the corresponding metadata in the IoTDB. Don't worry if you forget to create one, the IoTDB can automatically infer the data in the CSV to its corresponding data type, as long as you have a unique data type for each column. In addition to a single file, the tool supports importing multiple CSV files as folders and setting optimization parameters such as time precision. For details, see [Import-Export-Tool](../Tools-System/Data-Import-Export-Tool.md).
192+
CSV stores table data in plain text. You can write multiple formatted data into a CSV file and import the data into the IoTDB in batches. Before importing data, you are advised to create the corresponding metadata in the IoTDB. Don't worry if you forget to create one, the IoTDB can automatically infer the data in the CSV to its corresponding data type, as long as you have a unique data type for each column. In addition to a single file, the tool supports importing multiple CSV files as folders and setting optimization parameters such as time precision. For details, see [Data Import](../Tools-System/Data-Import-Tool.md).
193193

194194
## DELETE
195195

src/UserGuide/V1.2.x/QuickStart/QuickStart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Configuration files are located in the `conf` folder
5151
* system config module (`iotdb-datanode.properties`)
5252
* log config module (`logback.xml`).
5353

54-
For more information, please go to [Config](../stage/DataNode-Config-Manual.md).
54+
For more information, please go to [Config](../Reference/DataNode-Config-Manual.md).
5555

5656
## Start
5757

@@ -244,7 +244,7 @@ The server can be stopped using `ctrl-C` or by running the following script:
244244
```
245245
Note: In Linux, please add the `sudo` as far as possible, or else the stopping process may fail. <!-- TODO: Actually running things as `root` is considered a bad practice from security perspective. Is there a reson for requiring root? I don't think we're using any privileged ports or resources. -->
246246

247-
More explanations on running IoTDB in a clustered environment are available at [Cluster-Setup](../stage/Cluster/Cluster-Setup.md).
247+
More explanations on running IoTDB in a clustered environment are available at [Cluster-Setup](../Deployment-and-Maintenance/Deployment-Guide_timecho.md).
248248

249249
### Administration
250250

src/UserGuide/V1.3.0-2/Basic-Concept/Cluster-data-partitioning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The time partitioning algorithm converts a given timestamp to the corresponding
4545

4646
$$\left\lfloor\frac{\text{Timestamp}-\text{StartTimestamp}}{\text{TimePartitionInterval}}\right\rfloor.$$
4747

48-
In this equation, both $\text{StartTimestamp}$ and $\text{TimePartitionInterval}$ are configurable parameters to accommodate various production environments. The $\text{StartTimestamp}$ represents the starting time of the first time partition, while the $\text{TimePartitionInterval}$ defines the duration of each time partition. By default, the $\text{TimePartitionInterval}$ is set to one day.
48+
In this equation, both $\text{StartTimestamp}$ and $\text{TimePartitionInterval}$ are configurable parameters to accommodate various production environments. The $\text{StartTimestamp}$ represents the starting time of the first time partition, while the $\text{TimePartitionInterval}$ defines the duration of each time partition. By default, the $\text{TimePartitionInterval}$ is set to seven day.
4949

5050
#### Schema Partitioning
5151
Since the series partitioning algorithm evenly partitions the time series, each series partition corresponds to a schema partition. These schema partitions are then evenly allocated across the SchemaRegionGroups to achieve a balanced schema distribution.

src/UserGuide/V1.3.0-2/Reference/UDF-Libraries.md

Lines changed: 80 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct
3232
| UDF-1.3.3.zip | V1.3.3 and above | [UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.3.zip) |
3333
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | [UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.2.zip) |
3434

35-
2. Place the library-udf.jar file in the compressed file obtained in the directory `/ext/udf ` of all nodes in the IoTDB cluster
35+
2. Place the `library-udf.jar` file in the compressed file obtained in the directory `/ext/udf ` of all nodes in the IoTDB cluster
3636
3. In the SQL command line terminal (CLI) or visualization console (Workbench) SQL operation interface of IoTDB, execute the corresponding function registration statement as follows.
3737
4. Batch registration: Two registration methods: registration script or SQL full statement
3838
- Register Script
39-
- Copy the registration script (register-UDF.sh or register-UDF.bat) from the compressed package to the `tools` directory of IoTDB as needed, and modify the parameters in the script (default is host=127.0.0.1, rpcPort=6667, user=root, pass=root);
39+
- Copy the registration script (`register-UDF.sh` or `register-UDF.bat`) from the compressed package to the `tools` directory of IoTDB as needed, and modify the parameters in the script (default is host=127.0.0.1, rpcPort=6667, user=root, pass=root);
4040
- Start IoTDB service, run registration script to batch register UDF
4141

4242
- All SQL statements
@@ -3933,26 +3933,86 @@ Output series:
39333933

39343934
Note: The input is $y=sin(2\pi t/4)+2sin(2\pi t/5)$ with a length of 20. Thus, the output is $y=2sin(2\pi t/5)$ after low-pass filtering.
39353935

3936-
<!--
39373936

3938-
​ Licensed to the Apache Software Foundation (ASF) under one
3939-
​ or more contributor license agreements. See the NOTICE file
3940-
​ distributed with this work for additional information
3941-
​ regarding copyright ownership. The ASF licenses this file
3942-
​ to you under the Apache License, Version 2.0 (the
3943-
​ "License"); you may not use this file except in compliance
3944-
​ with the License. You may obtain a copy of the License at
3945-
3946-
​ http://www.apache.org/licenses/LICENSE-2.0
3947-
3948-
​ Unless required by applicable law or agreed to in writing,
3949-
​ software distributed under the License is distributed on an
3950-
​ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
3951-
​ KIND, either express or implied. See the License for the
3952-
​ specific language governing permissions and limitations
3953-
​ under the License.
3937+
### Envelope
3938+
3939+
#### Registration statement
3940+
3941+
```sql
3942+
create function envelope as 'org.apache.iotdb.library.frequency.UDFEnvelopeAnalysis'
3943+
```
3944+
3945+
#### Usage
3946+
3947+
This function achieves signal demodulation and envelope extraction by inputting a one-dimensional floating-point array and a user specified modulation frequency. The goal of demodulation is to extract the parts of interest from complex signals, making them easier to understand. For example, demodulation can be used to find the envelope of the signal, that is, the trend of amplitude changes.
3948+
3949+
**Name:** Envelope
3950+
3951+
**Input:** Only supports a single input sequence, with types INT32/INT64/FLOAT/DOUBLE
3952+
3953+
3954+
**Parameters:**
3955+
3956+
+ `frequency`: Frequency (optional, positive number. If this parameter is not filled in, the system will infer the frequency based on the time interval corresponding to the sequence).
3957+
+ `amplification`: Amplification factor (optional, positive integer. The output of the Time column is a set of positive integers and does not output decimals. When the frequency is less than 1, this parameter can be used to amplify the frequency to display normal results).
3958+
3959+
**Output:**
3960+
+ `Time`: The meaning of the value returned by this column is frequency rather than time. If the output format is time format (e.g. 1970-01-01T08:00: 19.000+08:00), please convert it to a timestamp value.
3961+
3962+
3963+
+ `Envelope(Path, 'frequency'='{frequency}')`:Output a single sequence of type DOUBLE, which is the result of envelope analysis.
3964+
3965+
**Note:** When the values of the demodulated original sequence are discontinuous, this function will treat it as continuous processing. It is recommended that the analyzed time series be a complete time series of values. It is also recommended to specify a start time and an end time.
3966+
3967+
#### Examples
3968+
3969+
Input series:
3970+
3971+
3972+
```
3973+
+-----------------------------+---------------+
3974+
| Time|root.test.d1.s1|
3975+
+-----------------------------+---------------+
3976+
|1970-01-01T08:00:01.000+08:00| 1.0 |
3977+
|1970-01-01T08:00:02.000+08:00| 2.0 |
3978+
|1970-01-01T08:00:03.000+08:00| 3.0 |
3979+
|1970-01-01T08:00:04.000+08:00| 4.0 |
3980+
|1970-01-01T08:00:05.000+08:00| 5.0 |
3981+
|1970-01-01T08:00:06.000+08:00| 6.0 |
3982+
|1970-01-01T08:00:07.000+08:00| 7.0 |
3983+
|1970-01-01T08:00:08.000+08:00| 8.0 |
3984+
|1970-01-01T08:00:09.000+08:00| 9.0 |
3985+
|1970-01-01T08:00:10.000+08:00| 10.0 |
3986+
+-----------------------------+---------------+
3987+
```
3988+
3989+
SQL for query:
3990+
3991+
```sql
3992+
set time_display_type=long;
3993+
select envelope(s1),envelope(s1,'frequency'='1000'),envelope(s1,'amplification'='10') from root.test.d1;
3994+
```
3995+
3996+
Output series:
3997+
3998+
3999+
```
4000+
+----+-------------------------+---------------------------------------------+-----------------------------------------------+
4001+
|Time|envelope(root.test.d1.s1)|envelope(root.test.d1.s1, "frequency"="1000")|envelope(root.test.d1.s1, "amplification"="10")|
4002+
+----+-------------------------+---------------------------------------------+-----------------------------------------------+
4003+
| 0| 6.284350808484124| 6.284350808484124| 6.284350808484124|
4004+
| 100| 1.5581923657404393| 1.5581923657404393| null|
4005+
| 200| 0.8503211038340728| 0.8503211038340728| null|
4006+
| 300| 0.512808785945551| 0.512808785945551| null|
4007+
| 400| 0.26361156774506744| 0.26361156774506744| null|
4008+
|1000| null| null| 1.5581923657404393|
4009+
|2000| null| null| 0.8503211038340728|
4010+
|3000| null| null| 0.512808785945551|
4011+
|4000| null| null| 0.26361156774506744|
4012+
+----+-------------------------+---------------------------------------------+-----------------------------------------------+
4013+
4014+
```
39544015

3955-
-->
39564016

39574017
## Data Matching
39584018

0 commit comments

Comments
 (0)