Package io.trino.spi.function.table

Class TableFunctionAnalysis

java.lang.Object

io.trino.spi.function.table.TableFunctionAnalysis

@Experimental(eta="2022-10-31")
public final class TableFunctionAnalysis
extends Object

An object of this class is produced by the `analyze()` method of a `ConnectorTableFunction` implementation. It contains all the analysis results:

The `returnedType` field is used to inform the Analyzer of the proper columns returned by the Table Function, that is, the columns produced by the function, as opposed to the columns passed from the input tables. The `returnedType` should only be set if the declared returned type is GENERIC_TABLE.

The `requiredColumns` field is used to inform the Analyzer of the columns from the table arguments that are necessary to execute the table function.

The `handle` field can be used to carry all information necessary to execute the table function, gathered at analysis time. Typically, these are the values of the constant arguments, and results of pre-processing arguments.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TableFunctionAnalysis.Builder

Method Summary

Modifier and Type	Method	Description
static TableFunctionAnalysis.Builder	builder()
ConnectorTableFunctionHandle	getHandle()
Map<String,List<Integer>>	getRequiredColumns()
Optional<Descriptor>	getReturnedType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getReturnedType

public Optional<Descriptor> getReturnedType()

getRequiredColumns

public Map<String,List<Integer>> getRequiredColumns()

getHandle

public ConnectorTableFunctionHandle getHandle()

builder

public static TableFunctionAnalysis.Builder builder()