Package org.apache.calcite.sql

Class SqlUnnestOperator

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlSpecialOperator

org.apache.calcite.sql.SqlFunctionalOperator

org.apache.calcite.sql.SqlUnnestOperator

public class SqlUnnestOperator
extends SqlFunctionalOperator

The UNNEST operator.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.calcite.sql.SqlSpecialOperator

SqlSpecialOperator.ReduceResult, SqlSpecialOperator.TokenSequence

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAP_KEY_COLUMN_NAME
static final String	MAP_VALUE_COLUMN_NAME
static final String	ORDINALITY_COLUMN_NAME
final boolean	withOrdinality	Whether WITH ORDINALITY was specified.

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor	Description
SqlUnnestOperator(boolean withOrdinality)

Method Summary

Modifier and Type	Method	Description
boolean	argumentMustBeScalar(int ordinal)	Returns whether the ordinalth argument to this operator must be scalar (as opposed to a query).
RelDataType	inferReturnType(SqlOperatorBinding opBinding)	Infers the return type of an invocation of this operator; only called after the number and types of operands have already been validated.
void	unparse(SqlWriter writer, SqlCall call, int leftPrec, int rightPrec)	Writes a SQL representation of a call to this operator to a writer, including parentheses if the operators on either side are of greater precedence.

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

getSyntax, reduceExpr

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

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

Methods inherited from class java.lang.Object

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

Field Details

withOrdinality

public final boolean withOrdinality

Whether WITH ORDINALITY was specified.

If so, the returned records include a column ORDINALITY.

ORDINALITY_COLUMN_NAME

public static final String ORDINALITY_COLUMN_NAME

See Also:

• Constant Field Values

MAP_KEY_COLUMN_NAME

public static final String MAP_KEY_COLUMN_NAME

See Also:

• Constant Field Values

MAP_VALUE_COLUMN_NAME

public static final String MAP_VALUE_COLUMN_NAME

See Also:

• Constant Field Values

Constructor Details

SqlUnnestOperator

public SqlUnnestOperator(boolean withOrdinality)

Method Details

inferReturnType

public RelDataType inferReturnType(SqlOperatorBinding opBinding)

Description copied from class: SqlOperator

Infers the return type of an invocation of this operator; only called after the number and types of operands have already been validated. Subclasses must either override this method or supply an instance of SqlReturnTypeInference to the constructor.

Overrides:

inferReturnType in class SqlOperator

Parameters:

opBinding - description of invocation (not necessarily a SqlCall)

Returns:

inferred return type

unparse

public void unparse(SqlWriter writer,
 SqlCall call,
 int leftPrec,
 int rightPrec)

Description copied from class: SqlOperator

Writes a SQL representation of a call to this operator to a writer, including parentheses if the operators on either side are of greater precedence.

The default implementation of this method delegates to SqlSyntax.unparse(org.apache.calcite.sql.SqlWriter, org.apache.calcite.sql.SqlOperator, org.apache.calcite.sql.SqlCall, int, int).

Overrides:

unparse in class SqlFunctionalOperator

argumentMustBeScalar

public boolean argumentMustBeScalar(int ordinal)

Description copied from class: SqlOperator

Returns whether the ordinalth argument to this operator must be scalar (as opposed to a query).

If true (the default), the validator will attempt to convert the argument into a scalar sub-query, which must have one column and return at most one row.

Operators such as SELECT and EXISTS override this method.

Overrides:

argumentMustBeScalar in class SqlOperator