com.dynamic.sql.core.column.function

接口 TableFunction

所有超级接口:

Bindable, SqlRenderable

所有已知子接口:

AggregateFunction, ColumFunction, ConversionFunction, DatetimeFunction, JsonFunction, LogicalFunction, NumberFunction, ScalarFunction, StringFunction, WindowsFunction

所有已知实现类:

Abs, AbstractColumFunction, AbstractTableFunction, AllColumn, AnonymousFunction, AsBinary, AsText, Avg, Ceiling, Column, ColumnFunctionDecorator, Contains, Count, DateFormat, DenseRank, Distance, DistanceSphere, Distinct, Floor, JsonExtract, JsonTable, JsonUnquote, Latitude, Length, Longitude, Max, Md5, Min, Mod, Now, NumberColumn, Rank, Round, RowNumber, SRID, StdDev, SubString, Sum, Truncate, Upper, Variance

public interface TableFunction
extends SqlRenderable, Bindable

表级函数（Table-Valued Function，TVF）。

表级函数可作为 FROM 子句中的“虚拟表”参与查询，例如：

     SELECT * FROM my_function(arg1, arg2)
 

实现该接口的对象需要具备：

• 可渲染为 SQL（继承 SqlRenderable）
• 可绑定参数（继承 Bindable）
• 提供函数返回的列定义（如 TVF 的返回 schema）

该接口仅描述表函数的结构，不限制具体的 SQL 方言或函数语法。

方法概要

限定符和类型	方法和说明
Fn<?,?>	originColumn() 返回表函数的返回列定义。

从接口继承的方法 com.dynamic.sql.core.column.function.SqlRenderable

render

从接口继承的方法 com.dynamic.sql.core.column.function.Bindable

parameterBinder

方法详细资料

originColumn

Fn<?,?> originColumn()

返回表函数的返回列定义。

对于 table-valued function，其返回值通常是一个“虚拟表”， 该表至少包含一个列，因此需要提供对应的列表达式。

返回:

函数返回的列表达式（通常为虚拟表的主列或唯一列）