Skip to content

update udtf description #781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CritasWang merged 1 commit into from
Jun 25, 2025
Merged

update udtf description #781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/UserGuide/Master/Table/User-Manual/User-defined-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ IoTDB's table model supports three types of UDFs, as detailed below:
|-----------------------------------------|---------------|--------------------------------|
| `UDSF（User-defined Scalar Function）` | Scalar Function | Processes ​1 row of k-column data, outputs ​1 row of 1-column data (one-to-one mapping). |
| `UDAF（User-defined Aggregate Function）` | Aggregate Function | Processes ​m rows of k-column data, outputs ​1 row of 1-column data (many-to-one reduction). |
| `UDTF（User-defined Table Function）` | Table-Valued Function | Generates a result set in "table" format based on dynamic input parameters. |
| `UDTF（User-defined Table Function）` | Table-Valued Function | Processes ​​0 or 1 table (m rows × k columns)​​, outputs ​​1 table (x rows × y columns)​​. |

* `UDSF` can be used in any clause or expression where scalar functions are allowed, such as: SELECT clauses, WHERE conditions, etc.

Expand Down
2 changes: 1 addition & 1 deletion src/UserGuide/latest-Table/User-Manual/User-defined-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ IoTDB's table model supports three types of UDFs, as detailed below:
|-----------------------------------------|---------------|--------------------------------|
| `UDSF（User-defined Scalar Function）` | Scalar Function | Processes ​1 row of k-column data, outputs ​1 row of 1-column data (one-to-one mapping). |
| `UDAF（User-defined Aggregate Function）` | Aggregate Function | Processes ​m rows of k-column data, outputs ​1 row of 1-column data (many-to-one reduction). |
| `UDTF（User-defined Table Function）` | Table-Valued Function | Generates a result set in "table" format based on dynamic input parameters. |
| `UDTF（User-defined Table Function）` | Table-Valued Function | Processes ​​0 or 1 table (m rows × k columns)​​, outputs ​​1 table (x rows × y columns)​​. |

* `UDSF` can be used in any clause or expression where scalar functions are allowed, such as: SELECT clauses, WHERE conditions, etc.

Expand Down
2 changes: 1 addition & 1 deletion src/zh/UserGuide/Master/Table/User-Manual/User-defined-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ IoTDB 表模型中支持三种类型的 UDF ，如下表所示。
|-----------------------------------------|------|--------------------------------|
| `UDSF（User-defined Scalar Function）` | 标量函数 | 输入 k 列 1 行数据，输出1 列 1 行数据（一对一）。 |
| `UDAF（User-defined Aggregate Function）` | 聚合函数 | 输入k 列 m 行数据，输出1 列 1 行数据（多对一）。 |
| `UDTF（User-defined Table Function）` | 表函数 | 根据输入的动态参数生成“表”形式的结果集。 |
| `UDTF（User-defined Table Function）` | 表函数 | 输入0或1张表（k 列 m 行），输出1张表（x 行 y 列）。 |

* `UDSF` 可用于标量函数出现的任何子句和表达式中，如select子句、where子句等。
* `select udsf1(s1) from table1 where udsf2(s1)>0`
Expand Down
10 changes: 5 additions & 5 deletions src/zh/UserGuide/latest-Table/User-Manual/User-defined-function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ UDF（User Defined Function）即用户自定义函数，IoTDB 提供多种内

IoTDB 表模型中支持三种类型的 UDF ，如下表所示。

| UDF 类型 | 函数类型 | 描述 |
|-----------------------------------------|------|--------------------------------|
| `UDSF（User-defined Scalar Function）` | 标量函数 | 输入 k 列 1 行数据，输出1 列 1 行数据（一对一）。 |
| `UDAF（User-defined Aggregate Function）` | 聚合函数 | 输入k 列 m 行数据，输出1 列 1 行数据（多对一）。 |
| `UDTF（User-defined Table Function）` | 表函数 | 根据输入的动态参数生成“表”形式的结果集。 |
| UDF 类型 | 函数类型 | 描述 |
|-----------------------------------------|------|----------------------------------|
| `UDSF（User-defined Scalar Function）` | 标量函数 | 输入 k 列 1 行数据，输出1 列 1 行数据（一对一）。 |
| `UDAF（User-defined Aggregate Function）` | 聚合函数 | 输入k 列 m 行数据，输出1 列 1 行数据（多对一）。 |
| `UDTF（User-defined Table Function）` | 表函数 | 输入0或1张表（k 列 m 行），输出1张表（x 行 y 列）。 |

* `UDSF` 可用于标量函数出现的任何子句和表达式中，如select子句、where子句等。
* `select udsf1(s1) from table1 where udsf2(s1)>0`
Expand Down