Package org.apache.druid.sql.calcite.expression

Class OperatorConversions.OperatorBuilder<T extends org.apache.calcite.sql.SqlFunction>

java.lang.Object

org.apache.druid.sql.calcite.expression.OperatorConversions.OperatorBuilder<T>

Direct Known Subclasses:

OperatorConversions.AggregatorBuilder

Enclosing class:

OperatorConversions

public static class OperatorConversions.OperatorBuilder<T extends org.apache.calcite.sql.SqlFunction>
extends Object

Helps in creating the operator builder along with validations and type inference for simple operator conversions. The type checker for this operator conversion can be either supplied manually, or an instance of DefaultOperandTypeChecker will be used if the user passes in operandTypes and other optional parameters. Exactly one of them must be supplied to the builder.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.calcite.sql.SqlFunctionCategory	functionCategory
protected org.apache.calcite.sql.SqlKind	kind
protected final String	name
protected org.apache.calcite.sql.type.SqlReturnTypeInference	returnTypeInference

Method Summary

Modifier and Type	Method	Description
T	build()	Creates a SqlFunction from this builder.
protected org.apache.calcite.sql.type.SqlOperandTypeChecker	buildOperandTypeChecker()
protected org.apache.calcite.sql.type.SqlOperandTypeInference	buildOperandTypeInference()
OperatorConversions.OperatorBuilder<T>	functionCategory(org.apache.calcite.sql.SqlFunctionCategory functionCategory)	Sets the SqlKind of the operator.
OperatorConversions.OperatorBuilder<T>	literalOperands(int... literalOperands)	Equivalent to calling DefaultOperandTypeChecker.Builder.literalOperands(int...); leads to using a DefaultOperandTypeChecker as our operand type checker.
OperatorConversions.OperatorBuilder<T>	operandNames(String... operandNames)	Signifies that a function accepts operands with the provided names.
OperatorConversions.OperatorBuilder<T>	operandTypeChecker(org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker)	Provide customized operand type checking logic.
OperatorConversions.OperatorBuilder<T>	operandTypeInference(org.apache.calcite.sql.type.SqlOperandTypeInference operandTypeInference)
OperatorConversions.OperatorBuilder<T>	operandTypes(org.apache.calcite.sql.type.SqlTypeFamily... operandTypes)	Equivalent to calling DefaultOperandTypeChecker.Builder.operandTypes(SqlTypeFamily...); leads to using a DefaultOperandTypeChecker as our operand type checker.
OperatorConversions.OperatorBuilder<T>	requiredOperandCount(int requiredOperandCount)	Equivalent to calling DefaultOperandTypeChecker.Builder.requiredOperandCount(Integer); leads to using a DefaultOperandTypeChecker as our operand type checker.
OperatorConversions.OperatorBuilder<T>	requiredOperands(int requiredOperands)	Deprecated.
OperatorConversions.OperatorBuilder<T>	returnTypeArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName elementTypeName)	Sets the return type of the operator to an array type with elements of "typeName", marked as nullable.
OperatorConversions.OperatorBuilder<T>	returnTypeCascadeNullable(org.apache.calcite.sql.type.SqlTypeName typeName)	Sets the return type of the operator to "typeName", marked as nullable if any of its operands are nullable.
OperatorConversions.OperatorBuilder<T>	returnTypeInference(org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference)	Provides customized return type inference logic.
OperatorConversions.OperatorBuilder<T>	returnTypeNonNull(org.apache.calcite.sql.type.SqlTypeName typeName)	Sets the return type of the operator to "typeName", marked as non-nullable.
OperatorConversions.OperatorBuilder<T>	returnTypeNullable(org.apache.calcite.sql.type.SqlTypeName typeName)	Sets the return type of the operator to "typeName", marked as nullable.
OperatorConversions.OperatorBuilder<T>	returnTypeNullableArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName elementTypeName)	Sets the return type of the operator to an array type with elements of "typeName", marked as nullable.

Methods inherited from class java.lang.Object

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

Field Details

name

protected final String name

kind

protected org.apache.calcite.sql.SqlKind kind

returnTypeInference

protected org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference

functionCategory

protected org.apache.calcite.sql.SqlFunctionCategory functionCategory

Method Details

returnTypeNonNull

public OperatorConversions.OperatorBuilder<T> returnTypeNonNull(org.apache.calcite.sql.type.SqlTypeName typeName)

Sets the return type of the operator to "typeName", marked as non-nullable. If this method is used it implies the operator should never, ever, return null. One of returnTypeNonNull(org.apache.calcite.sql.type.SqlTypeName), returnTypeNullable(org.apache.calcite.sql.type.SqlTypeName), returnTypeCascadeNullable(SqlTypeName) returnTypeNullableArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName), or returnTypeInference(SqlReturnTypeInference) must be used before calling build(). These methods cannot be mixed; you must call exactly one.

returnTypeNullable

public OperatorConversions.OperatorBuilder<T> returnTypeNullable(org.apache.calcite.sql.type.SqlTypeName typeName)

Sets the return type of the operator to "typeName", marked as nullable. One of returnTypeNonNull(org.apache.calcite.sql.type.SqlTypeName), returnTypeNullable(org.apache.calcite.sql.type.SqlTypeName), returnTypeCascadeNullable(SqlTypeName) returnTypeNullableArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName), or returnTypeInference(SqlReturnTypeInference) must be used before calling build(). These methods cannot be mixed; you must call exactly one.

