This is an automated email from the ASF dual-hosted git repository.
critas pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iotdb-docs.git
The following commit(s) were added to refs/heads/main by this push:
new 7c8dab56 Add documentation for the open-source UDF library (#426)
7c8dab56 is described below
commit 7c8dab56ee9f15f0ca5526ded2393254a43fa7ec
Author: W1y1r <[email protected]>
AuthorDate: Fri Nov 22 17:28:54 2024 +0800
Add documentation for the open-source UDF library (#426)
---
src/.vuepress/sidebar/V1.3.0-2/en.ts | 2 +-
src/.vuepress/sidebar/V1.3.0-2/zh.ts | 2 +-
src/.vuepress/sidebar/V1.3.x/en.ts | 2 +-
src/.vuepress/sidebar/V1.3.x/zh.ts | 2 +-
src/.vuepress/sidebar_timecho/V1.3.0-2/en.ts | 2 +-
src/.vuepress/sidebar_timecho/V1.3.0-2/zh.ts | 2 +-
src/.vuepress/sidebar_timecho/V1.3.x/en.ts | 2 +-
src/.vuepress/sidebar_timecho/V1.3.x/zh.ts | 2 +-
.../{UDF-Libraries.md => UDF-Libraries_apache.md} | 104 +++++----------------
.../{UDF-Libraries.md => UDF-Libraries_timecho.md} | 0
.../Reference/UDF-Libraries_apache.md} | 104 +++++----------------
.../{UDF-Libraries.md => UDF-Libraries_timecho.md} | 0
.../Reference/UDF-Libraries_apache.md} | 104 +++++----------------
.../{UDF-Libraries.md => UDF-Libraries_timecho.md} | 0
.../Reference/UDF-Libraries_apache.md} | 47 ++++++----
.../{UDF-Libraries.md => UDF-Libraries_timecho.md} | 0
.../Reference/UDF-Libraries_apache.md} | 47 ++++++----
.../{UDF-Libraries.md => UDF-Libraries_timecho.md} | 0
.../{UDF-Libraries.md => UDF-Libraries_apache.md} | 47 ++++++----
.../{UDF-Libraries.md => UDF-Libraries_timecho.md} | 0
20 files changed, 164 insertions(+), 305 deletions(-)
diff --git a/src/.vuepress/sidebar/V1.3.0-2/en.ts
b/src/.vuepress/sidebar/V1.3.0-2/en.ts
index a9074853..8eb2eeaa 100644
--- a/src/.vuepress/sidebar/V1.3.0-2/en.ts
+++ b/src/.vuepress/sidebar/V1.3.0-2/en.ts
@@ -164,7 +164,7 @@ export const enSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
- { text: 'UDF Libraries', link: 'UDF-Libraries' },
+ { text: 'UDF Libraries', link: 'UDF-Libraries_apache' },
{ text: 'UDF development', link: 'UDF-development' },
{ text: 'Function and Expression', link: 'Function-and-Expression' },
{ text: 'Common Config Manual', link: 'Common-Config-Manual' },
diff --git a/src/.vuepress/sidebar/V1.3.0-2/zh.ts
b/src/.vuepress/sidebar/V1.3.0-2/zh.ts
index ec1388e6..fb604a43 100644
--- a/src/.vuepress/sidebar/V1.3.0-2/zh.ts
+++ b/src/.vuepress/sidebar/V1.3.0-2/zh.ts
@@ -164,7 +164,7 @@ export const zhSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
- { text: 'UDF函数库', link: 'UDF-Libraries' },
+ { text: 'UDF函数库', link: 'UDF-Libraries_apache' },
{ text: 'UDF开发', link: 'UDF-development' },
{ text: '内置函数与表达式', link: 'Function-and-Expression' },
{ text: '配置参数', link: 'Common-Config-Manual' },
diff --git a/src/.vuepress/sidebar/V1.3.x/en.ts
b/src/.vuepress/sidebar/V1.3.x/en.ts
index 37b7f5ce..2a02c168 100644
--- a/src/.vuepress/sidebar/V1.3.x/en.ts
+++ b/src/.vuepress/sidebar/V1.3.x/en.ts
@@ -165,7 +165,7 @@ export const enSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
- { text: 'UDF Libraries', link: 'UDF-Libraries' },
+ { text: 'UDF Libraries', link: 'UDF-Libraries_apache' },
{ text: 'UDF development', link: 'UDF-development' },
{ text: 'Function and Expression', link: 'Function-and-Expression' },
{ text: 'Common Config Manual', link: 'Common-Config-Manual' },
diff --git a/src/.vuepress/sidebar/V1.3.x/zh.ts
b/src/.vuepress/sidebar/V1.3.x/zh.ts
index 76e5fe9b..08d4d3e1 100644
--- a/src/.vuepress/sidebar/V1.3.x/zh.ts
+++ b/src/.vuepress/sidebar/V1.3.x/zh.ts
@@ -166,7 +166,7 @@ export const zhSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
- { text: 'UDF函数库', link: 'UDF-Libraries' },
+ { text: 'UDF函数库', link: 'UDF-Libraries_apache' },
{ text: 'UDF开发', link: 'UDF-development' },
{ text: '内置函数与表达式', link: 'Function-and-Expression' },
{ text: '配置参数', link: 'Common-Config-Manual' },
diff --git a/src/.vuepress/sidebar_timecho/V1.3.0-2/en.ts
b/src/.vuepress/sidebar_timecho/V1.3.0-2/en.ts
index c2dca39b..09d5d748 100644
--- a/src/.vuepress/sidebar_timecho/V1.3.0-2/en.ts
+++ b/src/.vuepress/sidebar_timecho/V1.3.0-2/en.ts
@@ -175,7 +175,7 @@ export const enSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
- { text: 'UDF Libraries', link: 'UDF-Libraries' },
+ { text: 'UDF Libraries', link: 'UDF-Libraries_timecho' },
{ text: 'UDF development', link: 'UDF-development' },
{ text: 'Function and Expression', link: 'Function-and-Expression' },
{ text: 'Common Config Manual', link: 'Common-Config-Manual' },
diff --git a/src/.vuepress/sidebar_timecho/V1.3.0-2/zh.ts
b/src/.vuepress/sidebar_timecho/V1.3.0-2/zh.ts
index 366a036e..222f4e06 100644
--- a/src/.vuepress/sidebar_timecho/V1.3.0-2/zh.ts
+++ b/src/.vuepress/sidebar_timecho/V1.3.0-2/zh.ts
@@ -175,7 +175,7 @@ export const zhSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
- { text: 'UDF函数库', link: 'UDF-Libraries' },
+ { text: 'UDF函数库', link: 'UDF-Libraries_timecho' },
{ text: 'UDF开发', link: 'UDF-development' },
{ text: '内置函数与表达式', link: 'Function-and-Expression' },
{ text: '配置参数', link: 'Common-Config-Manual' },
diff --git a/src/.vuepress/sidebar_timecho/V1.3.x/en.ts
b/src/.vuepress/sidebar_timecho/V1.3.x/en.ts
index c5ec979f..a4747933 100644
--- a/src/.vuepress/sidebar_timecho/V1.3.x/en.ts
+++ b/src/.vuepress/sidebar_timecho/V1.3.x/en.ts
@@ -177,7 +177,7 @@ export const enSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
- { text: 'UDF Libraries', link: 'UDF-Libraries' },
+ { text: 'UDF Libraries', link: 'UDF-Libraries_timecho' },
{ text: 'UDF development', link: 'UDF-development' },
{ text: 'Function and Expression', link: 'Function-and-Expression' },
{ text: 'Common Config Manual', link: 'Common-Config-Manual' },
diff --git a/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts
b/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts
index 37c9f597..7b71e1b8 100644
--- a/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts
+++ b/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts
@@ -177,7 +177,7 @@ export const zhSidebar = {
prefix: 'Reference/',
// children: 'structure',
children: [
- { text: 'UDF函数库', link: 'UDF-Libraries' },
+ { text: 'UDF函数库', link: 'UDF-Libraries_timecho' },
{ text: 'UDF开发', link: 'UDF-development' },
{ text: '内置函数与表达式', link: 'Function-and-Expression' },
{ text: '配置参数', link: 'Common-Config-Manual' },
diff --git a/src/UserGuide/Master/Reference/UDF-Libraries.md
b/src/UserGuide/Master/Reference/UDF-Libraries_apache.md
similarity index 97%
copy from src/UserGuide/Master/Reference/UDF-Libraries.md
copy to src/UserGuide/Master/Reference/UDF-Libraries_apache.md
index de0ac8b2..63b7fca0 100644
--- a/src/UserGuide/Master/Reference/UDF-Libraries.md
+++ b/src/UserGuide/Master/Reference/UDF-Libraries_apache.md
@@ -31,14 +31,14 @@ Based on the ability of user-defined functions, IoTDB
provides a series of funct
| UDF libraries version | Supported IoTDB versions | Download link
|
| --------------- | ----------------- |
------------------------------------------------------------ |
- | UDF-1.3.3.zip | V1.3.3 and above |
[UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.3.zip) |
- | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.2.zip) |
+ | UDF-1.3.3.zip | V1.3.3 and above |
[UDF.zip](https://alioss.timecho.com/upload/apache-UDF-1.3.3.zip) |
+ | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[UDF.zip](https://alioss.timecho.com/upload/apache-UDF-1.3.2.zip) |
-2. Place the `library-udf.jar` file in the compressed file obtained in the
directory `/ext/udf ` of all nodes in the IoTDB cluster
+2. Place the library-udf.jar file in the compressed file obtained in the
directory `/ext/udf ` of all nodes in the IoTDB cluster
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.
4. Batch registration: Two registration methods: registration script or SQL
full statement
- Register Script
- - 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);
+ - 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);
- Start IoTDB service, run registration script to batch register UDF
- All SQL statements
@@ -3934,86 +3934,26 @@ Output series:
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.
+<!--
-### Envelope
-
-#### Registration statement
-
-```sql
-create function envelope as
'org.apache.iotdb.library.frequency.UDFEnvelopeAnalysis'
-```
-
-#### Usage
-
-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.
-
-**Name：** Envelope
-
-**Input：** Only supports a single input sequence, with types
INT32/INT64/FLOAT/DOUBLE
-
-
-**Parameters：**
-
-+ `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).
-+ `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).
-
-**Output：**
-+ `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.
-
-
-+ `Envelope(Path, 'frequency'='{frequency}')`：Output a single sequence of type
DOUBLE, which is the result of envelope analysis.
-
-**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.
-
-#### Examples
-
-Input series:
-
-
-```
-+-----------------------------+---------------+
-| Time|root.test.d1.s1|
-+-----------------------------+---------------+
-|1970-01-01T08:00:01.000+08:00| 1.0 |
-|1970-01-01T08:00:02.000+08:00| 2.0 |
-|1970-01-01T08:00:03.000+08:00| 3.0 |
-|1970-01-01T08:00:04.000+08:00| 4.0 |
-|1970-01-01T08:00:05.000+08:00| 5.0 |
-|1970-01-01T08:00:06.000+08:00| 6.0 |
-|1970-01-01T08:00:07.000+08:00| 7.0 |
-|1970-01-01T08:00:08.000+08:00| 8.0 |
-|1970-01-01T08:00:09.000+08:00| 9.0 |
-|1970-01-01T08:00:10.000+08:00| 10.0 |
-+-----------------------------+---------------+
-```
-
-SQL for query:
-
-```sql
-set time_display_type=long;
-select
envelope(s1),envelope(s1,'frequency'='1000'),envelope(s1,'amplification'='10')
from root.test.d1;
-```
-
-Output series:
-
-
-```
-+----+-------------------------+---------------------------------------------+-----------------------------------------------+
-|Time|envelope(root.test.d1.s1)|envelope(root.test.d1.s1,
"frequency"="1000")|envelope(root.test.d1.s1, "amplification"="10")|
-+----+-------------------------+---------------------------------------------+-----------------------------------------------+
-| 0| 6.284350808484124| 6.284350808484124|
6.284350808484124|
-| 100| 1.5581923657404393| 1.5581923657404393|
null|
-| 200| 0.8503211038340728| 0.8503211038340728|
null|
-| 300| 0.512808785945551| 0.512808785945551|
null|
-| 400| 0.26361156774506744| 0.26361156774506744|
null|
-|1000| null| null|
1.5581923657404393|
-|2000| null| null|
0.8503211038340728|
-|3000| null| null|
0.512808785945551|
-|4000| null| null|
0.26361156774506744|
-+----+-------------------------+---------------------------------------------+-----------------------------------------------+
-
-```
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
## Data Matching
diff --git a/src/UserGuide/Master/Reference/UDF-Libraries.md
b/src/UserGuide/Master/Reference/UDF-Libraries_timecho.md
similarity index 100%
copy from src/UserGuide/Master/Reference/UDF-Libraries.md
copy to src/UserGuide/Master/Reference/UDF-Libraries_timecho.md
diff --git a/src/UserGuide/Master/Reference/UDF-Libraries.md
b/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md
similarity index 97%
copy from src/UserGuide/Master/Reference/UDF-Libraries.md
copy to src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md
index de0ac8b2..63b7fca0 100644
--- a/src/UserGuide/Master/Reference/UDF-Libraries.md
+++ b/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md
@@ -31,14 +31,14 @@ Based on the ability of user-defined functions, IoTDB
provides a series of funct
| UDF libraries version | Supported IoTDB versions | Download link
|
| --------------- | ----------------- |
------------------------------------------------------------ |
- | UDF-1.3.3.zip | V1.3.3 and above |
[UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.3.zip) |
- | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.2.zip) |
+ | UDF-1.3.3.zip | V1.3.3 and above |
[UDF.zip](https://alioss.timecho.com/upload/apache-UDF-1.3.3.zip) |
+ | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[UDF.zip](https://alioss.timecho.com/upload/apache-UDF-1.3.2.zip) |
-2. Place the `library-udf.jar` file in the compressed file obtained in the
directory `/ext/udf ` of all nodes in the IoTDB cluster
+2. Place the library-udf.jar file in the compressed file obtained in the
directory `/ext/udf ` of all nodes in the IoTDB cluster
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.
4. Batch registration: Two registration methods: registration script or SQL
full statement
- Register Script
- - 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);
+ - 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);
- Start IoTDB service, run registration script to batch register UDF
- All SQL statements
@@ -3934,86 +3934,26 @@ Output series:
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.
+<!--
-### Envelope
-
-#### Registration statement
-
-```sql
-create function envelope as
'org.apache.iotdb.library.frequency.UDFEnvelopeAnalysis'
-```
-
-#### Usage
-
-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.
-
-**Name：** Envelope
-
-**Input：** Only supports a single input sequence, with types
INT32/INT64/FLOAT/DOUBLE
-
-
-**Parameters：**
-
-+ `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).
-+ `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).
-
-**Output：**
-+ `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.
-
-
-+ `Envelope(Path, 'frequency'='{frequency}')`：Output a single sequence of type
DOUBLE, which is the result of envelope analysis.
-
-**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.
-
-#### Examples
-
-Input series:
-
-
-```
-+-----------------------------+---------------+
-| Time|root.test.d1.s1|
-+-----------------------------+---------------+
-|1970-01-01T08:00:01.000+08:00| 1.0 |
-|1970-01-01T08:00:02.000+08:00| 2.0 |
-|1970-01-01T08:00:03.000+08:00| 3.0 |
-|1970-01-01T08:00:04.000+08:00| 4.0 |
-|1970-01-01T08:00:05.000+08:00| 5.0 |
-|1970-01-01T08:00:06.000+08:00| 6.0 |
-|1970-01-01T08:00:07.000+08:00| 7.0 |
-|1970-01-01T08:00:08.000+08:00| 8.0 |
-|1970-01-01T08:00:09.000+08:00| 9.0 |
-|1970-01-01T08:00:10.000+08:00| 10.0 |
-+-----------------------------+---------------+
-```
-
-SQL for query:
-
-```sql
-set time_display_type=long;
-select
envelope(s1),envelope(s1,'frequency'='1000'),envelope(s1,'amplification'='10')
from root.test.d1;
-```
-
-Output series:
-
-
-```
-+----+-------------------------+---------------------------------------------+-----------------------------------------------+
-|Time|envelope(root.test.d1.s1)|envelope(root.test.d1.s1,
"frequency"="1000")|envelope(root.test.d1.s1, "amplification"="10")|
-+----+-------------------------+---------------------------------------------+-----------------------------------------------+
-| 0| 6.284350808484124| 6.284350808484124|
6.284350808484124|
-| 100| 1.5581923657404393| 1.5581923657404393|
null|
-| 200| 0.8503211038340728| 0.8503211038340728|
null|
-| 300| 0.512808785945551| 0.512808785945551|
null|
-| 400| 0.26361156774506744| 0.26361156774506744|
null|
-|1000| null| null|
1.5581923657404393|
-|2000| null| null|
0.8503211038340728|
-|3000| null| null|
0.512808785945551|
-|4000| null| null|
0.26361156774506744|
-+----+-------------------------+---------------------------------------------+-----------------------------------------------+
-
-```
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
## Data Matching
diff --git a/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries.md
b/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md
similarity index 100%
rename from src/UserGuide/V1.3.0-2/Reference/UDF-Libraries.md
rename to src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md
diff --git a/src/UserGuide/Master/Reference/UDF-Libraries.md
b/src/UserGuide/latest/Reference/UDF-Libraries_apache.md
similarity index 97%
rename from src/UserGuide/Master/Reference/UDF-Libraries.md
rename to src/UserGuide/latest/Reference/UDF-Libraries_apache.md
index de0ac8b2..63b7fca0 100644
--- a/src/UserGuide/Master/Reference/UDF-Libraries.md
+++ b/src/UserGuide/latest/Reference/UDF-Libraries_apache.md
@@ -31,14 +31,14 @@ Based on the ability of user-defined functions, IoTDB
provides a series of funct
| UDF libraries version | Supported IoTDB versions | Download link
|
| --------------- | ----------------- |
------------------------------------------------------------ |
- | UDF-1.3.3.zip | V1.3.3 and above |
[UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.3.zip) |
- | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[UDF.zip](https://alioss.timecho.com/upload/UDF-1.3.2.zip) |
+ | UDF-1.3.3.zip | V1.3.3 and above |
[UDF.zip](https://alioss.timecho.com/upload/apache-UDF-1.3.3.zip) |
+ | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[UDF.zip](https://alioss.timecho.com/upload/apache-UDF-1.3.2.zip) |
-2. Place the `library-udf.jar` file in the compressed file obtained in the
directory `/ext/udf ` of all nodes in the IoTDB cluster
+2. Place the library-udf.jar file in the compressed file obtained in the
directory `/ext/udf ` of all nodes in the IoTDB cluster
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.
4. Batch registration: Two registration methods: registration script or SQL
full statement
- Register Script
- - 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);
+ - 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);
- Start IoTDB service, run registration script to batch register UDF
- All SQL statements
@@ -3934,86 +3934,26 @@ Output series:
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.
+<!--
-### Envelope
-
-#### Registration statement
-
-```sql
-create function envelope as
'org.apache.iotdb.library.frequency.UDFEnvelopeAnalysis'
-```
-
-#### Usage
-
-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.
-
-**Name：** Envelope
-
-**Input：** Only supports a single input sequence, with types
INT32/INT64/FLOAT/DOUBLE
-
-
-**Parameters：**
-
-+ `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).
-+ `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).
-
-**Output：**
-+ `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.
-
-
-+ `Envelope(Path, 'frequency'='{frequency}')`：Output a single sequence of type
DOUBLE, which is the result of envelope analysis.
-
-**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.
-
-#### Examples
-
-Input series:
-
-
-```
-+-----------------------------+---------------+
-| Time|root.test.d1.s1|
-+-----------------------------+---------------+
-|1970-01-01T08:00:01.000+08:00| 1.0 |
-|1970-01-01T08:00:02.000+08:00| 2.0 |
-|1970-01-01T08:00:03.000+08:00| 3.0 |
-|1970-01-01T08:00:04.000+08:00| 4.0 |
-|1970-01-01T08:00:05.000+08:00| 5.0 |
-|1970-01-01T08:00:06.000+08:00| 6.0 |
-|1970-01-01T08:00:07.000+08:00| 7.0 |
-|1970-01-01T08:00:08.000+08:00| 8.0 |
-|1970-01-01T08:00:09.000+08:00| 9.0 |
-|1970-01-01T08:00:10.000+08:00| 10.0 |
-+-----------------------------+---------------+
-```
-
-SQL for query:
-
-```sql
-set time_display_type=long;
-select
envelope(s1),envelope(s1,'frequency'='1000'),envelope(s1,'amplification'='10')
from root.test.d1;
-```
-
-Output series:
-
-
-```
-+----+-------------------------+---------------------------------------------+-----------------------------------------------+
-|Time|envelope(root.test.d1.s1)|envelope(root.test.d1.s1,
"frequency"="1000")|envelope(root.test.d1.s1, "amplification"="10")|
-+----+-------------------------+---------------------------------------------+-----------------------------------------------+
-| 0| 6.284350808484124| 6.284350808484124|
6.284350808484124|
-| 100| 1.5581923657404393| 1.5581923657404393|
null|
-| 200| 0.8503211038340728| 0.8503211038340728|
null|
-| 300| 0.512808785945551| 0.512808785945551|
null|
-| 400| 0.26361156774506744| 0.26361156774506744|
null|
-|1000| null| null|
1.5581923657404393|
-|2000| null| null|
0.8503211038340728|
-|3000| null| null|
0.512808785945551|
-|4000| null| null|
0.26361156774506744|
-+----+-------------------------+---------------------------------------------+-----------------------------------------------+
-
-```
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
## Data Matching
diff --git a/src/UserGuide/latest/Reference/UDF-Libraries.md
b/src/UserGuide/latest/Reference/UDF-Libraries_timecho.md
similarity index 100%
rename from src/UserGuide/latest/Reference/UDF-Libraries.md
rename to src/UserGuide/latest/Reference/UDF-Libraries_timecho.md
diff --git a/src/zh/UserGuide/latest/Reference/UDF-Libraries.md
b/src/zh/UserGuide/Master/Reference/UDF-Libraries_apache.md
similarity index 99%
copy from src/zh/UserGuide/latest/Reference/UDF-Libraries.md
copy to src/zh/UserGuide/Master/Reference/UDF-Libraries_apache.md
index c7dfbd33..e8f09450 100644
--- a/src/zh/UserGuide/latest/Reference/UDF-Libraries.md
+++ b/src/zh/UserGuide/Master/Reference/UDF-Libraries_apache.md
@@ -27,14 +27,14 @@
| UDF 函数库版本 | 支持的 IoTDB 版本 | 下载链接
|
| --------------- | ----------------- |
------------------------------------------------------------ |
- | UDF-1.3.3.zip | V1.3.3及以上 |
[压缩包](https://alioss.timecho.com/upload/UDF-1.3.3.zip) |
- | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[压缩包](https://alioss.timecho.com/upload/UDF-1.3.2.zip) |
+ | UDF-1.3.3.zip | V1.3.3及以上 |
[压缩包](https://alioss.timecho.com/upload/apache-UDF-1.3.3.zip) |
+ | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[压缩包](https://alioss.timecho.com/upload/apache-UDF-1.3.2.zip) |
-2. 将获取的压缩包中的 `library-udf.jar` 文件放置在 IoTDB 集群所有节点的 `/ext/udf` 的目录下
+2. 将获取的压缩包中的 library-udf.jar 文件放置在 IoTDB 集群所有节点的 `/ext/udf` 的目录下
3. 在 IoTDB 的 SQL 命令行终端（CLI）或可视化控制台（Workbench）的 SQL 操作界面中，执行下述相应的函数注册语句。
4. 批量注册：两种注册方式：注册脚本 或 SQL汇总语句
- 注册脚本
- - 将压缩包中的注册脚本（`register-UDF.sh` 或 `register-UDF.bat`）按需复制到 IoTDB 的 tools
目录下，修改脚本中的参数（默认为host=127.0.0.1，rpcPort=6667，user=root，pass=root）；
+ - 将压缩包中的注册脚本（register-UDF.sh 或 register-UDF.bat）按需复制到 IoTDB 的 tools
目录下，修改脚本中的参数（默认为host=127.0.0.1，rpcPort=6667，user=root，pass=root）；
- 启动 IoTDB 服务，运行注册脚本批量注册 UDF
- SQL汇总语句
@@ -3981,19 +3981,9 @@ select lowpass(s1,'wpass'='0.45') from root.test.d1
|1970-01-01T08:00:19.000+08:00| -2.664535259100376E-16|
+-----------------------------+----------------------------------------+
```
+## Envelope
-注：输入序列服从$y=sin(2\pi t/4)+2sin(2\pi t/5)$，长度为20，因此低通滤波之后的输出序列服从$y=2sin(2\pi
t/5)$。
-
-
-### Envelope
-
-#### 注册语句
-
-```sql
-create function envelope as
'org.apache.iotdb.library.frequency.UDFEnvelopeAnalysis'
-```
-
-#### 函数简介
+### 函数简介
本函数通过输入一维浮点数数组和用户指定的调制频率，实现对信号的解调和包络提取。解调的目标是从复杂的信号中提取感兴趣的部分，使其更易理解。比如通过解调可以找到信号的包络，即振幅的变化趋势。
@@ -4013,7 +4003,7 @@ create function envelope as
'org.apache.iotdb.library.frequency.UDFEnvelopeAnaly
**提示：** 当解调的原始序列的值不连续时，本函数会视为连续处理，建议被分析的时间序列是一段值完整的时间序列。同时建议指定开始时间与结束时间。
-#### 使用示例
+### 使用示例
输入序列：
@@ -4058,6 +4048,29 @@ select
envelope(s1),envelope(s1,'frequency'='1000'),envelope(s1,'amplification'=
```
+注：输入序列服从$y=sin(2\pi t/4)+2sin(2\pi t/5)$，长度为20，因此低通滤波之后的输出序列服从$y=2sin(2\pi
t/5)$。
+
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
## 数据匹配
### Cov
diff --git a/src/zh/UserGuide/Master/Reference/UDF-Libraries.md
b/src/zh/UserGuide/Master/Reference/UDF-Libraries_timecho.md
similarity index 100%
rename from src/zh/UserGuide/Master/Reference/UDF-Libraries.md
rename to src/zh/UserGuide/Master/Reference/UDF-Libraries_timecho.md
diff --git a/src/zh/UserGuide/latest/Reference/UDF-Libraries.md
b/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md
similarity index 99%
copy from src/zh/UserGuide/latest/Reference/UDF-Libraries.md
copy to src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md
index c7dfbd33..e8f09450 100644
--- a/src/zh/UserGuide/latest/Reference/UDF-Libraries.md
+++ b/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md
@@ -27,14 +27,14 @@
| UDF 函数库版本 | 支持的 IoTDB 版本 | 下载链接
|
| --------------- | ----------------- |
------------------------------------------------------------ |
- | UDF-1.3.3.zip | V1.3.3及以上 |
[压缩包](https://alioss.timecho.com/upload/UDF-1.3.3.zip) |
- | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[压缩包](https://alioss.timecho.com/upload/UDF-1.3.2.zip) |
+ | UDF-1.3.3.zip | V1.3.3及以上 |
[压缩包](https://alioss.timecho.com/upload/apache-UDF-1.3.3.zip) |
+ | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[压缩包](https://alioss.timecho.com/upload/apache-UDF-1.3.2.zip) |
-2. 将获取的压缩包中的 `library-udf.jar` 文件放置在 IoTDB 集群所有节点的 `/ext/udf` 的目录下
+2. 将获取的压缩包中的 library-udf.jar 文件放置在 IoTDB 集群所有节点的 `/ext/udf` 的目录下
3. 在 IoTDB 的 SQL 命令行终端（CLI）或可视化控制台（Workbench）的 SQL 操作界面中，执行下述相应的函数注册语句。
4. 批量注册：两种注册方式：注册脚本 或 SQL汇总语句
- 注册脚本
- - 将压缩包中的注册脚本（`register-UDF.sh` 或 `register-UDF.bat`）按需复制到 IoTDB 的 tools
目录下，修改脚本中的参数（默认为host=127.0.0.1，rpcPort=6667，user=root，pass=root）；
+ - 将压缩包中的注册脚本（register-UDF.sh 或 register-UDF.bat）按需复制到 IoTDB 的 tools
目录下，修改脚本中的参数（默认为host=127.0.0.1，rpcPort=6667，user=root，pass=root）；
- 启动 IoTDB 服务，运行注册脚本批量注册 UDF
- SQL汇总语句
@@ -3981,19 +3981,9 @@ select lowpass(s1,'wpass'='0.45') from root.test.d1
|1970-01-01T08:00:19.000+08:00| -2.664535259100376E-16|
+-----------------------------+----------------------------------------+
```
+## Envelope
-注：输入序列服从$y=sin(2\pi t/4)+2sin(2\pi t/5)$，长度为20，因此低通滤波之后的输出序列服从$y=2sin(2\pi
t/5)$。
-
-
-### Envelope
-
-#### 注册语句
-
-```sql
-create function envelope as
'org.apache.iotdb.library.frequency.UDFEnvelopeAnalysis'
-```
-
-#### 函数简介
+### 函数简介
本函数通过输入一维浮点数数组和用户指定的调制频率，实现对信号的解调和包络提取。解调的目标是从复杂的信号中提取感兴趣的部分，使其更易理解。比如通过解调可以找到信号的包络，即振幅的变化趋势。
@@ -4013,7 +4003,7 @@ create function envelope as
'org.apache.iotdb.library.frequency.UDFEnvelopeAnaly
**提示：** 当解调的原始序列的值不连续时，本函数会视为连续处理，建议被分析的时间序列是一段值完整的时间序列。同时建议指定开始时间与结束时间。
-#### 使用示例
+### 使用示例
输入序列：
@@ -4058,6 +4048,29 @@ select
envelope(s1),envelope(s1,'frequency'='1000'),envelope(s1,'amplification'=
```
+注：输入序列服从$y=sin(2\pi t/4)+2sin(2\pi t/5)$，长度为20，因此低通滤波之后的输出序列服从$y=2sin(2\pi
t/5)$。
+
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
## 数据匹配
### Cov
diff --git a/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries.md
b/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md
similarity index 100%
rename from src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries.md
rename to src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md
diff --git a/src/zh/UserGuide/latest/Reference/UDF-Libraries.md
b/src/zh/UserGuide/latest/Reference/UDF-Libraries_apache.md
similarity index 99%
copy from src/zh/UserGuide/latest/Reference/UDF-Libraries.md
copy to src/zh/UserGuide/latest/Reference/UDF-Libraries_apache.md
index c7dfbd33..e8f09450 100644
--- a/src/zh/UserGuide/latest/Reference/UDF-Libraries.md
+++ b/src/zh/UserGuide/latest/Reference/UDF-Libraries_apache.md
@@ -27,14 +27,14 @@
| UDF 函数库版本 | 支持的 IoTDB 版本 | 下载链接
|
| --------------- | ----------------- |
------------------------------------------------------------ |
- | UDF-1.3.3.zip | V1.3.3及以上 |
[压缩包](https://alioss.timecho.com/upload/UDF-1.3.3.zip) |
- | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[压缩包](https://alioss.timecho.com/upload/UDF-1.3.2.zip) |
+ | UDF-1.3.3.zip | V1.3.3及以上 |
[压缩包](https://alioss.timecho.com/upload/apache-UDF-1.3.3.zip) |
+ | UDF-1.3.2.zip | V1.0.0～V1.3.2 |
[压缩包](https://alioss.timecho.com/upload/apache-UDF-1.3.2.zip) |
-2. 将获取的压缩包中的 `library-udf.jar` 文件放置在 IoTDB 集群所有节点的 `/ext/udf` 的目录下
+2. 将获取的压缩包中的 library-udf.jar 文件放置在 IoTDB 集群所有节点的 `/ext/udf` 的目录下
3. 在 IoTDB 的 SQL 命令行终端（CLI）或可视化控制台（Workbench）的 SQL 操作界面中，执行下述相应的函数注册语句。
4. 批量注册：两种注册方式：注册脚本 或 SQL汇总语句
- 注册脚本
- - 将压缩包中的注册脚本（`register-UDF.sh` 或 `register-UDF.bat`）按需复制到 IoTDB 的 tools
目录下，修改脚本中的参数（默认为host=127.0.0.1，rpcPort=6667，user=root，pass=root）；
+ - 将压缩包中的注册脚本（register-UDF.sh 或 register-UDF.bat）按需复制到 IoTDB 的 tools
目录下，修改脚本中的参数（默认为host=127.0.0.1，rpcPort=6667，user=root，pass=root）；
- 启动 IoTDB 服务，运行注册脚本批量注册 UDF
- SQL汇总语句
@@ -3981,19 +3981,9 @@ select lowpass(s1,'wpass'='0.45') from root.test.d1
|1970-01-01T08:00:19.000+08:00| -2.664535259100376E-16|
+-----------------------------+----------------------------------------+
```
+## Envelope
-注：输入序列服从$y=sin(2\pi t/4)+2sin(2\pi t/5)$，长度为20，因此低通滤波之后的输出序列服从$y=2sin(2\pi
t/5)$。
-
-
-### Envelope
-
-#### 注册语句
-
-```sql
-create function envelope as
'org.apache.iotdb.library.frequency.UDFEnvelopeAnalysis'
-```
-
-#### 函数简介
+### 函数简介
本函数通过输入一维浮点数数组和用户指定的调制频率，实现对信号的解调和包络提取。解调的目标是从复杂的信号中提取感兴趣的部分，使其更易理解。比如通过解调可以找到信号的包络，即振幅的变化趋势。
@@ -4013,7 +4003,7 @@ create function envelope as
'org.apache.iotdb.library.frequency.UDFEnvelopeAnaly
**提示：** 当解调的原始序列的值不连续时，本函数会视为连续处理，建议被分析的时间序列是一段值完整的时间序列。同时建议指定开始时间与结束时间。
-#### 使用示例
+### 使用示例
输入序列：
@@ -4058,6 +4048,29 @@ select
envelope(s1),envelope(s1,'frequency'='1000'),envelope(s1,'amplification'=
```
+注：输入序列服从$y=sin(2\pi t/4)+2sin(2\pi t/5)$，长度为20，因此低通滤波之后的输出序列服从$y=2sin(2\pi
t/5)$。
+
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
## 数据匹配
### Cov
diff --git a/src/zh/UserGuide/latest/Reference/UDF-Libraries.md
b/src/zh/UserGuide/latest/Reference/UDF-Libraries_timecho.md
similarity index 100%
rename from src/zh/UserGuide/latest/Reference/UDF-Libraries.md
rename to src/zh/UserGuide/latest/Reference/UDF-Libraries_timecho.md
