Skip to content

Commit 5fbb374

Browse files
committed
Merge branch 'main' into yr_67_Add_documentation_for_the_open-source_UDF_library
2 parents f2eccb9 + 5415674 commit 5fbb374

File tree

37 files changed

+348
-179
lines changed

37 files changed

+348
-179
lines changed

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix"
1515
},
1616
"devDependencies": {
17-
"@docsearch/css": "3.6.1",
18-
"@docsearch/js": "3.6.1",
19-
"@docsearch/react": "3.6.1",
17+
"@docsearch/css": "3.8.0",
18+
"@docsearch/js": "3.8.0",
19+
"@docsearch/react": "3.8.0",
2020
"@rushstack/eslint-patch": "1.6.0",
2121
"@vue/eslint-config-airbnb-with-typescript": "^7.0.1",
2222
"@vue/repl": "4.1.1",

src/.vuepress/config.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ _paq.push(['enableLinkTracking']);
8383
apiKey: 'f1f30c0df04d74534e066d07786bce05',
8484
indexName: 'iotdb-apache',
8585
maxResultsPerGroup: 10,
86+
disableUserPersonalization: true,
8687
locales: {
8788
'/zh/': {
8889
placeholder: '搜索文档',
@@ -144,5 +145,5 @@ _paq.push(['enableLinkTracking']);
144145
},
145146
},
146147
}),
147-
pagePatterns: ['**/*.md', '!**/stage/**/*.md', '!**/Master/**/*.md', '!.vuepress', '!node_modules'],
148+
pagePatterns: ['**/*.md', '!**/*_timecho.md', '!**/stage/**/*.md', '!**/Master/**/*.md', '!.vuepress', '!node_modules'],
148149
});

