Package org.apache.calcite.sql.fun

Class SqlJsonValueFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.fun.SqlJsonValueFunction

public class SqlJsonValueFunction
extends SqlFunction

The JSON_VALUE function.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	returnAny

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor	Description
SqlJsonValueFunction(java.lang.String name, boolean returnAny)

Method Summary

Modifier and Type	Method	Description
private boolean	canCastFrom(SqlCallBinding callBinding, boolean throwOnFailure, RelDataType inType, RelDataType outType)
boolean	checkOperandTypes(SqlCallBinding callBinding, boolean throwOnFailure)	Checks that the operand values in a SqlCall to this operator are valid.
SqlCall	createCall(SqlLiteral functionQualifier, SqlParserPos pos, SqlNode... operands)	Creates a call to this operand with an array of operands.
SqlOperandCountRange	getOperandCountRange()	Returns a constraint on the number of operands expected by this operator.
java.lang.String	getSignatureTemplate(int operandsCount)	Returns a template describing how the operator signature is to be built.
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.
private boolean	isDefaultLiteral(SqlLiteral literal)
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.
private void	unparseEnum(SqlWriter writer, SqlLiteral literal)

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

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

returnAny

private final boolean returnAny

Constructor Detail

SqlJsonValueFunction

public SqlJsonValueFunction(java.lang.String name,
                            boolean returnAny)

Method Detail

createCall

public SqlCall createCall(SqlLiteral functionQualifier,
                          SqlParserPos pos,
                          SqlNode... operands)

Description copied from class: SqlOperator

Creates a call to this operand with an array of operands.

The position of the resulting call is the union of the pos and the positions of all of the operands.

Overrides:

createCall in class SqlOperator

Parameters:

functionQualifier - function qualifier (e.g. "DISTINCT"), may be

pos - parser position of the identifier of the call

operands - array of operands

getOperandCountRange

public SqlOperandCountRange getOperandCountRange()

Description copied from class: SqlOperator

Returns a constraint on the number of operands expected by this operator. Subclasses may override this method; when they don't, the range is derived from the SqlOperandTypeChecker associated with this operator.

Overrides:

getOperandCountRange in class SqlOperator

Returns:

acceptable range

checkOperandTypes

public boolean checkOperandTypes(SqlCallBinding callBinding,
                                 boolean throwOnFailure)

Description copied from class: SqlOperator

Checks that the operand values in a SqlCall to this operator are valid. Subclasses must either override this method or supply an instance of SqlOperandTypeChecker to the constructor.

Overrides:

checkOperandTypes in class SqlOperator

Parameters:

callBinding - description of call

throwOnFailure - whether to throw an exception if check fails (otherwise returns false in that case)

Returns:

whether check succeeded

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

getSignatureTemplate

public java.lang.String getSignatureTemplate(int operandsCount)

Description copied from class: SqlOperator

Returns a template describing how the operator signature is to be built. E.g for the binary + operator the template looks like "{1} {0} {2}" {0} is the operator, subsequent numbers are operands.

Overrides:

getSignatureTemplate in class SqlOperator

Parameters:

operandsCount - is used with functions that can take a variable number of operands

Returns:

signature template, or null to indicate that a default template will suffice

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 SqlFunction

unparseEnum

private void unparseEnum(SqlWriter writer,
                         SqlLiteral literal)

isDefaultLiteral

private boolean isDefaultLiteral(SqlLiteral literal)

canCastFrom

private boolean canCastFrom(SqlCallBinding callBinding,
                            boolean throwOnFailure,
                            RelDataType inType,
                            RelDataType outType)