Package se.kuseman.payloadbuilder.api.catalog

Class TableFunctionInfo

java.lang.Object

se.kuseman.payloadbuilder.api.catalog.FunctionInfo

se.kuseman.payloadbuilder.api.catalog.TableFunctionInfo

public abstract class TableFunctionInfo
extends FunctionInfo

Definition of a table valued function. These functions are applied row by row.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TableFunctionInfo.SchemaResolveException	Exception that can be thrown during schema resolving for TVS to properly trigg compile exception.

Nested classes/interfaces inherited from class se.kuseman.payloadbuilder.api.catalog.FunctionInfo

FunctionInfo.Arity, FunctionInfo.FunctionType

Constructor Summary

Constructors

Constructor	Description
TableFunctionInfo(String name)

Method Summary

Modifier and Type	Method	Description
abstract TupleIterator	execute(IExecutionContext context, String catalogAlias, Optional<Schema> schema, List<IExpression> arguments, IDatasourceOptions options)	Execute table function.
TupleIterator	execute(IExecutionContext context, String catalogAlias, Optional<Schema> schema, List<IExpression> arguments, IDatasourceOptions options, int nodeId)
Map<String,Object>	getDescribeProperties(IExecutionContext context)	Returns a map with describe properties that is used during describe/analyze statements
Schema	getSchema(List<IExpression> arguments)	Return the schema for this function.
Schema	getSchema(List<IExpression> arguments, List<Option> options)	Return the schema for this function.

Methods inherited from class se.kuseman.payloadbuilder.api.catalog.FunctionInfo

arity, equals, getDescription, getFunctionType, getName, hashCode, requiresNamedArguments, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

TableFunctionInfo

public TableFunctionInfo(String name)

Method Details

getSchema

public Schema getSchema(List<IExpression> arguments,
 List<Option> options)

Return the schema for this function. NOTE! If schema cannot be resolved throw a TableFunctionInfo.SchemaResolveException

getSchema

public Schema getSchema(List<IExpression> arguments)

Return the schema for this function. NOTE! If schema cannot be resolved throw a TableFunctionInfo.SchemaResolveException

execute

public TupleIterator execute(IExecutionContext context,
 String catalogAlias,
 Optional<Schema> schema,
 List<IExpression> arguments,
 IDatasourceOptions options,
 int nodeId)

Parameters:

nodeId - The id of the functions node id the query plan tree. Can be used to get hold of node data from IStatementContext to store statistics during execution etc.

See Also:

• execute(IExecutionContext, String, Optional, List, IDatasourceOptions, int)

execute

public abstract TupleIterator execute(IExecutionContext context,
 String catalogAlias,
 Optional<Schema> schema,
 List<IExpression> arguments,
 IDatasourceOptions options)

Execute table function.

Parameters:

context - Execution context

catalogAlias - The query specific catalog alias used in this invocation

schema - Planned schema for this table function. If this has a value then the schema should be used when returning TupleVector' from TupleIterator. Else value will be Optional.empty() and the actual runtime schema should be return for vectors.

arguments - Function arguments

options - Options for this table source such as batch size etc.

getDescribeProperties

public Map<String,Object> getDescribeProperties(IExecutionContext context)

Returns a map with describe properties that is used during describe/analyze statements