diff --git a/src/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md b/src/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md index dd6c31636..f7b68d4fb 100644 --- a/src/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md +++ b/src/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md @@ -25,6 +25,8 @@ Based on the ability of user-defined functions, IoTDB provides a series of functions for temporal data processing, including data quality, data profiling, anomaly detection, frequency domain analysis, data matching, data repairing, sequence discovery, machine learning, etc., which can meet the needs of industrial fields for temporal data processing. +> Note: The functions in the current UDF library only support millisecond level timestamp accuracy. + ## Installation steps 1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version. diff --git a/src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md b/src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md index dd6c31636..f7b68d4fb 100644 --- a/src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md +++ b/src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md @@ -25,6 +25,8 @@ Based on the ability of user-defined functions, IoTDB provides a series of functions for temporal data processing, including data quality, data profiling, anomaly detection, frequency domain analysis, data matching, data repairing, sequence discovery, machine learning, etc., which can meet the needs of industrial fields for temporal data processing. +> Note: The functions in the current UDF library only support millisecond level timestamp accuracy. + ## Installation steps 1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version. diff --git a/src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_timecho.md b/src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_timecho.md index c20dfda35..b03e86e5f 100644 --- a/src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_timecho.md +++ b/src/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_timecho.md @@ -25,6 +25,8 @@ Based on the ability of user-defined functions, IoTDB provides a series of functions for temporal data processing, including data quality, data profiling, anomaly detection, frequency domain analysis, data matching, data repairing, sequence discovery, machine learning, etc., which can meet the needs of industrial fields for temporal data processing. +> Note: The functions in the current UDF library only support millisecond level timestamp accuracy. + ## Installation steps 1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version. diff --git a/src/UserGuide/V1.2.x/Reference/UDF-Libraries.md b/src/UserGuide/V1.2.x/Reference/UDF-Libraries.md index 1d394969b..cf2ee4509 100644 --- a/src/UserGuide/V1.2.x/Reference/UDF-Libraries.md +++ b/src/UserGuide/V1.2.x/Reference/UDF-Libraries.md @@ -21,6 +21,29 @@ # UDF Libraries +Based on the ability of user-defined functions, IoTDB provides a series of functions for temporal data processing, including data quality, data profiling, anomaly detection, frequency domain analysis, data matching, data repairing, sequence discovery, machine learning, etc., which can meet the needs of industrial fields for temporal data processing. + +> Note: The functions in the current UDF library only support millisecond level timestamp accuracy. + +## Installation steps + +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-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| + +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); + - 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 + ## Data Quality ### Completeness diff --git a/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md b/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md index 84f030bc9..3b8ddd7c6 100644 --- a/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md +++ b/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md @@ -25,6 +25,8 @@ Based on the ability of user-defined functions, IoTDB provides a series of functions for temporal data processing, including data quality, data profiling, anomaly detection, frequency domain analysis, data matching, data repairing, sequence discovery, machine learning, etc., which can meet the needs of industrial fields for temporal data processing. +> Note: The functions in the current UDF library only support millisecond level timestamp accuracy. + ## Installation steps 1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version. diff --git a/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md b/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md index ee87fe3eb..6f2c89a63 100644 --- a/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md +++ b/src/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md @@ -23,6 +23,8 @@ Based on the ability of user-defined functions, IoTDB provides a series of functions for temporal data processing, including data quality, data profiling, anomaly detection, frequency domain analysis, data matching, data repairing, sequence discovery, machine learning, etc., which can meet the needs of industrial fields for temporal data processing. +> Note: The functions in the current UDF library only support millisecond level timestamp accuracy. + ## Installation steps 1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version. diff --git a/src/UserGuide/latest/Reference/UDF-Libraries_apache.md b/src/UserGuide/latest/Reference/UDF-Libraries_apache.md index 2786c1dde..bd3d7baca 100644 --- a/src/UserGuide/latest/Reference/UDF-Libraries_apache.md +++ b/src/UserGuide/latest/Reference/UDF-Libraries_apache.md @@ -25,6 +25,8 @@ Based on the ability of user-defined functions, IoTDB provides a series of functions for temporal data processing, including data quality, data profiling, anomaly detection, frequency domain analysis, data matching, data repairing, sequence discovery, machine learning, etc., which can meet the needs of industrial fields for temporal data processing. +> Note: The functions in the current UDF library only support millisecond level timestamp accuracy. + ## Installation steps 1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version. diff --git a/src/UserGuide/latest/SQL-Manual/UDF-Libraries_apache.md b/src/UserGuide/latest/SQL-Manual/UDF-Libraries_apache.md index 2786c1dde..bd3d7baca 100644 --- a/src/UserGuide/latest/SQL-Manual/UDF-Libraries_apache.md +++ b/src/UserGuide/latest/SQL-Manual/UDF-Libraries_apache.md @@ -25,6 +25,8 @@ Based on the ability of user-defined functions, IoTDB provides a series of functions for temporal data processing, including data quality, data profiling, anomaly detection, frequency domain analysis, data matching, data repairing, sequence discovery, machine learning, etc., which can meet the needs of industrial fields for temporal data processing. +> Note: The functions in the current UDF library only support millisecond level timestamp accuracy. + ## Installation steps 1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version. diff --git a/src/UserGuide/latest/SQL-Manual/UDF-Libraries_timecho.md b/src/UserGuide/latest/SQL-Manual/UDF-Libraries_timecho.md index 1c4372a34..564b7ad32 100644 --- a/src/UserGuide/latest/SQL-Manual/UDF-Libraries_timecho.md +++ b/src/UserGuide/latest/SQL-Manual/UDF-Libraries_timecho.md @@ -25,6 +25,8 @@ Based on the ability of user-defined functions, IoTDB provides a series of functions for temporal data processing, including data quality, data profiling, anomaly detection, frequency domain analysis, data matching, data repairing, sequence discovery, machine learning, etc., which can meet the needs of industrial fields for temporal data processing. +> Note: The functions in the current UDF library only support millisecond level timestamp accuracy. + ## Installation steps 1. Please obtain the compressed file of the UDF library JAR package that is compatible with the IoTDB version. diff --git a/src/zh/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md b/src/zh/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md index b683969fc..7112666cf 100644 --- a/src/zh/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md +++ b/src/zh/UserGuide/Master/Tree/Reference/UDF-Libraries_apache.md @@ -22,6 +22,8 @@ 基于用户自定义函数能力，IoTDB 提供了一系列关于时序数据处理的函数，包括数据质量、数据画像、异常检测、 频域分析、数据匹配、数据修复、序列发现、机器学习等，能够满足工业领域对时序数据处理的需求。 +> 注意：当前UDF函数库中的函数仅支持毫秒级的时间戳精度。 + ## 安装步骤 1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。 diff --git a/src/zh/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md b/src/zh/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md index b683969fc..7112666cf 100644 --- a/src/zh/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md +++ b/src/zh/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_apache.md @@ -22,6 +22,8 @@ 基于用户自定义函数能力，IoTDB 提供了一系列关于时序数据处理的函数，包括数据质量、数据画像、异常检测、 频域分析、数据匹配、数据修复、序列发现、机器学习等，能够满足工业领域对时序数据处理的需求。 +> 注意：当前UDF函数库中的函数仅支持毫秒级的时间戳精度。 + ## 安装步骤 1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。 diff --git a/src/zh/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_timecho.md b/src/zh/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_timecho.md index e2f9bc380..aebf800a4 100644 --- a/src/zh/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_timecho.md +++ b/src/zh/UserGuide/Master/Tree/SQL-Manual/UDF-Libraries_timecho.md @@ -22,6 +22,8 @@ 基于用户自定义函数能力，IoTDB 提供了一系列关于时序数据处理的函数，包括数据质量、数据画像、异常检测、 频域分析、数据匹配、数据修复、序列发现、机器学习等，能够满足工业领域对时序数据处理的需求。 +> 注意：当前UDF函数库中的函数仅支持毫秒级的时间戳精度。 + ## 安装步骤 1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。 diff --git a/src/zh/UserGuide/V1.2.x/Reference/UDF-Libraries.md b/src/zh/UserGuide/V1.2.x/Reference/UDF-Libraries.md index eff7b2d95..d07282e7d 100644 --- a/src/zh/UserGuide/V1.2.x/Reference/UDF-Libraries.md +++ b/src/zh/UserGuide/V1.2.x/Reference/UDF-Libraries.md @@ -20,6 +20,29 @@ --> # UDF函数库 +基于用户自定义函数能力，IoTDB 提供了一系列关于时序数据处理的函数，包括数据质量、数据画像、异常检测、 频域分析、数据匹配、数据修复、序列发现、机器学习等，能够满足工业领域对时序数据处理的需求。 + +> 注意：当前UDF函数库中的函数仅支持毫秒级的时间戳精度。 + +## 安装步骤 +1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。 + + | UDF 函数库版本 | 支持的 IoTDB 版本 | 下载链接 | + | --------------- | ----------------- | ------------------------------------------------------------ | + | UDF-1.3.3.zip | V1.3.3及以上 | 请联系天谋商务获取 | + | UDF-1.3.2.zip | V1.0.0～V1.3.2 | 请联系天谋商务获取| + +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）； + - 启动 IoTDB 服务，运行注册脚本批量注册 UDF + +- SQL汇总语句 + - 打开压缩包中的SQl文件，复制全部 SQL 语句，在 IoTDB 的 SQL 命令行终端（CLI）或可视化控制台（Workbench）的 SQL 操作界面中，执行全部 SQl 语句批量注册 UDF + + ## 数据质量 ### Completeness diff --git a/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md b/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md index 3d9db4c0e..f3375db8d 100644 --- a/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md +++ b/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_apache.md @@ -22,6 +22,8 @@ 基于用户自定义函数能力，IoTDB 提供了一系列关于时序数据处理的函数，包括数据质量、数据画像、异常检测、 频域分析、数据匹配、数据修复、序列发现、机器学习等，能够满足工业领域对时序数据处理的需求。 +> 注意：当前UDF函数库中的函数仅支持毫秒级的时间戳精度。 + ## 安装步骤 1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。 diff --git a/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md b/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md index 1bc0564da..b8f319548 100644 --- a/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md +++ b/src/zh/UserGuide/V1.3.0-2/Reference/UDF-Libraries_timecho.md @@ -22,6 +22,8 @@ 基于用户自定义函数能力，IoTDB 提供了一系列关于时序数据处理的函数，包括数据质量、数据画像、异常检测、 频域分析、数据匹配、数据修复、序列发现、机器学习等，能够满足工业领域对时序数据处理的需求。 +> 注意：当前UDF函数库中的函数仅支持毫秒级的时间戳精度。 + ## 安装步骤 1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。 diff --git a/src/zh/UserGuide/latest/Reference/UDF-Libraries_apache.md b/src/zh/UserGuide/latest/Reference/UDF-Libraries_apache.md index ae4b9fb63..11fdd7324 100644 --- a/src/zh/UserGuide/latest/Reference/UDF-Libraries_apache.md +++ b/src/zh/UserGuide/latest/Reference/UDF-Libraries_apache.md @@ -22,6 +22,8 @@ 基于用户自定义函数能力，IoTDB 提供了一系列关于时序数据处理的函数，包括数据质量、数据画像、异常检测、 频域分析、数据匹配、数据修复、序列发现、机器学习等，能够满足工业领域对时序数据处理的需求。 +> 注意：当前UDF函数库中的函数仅支持毫秒级的时间戳精度。 + ## 安装步骤 1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。 diff --git a/src/zh/UserGuide/latest/SQL-Manual/UDF-Libraries_apache.md b/src/zh/UserGuide/latest/SQL-Manual/UDF-Libraries_apache.md index ae4b9fb63..11fdd7324 100644 --- a/src/zh/UserGuide/latest/SQL-Manual/UDF-Libraries_apache.md +++ b/src/zh/UserGuide/latest/SQL-Manual/UDF-Libraries_apache.md @@ -22,6 +22,8 @@ 基于用户自定义函数能力，IoTDB 提供了一系列关于时序数据处理的函数，包括数据质量、数据画像、异常检测、 频域分析、数据匹配、数据修复、序列发现、机器学习等，能够满足工业领域对时序数据处理的需求。 +> 注意：当前UDF函数库中的函数仅支持毫秒级的时间戳精度。 + ## 安装步骤 1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。 diff --git a/src/zh/UserGuide/latest/SQL-Manual/UDF-Libraries_timecho.md b/src/zh/UserGuide/latest/SQL-Manual/UDF-Libraries_timecho.md index dd61fe411..ddc09fdd9 100644 --- a/src/zh/UserGuide/latest/SQL-Manual/UDF-Libraries_timecho.md +++ b/src/zh/UserGuide/latest/SQL-Manual/UDF-Libraries_timecho.md @@ -22,6 +22,8 @@ 基于用户自定义函数能力，IoTDB 提供了一系列关于时序数据处理的函数，包括数据质量、数据画像、异常检测、 频域分析、数据匹配、数据修复、序列发现、机器学习等，能够满足工业领域对时序数据处理的需求。 +> 注意：当前UDF函数库中的函数仅支持毫秒级的时间戳精度。 + ## 安装步骤 1. 请获取与 IoTDB 版本兼容的 UDF 函数库 JAR 包的压缩包。