returnTypeCascadeNullable

public OperatorConversions.OperatorBuilder<T> returnTypeCascadeNullable(org.apache.calcite.sql.type.SqlTypeName typeName)

Sets the return type of the operator to "typeName", marked as nullable if any of its operands are nullable. One of returnTypeNonNull(org.apache.calcite.sql.type.SqlTypeName), returnTypeNullable(org.apache.calcite.sql.type.SqlTypeName), returnTypeCascadeNullable(SqlTypeName) returnTypeNullableArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName), or returnTypeInference(SqlReturnTypeInference) must be used before calling build(). These methods cannot be mixed; you must call exactly one.

returnTypeArrayWithNullableElements

public OperatorConversions.OperatorBuilder<T> returnTypeArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName elementTypeName)

Sets the return type of the operator to an array type with elements of "typeName", marked as nullable. One of returnTypeNonNull(org.apache.calcite.sql.type.SqlTypeName), returnTypeNullable(org.apache.calcite.sql.type.SqlTypeName), returnTypeCascadeNullable(SqlTypeName) returnTypeArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName), or returnTypeInference(SqlReturnTypeInference) must be used before calling build(). These methods cannot be mixed; you must call exactly one.

returnTypeNullableArrayWithNullableElements

public OperatorConversions.OperatorBuilder<T> returnTypeNullableArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName elementTypeName)

Sets the return type of the operator to an array type with elements of "typeName", marked as nullable. One of returnTypeNonNull(org.apache.calcite.sql.type.SqlTypeName), returnTypeNullable(org.apache.calcite.sql.type.SqlTypeName), returnTypeCascadeNullable(SqlTypeName) returnTypeArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName), or returnTypeInference(SqlReturnTypeInference) must be used before calling build(). These methods cannot be mixed; you must call exactly one.

returnTypeInference

public OperatorConversions.OperatorBuilder<T> returnTypeInference(org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference)

Provides customized return type inference logic. One of returnTypeNonNull(org.apache.calcite.sql.type.SqlTypeName), returnTypeNullable(org.apache.calcite.sql.type.SqlTypeName), returnTypeCascadeNullable(SqlTypeName) returnTypeNullableArrayWithNullableElements(org.apache.calcite.sql.type.SqlTypeName), or returnTypeInference(SqlReturnTypeInference) must be used before calling build(). These methods cannot be mixed; you must call exactly one.

functionCategory

public OperatorConversions.OperatorBuilder<T> functionCategory(org.apache.calcite.sql.SqlFunctionCategory functionCategory)

Sets the SqlKind of the operator. The default, if not provided, is SqlFunctionCategory.USER_DEFINED_FUNCTION.

operandTypeChecker

public OperatorConversions.OperatorBuilder<T> operandTypeChecker(org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker)

Provide customized operand type checking logic. Either operandTypes(SqlTypeFamily...) or this method must be used before calling build(). These methods cannot be mixed; you must call exactly one.

operandNames

public OperatorConversions.OperatorBuilder<T> operandNames(String... operandNames)

Signifies that a function accepts operands with the provided names. This is used to implement SqlOperandTypeChecker.getAllowedSignatures(SqlOperator, String). If not provided, the operandTypes are used instead.

operandTypes

public OperatorConversions.OperatorBuilder<T> operandTypes(org.apache.calcite.sql.type.SqlTypeFamily... operandTypes)

Equivalent to calling DefaultOperandTypeChecker.Builder.operandTypes(SqlTypeFamily...); leads to using a DefaultOperandTypeChecker as our operand type checker. May be used in conjunction with requiredOperandCount(int) and literalOperands(int...) in order to further refine operand checking logic. For deeper control, use operandTypeChecker(SqlOperandTypeChecker) instead.

requiredOperandCount

public OperatorConversions.OperatorBuilder<T> requiredOperandCount(int requiredOperandCount)

Equivalent to calling DefaultOperandTypeChecker.Builder.requiredOperandCount(Integer); leads to using a DefaultOperandTypeChecker as our operand type checker.

requiredOperands

@Deprecated
public OperatorConversions.OperatorBuilder<T> requiredOperands(int requiredOperands)

Deprecated.

Alias for requiredOperandCount(int). Deprecated because it means "operand count" rather than "specific operands", and therefore the name can cause confusion with literalOperands(int...). The latter really does mean "specific operands".

literalOperands

public OperatorConversions.OperatorBuilder<T> literalOperands(int... literalOperands)

Equivalent to calling DefaultOperandTypeChecker.Builder.literalOperands(int...); leads to using a DefaultOperandTypeChecker as our operand type checker. Not compatible with operandTypeChecker(SqlOperandTypeChecker).

operandTypeInference

public OperatorConversions.OperatorBuilder<T> operandTypeInference(org.apache.calcite.sql.type.SqlOperandTypeInference operandTypeInference)

build

public T build()

Creates a SqlFunction from this builder.

buildOperandTypeChecker

protected org.apache.calcite.sql.type.SqlOperandTypeChecker buildOperandTypeChecker()

buildOperandTypeInference

protected org.apache.calcite.sql.type.SqlOperandTypeInference buildOperandTypeInference()