src/.vuepress/sidebar/V1.3.x/en.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,6 @@ export const enSidebar = {
118118
{ text: 'Rust Native API', link: 'Programming-Rust-Native-API' },
119119
{ text: 'JDBC (Not Recommend)', link: 'Programming-JDBC' },
120120
{ text: 'MQTT Protocol', link: 'Programming-MQTT' },
121-
{ text: 'OPC UA Protocol', link: 'Programming-OPC-UA' },
122121
{ text: 'Kafka', link: 'Programming-Kafka' },
123122
{ text: 'REST API V1 (Not Recommend)', link: 'RestServiceV1' },
124123
{ text: 'REST API V2', link: 'RestServiceV2' },

src/.vuepress/sidebar/V1.3.x/zh.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,6 @@ export const zhSidebar = {
119119
{ text: 'Rust原生接口', link: 'Programming-Rust-Native-API' },
120120
{ text: 'JDBC (不推荐)', link: 'Programming-JDBC' },
121121
{ text: 'MQTT协议', link: 'Programming-MQTT' },
122-
{ text: 'OPC UA协议', link: 'Programming-OPC-UA' },
123122
{ text: 'Kafka', link: 'Programming-Kafka' },
124123
{ text: 'REST API V1 (不推荐)', link: 'RestServiceV1' },
125124
{ text: 'REST API V2', link: 'RestServiceV2' },

src/.vuepress/sidebar_timecho/V1.3.x/en.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ export const enSidebar = {
127127
{ text: 'Rust Native API', link: 'Programming-Rust-Native-API' },
128128
{ text: 'JDBC (Not Recommend)', link: 'Programming-JDBC' },
129129
{ text: 'MQTT Protocol', link: 'Programming-MQTT' },
130-
{ text: 'OPC UA Protocol', link: 'Programming-OPC-UA' },
130+
{ text: 'OPC UA Protocol', link: 'Programming-OPC-UA_timecho' },
131131
{ text: 'Kafka', link: 'Programming-Kafka' },
132132
{ text: 'REST API V1 (Not Recommend)', link: 'RestServiceV1' },
133133
{ text: 'REST API V2', link: 'RestServiceV2' },

src/.vuepress/sidebar_timecho/V1.3.x/zh.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ export const zhSidebar = {
127127
{ text: 'Rust', link: 'Programming-Rust-Native-API' },
128128
{ text: 'JDBC (不推荐)', link: 'Programming-JDBC' },
129129
{ text: 'MQTT协议', link: 'Programming-MQTT' },
130-
{ text: 'OPC UA协议', link: 'Programming-OPC-UA' },
130+
{ text: 'OPC UA协议', link: 'Programming-OPC-UA_timecho' },
131131
{ text: 'Kafka', link: 'Programming-Kafka' },
132132
{ text: 'REST API V1 (不推荐)', link: 'RestServiceV1' },
133133
{ text: 'REST API V2', link: 'RestServiceV2' },

src/Download/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,31 @@
2828
<th colspan="3">IoTDB Sources</th>
2929
<th>release notes</th>
3030
</tr>
31+
<tr>
32+
<td rowspan="2">1.3.3</td>
33+
<td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.3/apache-iotdb-1.3.3-all-bin.zip">All-in-one</a></td>
34+
<td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.3/apache-iotdb-1.3.3-all-bin.zip.sha512">SHA512</a></td>
35+
<td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.3/apache-iotdb-1.3.3-all-bin.zip.asc">ASC</a></td>
36+
<td rowspan="2"><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.3/apache-iotdb-1.3.3-source-release.zip">Sources</a></td>
37+
<td rowspan="2"><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.3/apache-iotdb-1.3.3-source-release.zip.sha512">SHA512</a></td>
38+
<td rowspan="2"><a href="https://www.apache.org/dyn/closer.cgi/1.3.3/apache-iotdb-1.3.3-source-release.zip.asc">ASC</a></td>
39+
<td rowspan="2"><a href="https://dlcdn.apache.org/iotdb/1.3.3/RELEASE_NOTES.md">release notes</a></td>
40+
</tr>
41+
<tr>
42+
<td><a href="https://archive.apache.org/dist/iotdb/1.3.3/apache-iotdb-1.3.3-ainode-bin.zip">AINode</a></td>
43+
<td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.3/apache-iotdb-1.3.3-ainode-bin.zip.sha512">SHA512</a></td>
44+
<td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.3/apache-iotdb-1.3.3-ainode-bin.zip.asc">ASC</a></td>
45+
</tr>
3146
<tr>
3247
<td rowspan="1">1.3.2</td>
3348
<td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.2/apache-iotdb-1.3.2-all-bin.zip">All-in-one</a></td>
3449
<td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.2/apache-iotdb-1.3.2-all-bin.zip.sha512">SHA512</a></td>
35-
<td><a href="https://www.apache.org/dyn/closer.cgi/1.3.2/apache-iotdb-1.3.2-all-bin.zip.asc">ASC</a></td>
50+
<td><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.2/apache-iotdb-1.3.2-all-bin.zip.asc">ASC</a></td>
3651
<td rowspan="1"><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.2/apache-iotdb-1.3.2-source-release.zip">Sources</a></td>
3752
<td rowspan="1"><a href="https://www.apache.org/dyn/closer.cgi/iotdb/1.3.2/apache-iotdb-1.3.2-source-release.zip.sha512">SHA512</a></td>
3853
<td rowspan="1"><a href="https://www.apache.org/dyn/closer.cgi/1.3.2/apache-iotdb-1.3.2-source-release.zip.asc">ASC</a></td>
3954
<td rowspan="1"><a href="https://raw.githubusercontent.com/apache/iotdb/rc/1.3.2/RELEASE_NOTES.md">release notes</a></td>
40-
</tr>
55+
</tr>
4156
<tr>
4257
<td rowspan="3">0.13.4</td>
4358
<td><a href="https://dlcdn.apache.org/iotdb/0.13.4/apache-iotdb-0.13.4-all-bin.zip">All-in-one</a></td>
File renamed without changes.

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_timecho.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

0 commit comments

Comments
 (0)