Class UDTFConfigurations
- java.lang.Object
-
- org.apache.iotdb.udf.api.customizer.config.UDFConfigurations
-
- org.apache.iotdb.udf.api.customizer.config.UDTFConfigurations
-
public class UDTFConfigurations extends UDFConfigurations
Used inUDTF.beforeStart(UDFParameters, UDTFConfigurations).Supports calling methods in a chain.
Sample code:
{@code
-
-
Field Summary
Fields Modifier and Type Field Description protected AccessStrategyaccessStrategyprotected java.time.ZoneIdzoneId-
Fields inherited from class org.apache.iotdb.udf.api.customizer.config.UDFConfigurations
outputDataType
-
-
Constructor Summary
Constructors Constructor Description UDTFConfigurations(java.time.ZoneId zoneId)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcheck()AccessStrategygetAccessStrategy()UDTFConfigurationssetAccessStrategy(AccessStrategy accessStrategy)Used to specify the strategy for accessing raw query data in UDTF.UDTFConfigurationssetOutputDataType(Type outputDataType)Used to specify the output data type of the UDTF.-
Methods inherited from class org.apache.iotdb.udf.api.customizer.config.UDFConfigurations
getOutputDataType
-
-
-
-
Field Detail
-
zoneId
protected final java.time.ZoneId zoneId
-
accessStrategy
protected AccessStrategy accessStrategy
-
-
Method Detail
-
setOutputDataType
public UDTFConfigurations setOutputDataType(Type outputDataType)
Used to specify the output data type of the UDTF. In other words, the data type you set here determines the type of data that the PointCollector inUDTF.transform(Row, PointCollector),UDTF.transform(RowWindow, PointCollector)orUDTF.terminate(PointCollector)can receive.- Parameters:
outputDataType- the output data type of the UDTF- Returns:
- this
- See Also:
PointCollector
-
getAccessStrategy
public AccessStrategy getAccessStrategy()
-
setAccessStrategy
public UDTFConfigurations setAccessStrategy(AccessStrategy accessStrategy)
Used to specify the strategy for accessing raw query data in UDTF.- Parameters:
accessStrategy- the specified access strategy. it should be an instance ofAccessStrategy.- Returns:
- this
- See Also:
RowByRowAccessStrategy,SlidingTimeWindowAccessStrategy,SlidingSizeWindowAccessStrategy
-
check
public void check()
- Overrides:
checkin classUDFConfigurations
-
-