Skip to content

Commit

Permalink
UDF library document error message (#461)
Browse files Browse the repository at this point in the history
* UDF library document error message

* UDF library document error message

* UDF library document error message
  • Loading branch information
W1y1r authored Dec 13, 2024
1 parent 520f9af commit a702c65
Show file tree
Hide file tree
Showing 18 changed files with 73 additions and 73 deletions.
10 changes: 5 additions & 5 deletions src/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,20 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct

1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version.

| UDF libraries version | Supported IoTDB versions | Download link |
| UDF installation package | Supported IoTDB versions | Download link |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3 and above | Please contact Timecho for assistance |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|
| apache-UDF-1.3.3.zip | V1.3.3 and above |Please contact Timecho for assistance |
| apache-UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|

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.
3. In the SQL operation interface of IoTDB's SQL command line terminal (CLI), 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);
- Start IoTDB service, run registration script to batch register UDF

- All SQL statements
- Open the SQl file in the compressed package, copy all SQL statements, and execute all SQl statements in the SQL command line terminal (CLI) of IoTDB or the SQL operation interface of the visualization console (Workbench) to batch register UDF
- Open the SQl file in the compressed package, copy all SQL statements, and in the SQL operation interface of IoTDB's SQL command line terminal (CLI), execute all SQl statements to batch register UDFs

## Data Quality

Expand Down
11 changes: 6 additions & 5 deletions src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,21 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct

1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version.

| UDF libraries version | Supported IoTDB versions | Download link |
| UDF installation package | Supported IoTDB versions | Download link |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3 and above | Please contact Timecho for assistance |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|
| apache-UDF-1.3.3.zip | V1.3.3 and above |Please contact Timecho for assistance |
| apache-UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|

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.
3. In the SQL operation interface of IoTDB's SQL command line terminal (CLI), 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);
- Start IoTDB service, run registration script to batch register UDF

- All SQL statements
- Open the SQl file in the compressed package, copy all SQL statements, and execute all SQl statements in the SQL command line terminal (CLI) of IoTDB or the SQL operation interface of the visualization console (Workbench) to batch register UDF
- Open the SQl file in the compressed package, copy all SQL statements, and in the SQL operation interface of IoTDB's SQL command line terminal (CLI), execute all SQl statements to batch register UDFs


## Data Quality

Expand Down
6 changes: 3 additions & 3 deletions src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_timecho.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct

1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version.

| UDF libraries version | Supported IoTDB versions | Download link |
| UDF installation package | Supported IoTDB versions | Download link |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3 and above | Please contact Timecho for assistance |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance |
| TimechoDB-UDF-1.3.3.zip | V1.3.3 and above | Please contact Timecho for assistance |
| TimechoDB-UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|

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.
Expand Down
3 changes: 1 addition & 2 deletions src/UserGuide/V1.2.x/Reference/UDF-Libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ 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 | Please contact Timecho for assistance |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|
| TimechoDB-UDF-1.2.x.zip | V1.0.0~V1.2.x |Please contact Timecho for assistance|

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.
Expand Down
11 changes: 6 additions & 5 deletions src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,21 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct

1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version.

| UDF libraries version | Supported IoTDB versions | Download link |
| UDF installation package | Supported IoTDB versions | Download link |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3 and above | Please contact Timecho for assistance |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance |
| apache-UDF-1.3.3.zip | V1.3.3 and above |Please contact Timecho for assistance |
| apache-UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|

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.
3. In the SQL operation interface of IoTDB's SQL command line terminal (CLI), 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);
- Start IoTDB service, run registration script to batch register UDF

- All SQL statements
- Open the SQl file in the compressed package, copy all SQL statements, and execute all SQl statements in the SQL command line terminal (CLI) of IoTDB or the SQL operation interface of the visualization console (Workbench) to batch register UDF
- Open the SQl file in the compressed package, copy all SQL statements, and in the SQL operation interface of IoTDB's SQL command line terminal (CLI), execute all SQl statements to batch register UDFs


## Data Quality

Expand Down
6 changes: 3 additions & 3 deletions src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct

1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version.

| UDF libraries version | Supported IoTDB versions | Download link |
| UDF installation package | Supported IoTDB versions | Download link |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3 and above |Please contact Timecho for assistance |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance |
| TimechoDB-UDF-1.3.3.zip | V1.3.3 and above | Please contact Timecho for assistance |
| TimechoDB-UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|

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.
Expand Down
10 changes: 5 additions & 5 deletions src/UserGuide/latest/Reference/UDF-Libraries_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,20 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct

1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version.

| UDF libraries version | Supported IoTDB versions | Download link |
| UDF installation package | Supported IoTDB versions | Download link |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3 and above |Please contact Timecho for assistance |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|
| apache-UDF-1.3.3.zip | V1.3.3 and above |Please contact Timecho for assistance |
| apache-UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|

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.
3. In the SQL operation interface of IoTDB's SQL command line terminal (CLI), 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);
- Start IoTDB service, run registration script to batch register UDF

- All SQL statements
- Open the SQl file in the compressed package, copy all SQL statements, and execute all SQl statements in the SQL command line terminal (CLI) of IoTDB or the SQL operation interface of the visualization console (Workbench) to batch register UDF
- Open the SQl file in the compressed package, copy all SQL statements, and in the SQL operation interface of IoTDB's SQL command line terminal (CLI), execute all SQl statements to batch register UDFs

## Data Quality

Expand Down
11 changes: 6 additions & 5 deletions src/UserGuide/latest/SQL-Manual/UDF-Libraries_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,21 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct

1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version.

| UDF libraries version | Supported IoTDB versions | Download link |
| UDF installation package | Supported IoTDB versions | Download link |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3 and above |Please contact Timecho for assistance |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|
| apache-UDF-1.3.3.zip | V1.3.3 and above |Please contact Timecho for assistance |
| apache-UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|

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.
3. In the SQL operation interface of IoTDB's SQL command line terminal (CLI), 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);
- Start IoTDB service, run registration script to batch register UDF

- All SQL statements
- Open the SQl file in the compressed package, copy all SQL statements, and execute all SQl statements in the SQL command line terminal (CLI) of IoTDB or the SQL operation interface of the visualization console (Workbench) to batch register UDF
- Open the SQl file in the compressed package, copy all SQL statements, and in the SQL operation interface of IoTDB's SQL command line terminal (CLI), execute all SQl statements to batch register UDFs


## Data Quality

Expand Down
6 changes: 3 additions & 3 deletions src/UserGuide/latest/SQL-Manual/UDF-Libraries_timecho.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Based on the ability of user-defined functions, IoTDB provides a series of funct

1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version.

| UDF libraries version | Supported IoTDB versions | Download link |
| UDF installation package | Supported IoTDB versions | Download link |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3 and above | Please contact Timecho for assistance |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|
| TimechoDB-UDF-1.3.3.zip | V1.3.3 and above | Please contact Timecho for assistance |
| TimechoDB-UDF-1.3.2.zip | V1.0.0~V1.3.2 | Please contact Timecho for assistance|

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.
Expand Down
10 changes: 5 additions & 5 deletions src/zh/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,20 @@
## 安装步骤
1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。

| UDF 函数库版本 | 支持的 IoTDB 版本 | 下载链接 |
| UDF 安装包 | 支持的 IoTDB 版本 | 下载链接 |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3及以上 | 请联系天谋商务获取 |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | 请联系天谋商务获取 |
| apache-UDF-1.3.3.zip | V1.3.3及以上 | 请联系天谋商务获取 |
| apache-UDF-1.3.2.zip | V1.0.0~V1.3.2 | 请联系天谋商务获取|

2. 将获取的压缩包中的 library-udf.jar 文件放置在 IoTDB 集群所有节点的 `/ext/udf` 的目录下
3. 在 IoTDB 的 SQL 命令行终端(CLI)或可视化控制台(Workbench)的 SQL 操作界面中,执行下述相应的函数注册语句。
3. 在 IoTDB 的 SQL 命令行终端(CLI)的 SQL 操作界面中,执行下述相应的函数注册语句。
4. 批量注册:两种注册方式:注册脚本 或 SQL汇总语句
- 注册脚本
- 将压缩包中的注册脚本(register-UDF.sh 或 register-UDF.bat)按需复制到 IoTDB 的 tools 目录下,修改脚本中的参数(默认为host=127.0.0.1,rpcPort=6667,user=root,pass=root);
- 启动 IoTDB 服务,运行注册脚本批量注册 UDF

- SQL汇总语句
- 打开压缩包中的SQl文件,复制全部 SQL 语句,在 IoTDB 的 SQL 命令行终端(CLI)或可视化控制台(Workbench)的 SQL 操作界面中,执行全部 SQl 语句批量注册 UDF
- 打开压缩包中的SQl文件,复制全部 SQL 语句,在 IoTDB 的 SQL 命令行终端(CLI)的 SQL 操作界面中,执行全部 SQl 语句批量注册 UDF

## 数据质量
Expand Down
10 changes: 5 additions & 5 deletions src/zh/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,20 @@
## 安装步骤
1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。

| UDF 函数库版本 | 支持的 IoTDB 版本 | 下载链接 |
| UDF 安装包 | 支持的 IoTDB 版本 | 下载链接 |
| --------------- | ----------------- | ------------------------------------------------------------ |
| UDF-1.3.3.zip | V1.3.3及以上 | 请联系天谋商务获取 |
| UDF-1.3.2.zip | V1.0.0~V1.3.2 | 请联系天谋商务获取 |
| apache-UDF-1.3.3.zip | V1.3.3及以上 | 请联系天谋商务获取 |
| apache-UDF-1.3.2.zip | V1.0.0~V1.3.2 | 请联系天谋商务获取|

2. 将获取的压缩包中的 library-udf.jar 文件放置在 IoTDB 集群所有节点的 `/ext/udf` 的目录下
3. 在 IoTDB 的 SQL 命令行终端(CLI)或可视化控制台(Workbench)的 SQL 操作界面中,执行下述相应的函数注册语句。
3. 在 IoTDB 的 SQL 命令行终端(CLI)的 SQL 操作界面中,执行下述相应的函数注册语句。
4. 批量注册:两种注册方式:注册脚本 或 SQL汇总语句
- 注册脚本
- 将压缩包中的注册脚本(register-UDF.sh 或 register-UDF.bat)按需复制到 IoTDB 的 tools 目录下,修改脚本中的参数(默认为host=127.0.0.1,rpcPort=6667,user=root,pass=root);
- 启动 IoTDB 服务,运行注册脚本批量注册 UDF

- SQL汇总语句
- 打开压缩包中的SQl文件,复制全部 SQL 语句,在 IoTDB 的 SQL 命令行终端(CLI)或可视化控制台(Workbench)的 SQL 操作界面中,执行全部 SQl 语句批量注册 UDF
- 打开压缩包中的SQl文件,复制全部 SQL 语句,在 IoTDB 的 SQL 命令行终端(CLI)的 SQL 操作界面中,执行全部 SQl 语句批量注册 UDF

## 数据质量
Expand Down
Loading

0 comments on commit a702c65

Please sign in to comment.