org.apache.calcite.sql.validate

Class SqlUserDefinedTableMacro

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.validate.SqlUserDefinedTableMacro

All Implemented Interfaces:

SqlTableFunction

public class SqlUserDefinedTableMacro
extends SqlFunction
implements SqlTableFunction

User-defined table macro.

Created by the validator, after resolving a function call to a function defined in a Calcite schema.

Field Summary

Fields inherited from class org.apache.calcite.sql.SqlOperator

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor and Description
SqlUserDefinedTableMacro(SqlIdentifier opName, SqlKind kind, SqlReturnTypeInference returnTypeInference, SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandMetadata operandMetadata, TableMacro tableMacro) Creates a user-defined table macro.
SqlUserDefinedTableMacro(SqlIdentifier opName, SqlReturnTypeInference returnTypeInference, SqlOperandTypeInference operandTypeInference, @Nullable SqlOperandTypeChecker operandTypeChecker, List<RelDataType> paramTypes, TableMacro tableMacro) Deprecated.

Method Summary

Modifier and Type	Method and Description
@Nullable SqlOperandMetadata	getOperandTypeChecker()
List<String>	getParamNames() Use SqlOperandMetadata.paramNames() on the result of SqlOperator.getOperandTypeChecker().
SqlReturnTypeInference	getRowTypeInference() Returns the record type of the table yielded by this function when applied to given arguments.
TranslatableTable	getTable(SqlOperatorBinding callBinding) Returns the table in this UDF, or null if there is no table.

Methods inherited from class org.apache.calcite.sql.SqlFunction

deriveType, getFunctionType, getNameAsId, getParamTypes, getSqlIdentifier, getSyntax, isQuantifierAllowed, unparse, validateCall, validateQuantifier

Methods inherited from class org.apache.calcite.sql.SqlOperator

acceptCall, acceptCall, adjustType, allowsFraming, argumentMustBeScalar, checkOperandCount, checkOperandTypes, constructArgNameList, constructArgTypeList, constructOperandList, createCall, createCall, createCall, createCall, createCall, createCall, createCall, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getMonotonicity, getName, getOperandCountRange, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, getStrongPolicyInference, hashCode, inferReturnType, inferReturnType, isAggregator, isDeterministic, isDynamicFunction, isGroup, isGroupAuxiliary, isName, isSymmetrical, leftPrec, not, preValidateCall, requiresDecimalExpansion, requiresOrder, requiresOver, reverse, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.sql.SqlTableFunction

tableCharacteristic

Constructor Detail

SqlUserDefinedTableMacro

@Deprecated
public SqlUserDefinedTableMacro(SqlIdentifier opName,
                                            SqlReturnTypeInference returnTypeInference,
                                            SqlOperandTypeInference operandTypeInference,
                                            @Nullable SqlOperandTypeChecker operandTypeChecker,
                                            List<RelDataType> paramTypes,
                                            TableMacro tableMacro)

Deprecated.

SqlUserDefinedTableMacro

public SqlUserDefinedTableMacro(SqlIdentifier opName,
                                SqlKind kind,
                                SqlReturnTypeInference returnTypeInference,
                                SqlOperandTypeInference operandTypeInference,
                                @Nullable SqlOperandMetadata operandMetadata,
                                TableMacro tableMacro)

Creates a user-defined table macro.

Method Detail

getOperandTypeChecker

public @Nullable SqlOperandMetadata getOperandTypeChecker()

Overrides:

getOperandTypeChecker in class SqlOperator

getParamNames

public List<String> getParamNames()

Description copied from class: SqlFunction

Use SqlOperandMetadata.paramNames() on the result of SqlOperator.getOperandTypeChecker().

Overrides:

getParamNames in class SqlFunction

getTable

public TranslatableTable getTable(SqlOperatorBinding callBinding)

Returns the table in this UDF, or null if there is no table.

getRowTypeInference

public SqlReturnTypeInference getRowTypeInference()

Description copied from interface: SqlTableFunction

Returns the record type of the table yielded by this function when applied to given arguments. Only literal arguments are passed, non-literal are replaced with default values (null, 0, false, etc).

Specified by:

getRowTypeInference in interface SqlTableFunction

Returns:

strategy to infer the row type of a call to this function