org.apache.druid.sql.calcite.expression

Class OperatorConversions.OperatorBuilder

java.lang.Object

org.apache.druid.sql.calcite.expression.OperatorConversions.OperatorBuilder

Enclosing class:

OperatorConversions

public static class OperatorConversions.OperatorBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
org.apache.calcite.sql.SqlFunction	build() Creates a SqlFunction from this builder.
OperatorConversions.OperatorBuilder	functionCategory(org.apache.calcite.sql.SqlFunctionCategory functionCategory) Sets the SqlKind of the operator.
OperatorConversions.OperatorBuilder	literalOperands(int... literalOperands) Signifies that the operands at positions given by literalOperands must be literals.
OperatorConversions.OperatorBuilder	operandTypeChecker(org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker) Provides customized operand type checking logic.
OperatorConversions.OperatorBuilder	operandTypeInference(org.apache.calcite.sql.type.SqlOperandTypeInference operandTypeInference)
OperatorConversions.OperatorBuilder	operandTypes(org.apache.calcite.sql.type.SqlTypeFamily... operandTypes) Signifies that a function accepts operands of type family given by .
OperatorConversions.OperatorBuilder	requiredOperands(int requiredOperands) Signifies that the first requiredOperands operands are required, and all later operands are optional.
OperatorConversions.OperatorBuilder	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	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	returnTypeInference(org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference) Provides customized return type inference logic.
OperatorConversions.OperatorBuilder	returnTypeNonNull(org.apache.calcite.sql.type.SqlTypeName typeName) Sets the return type of the operator to "typeName", marked as non-nullable.
OperatorConversions.OperatorBuilder	returnTypeNullable(org.apache.calcite.sql.type.SqlTypeName typeName) Sets the return type of the operator to "typeName", marked as nullable.
OperatorConversions.OperatorBuilder	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

Method Detail

returnTypeNonNull

public OperatorConversions.OperatorBuilder 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 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 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 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 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 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 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 operandTypeChecker(org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker)

Provides customized operand type checking logic. One of operandTypes(SqlTypeFamily...) or operandTypeChecker(SqlOperandTypeChecker) must be used before calling build(). These methods cannot be mixed; you must call exactly one.

operandTypes

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

Signifies that a function accepts operands of type family given by . May be used in conjunction with requiredOperands(int) and literalOperands(int...) in order to further refine operand checking logic. For deeper control, use operandTypeChecker(SqlOperandTypeChecker) instead.

requiredOperands

public OperatorConversions.OperatorBuilder requiredOperands(int requiredOperands)

Signifies that the first requiredOperands operands are required, and all later operands are optional. Required operands are not allowed to be null. Optional operands can either be skipped or explicitly provided as literal NULLs. For example, if requiredOperands == 1, then F(x, NULL) and F(x) are both accepted, and x must not be null. Must be used in conjunction with operandTypes(SqlTypeFamily...); this method is not compatible with operandTypeChecker(SqlOperandTypeChecker).

literalOperands

public OperatorConversions.OperatorBuilder literalOperands(int... literalOperands)

Signifies that the operands at positions given by literalOperands must be literals. Must be used in conjunction with operandTypes(SqlTypeFamily...); this method is not compatible with operandTypeChecker(SqlOperandTypeChecker).

operandTypeInference

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

build

public org.apache.calcite.sql.SqlFunction build()

Creates a SqlFunction from this builder.