org.apache.calcite.sql.fun

Class SqlGroupFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.fun.SqlGroupFunction

public class SqlGroupFunction
extends org.apache.calcite.sql.SqlFunction

SQL function that computes keys by which rows can be partitioned and aggregated.

Grouped window functions always occur in the GROUP BY clause. They often have auxiliary functions that access information about the group. For example, HOP is a group function, and its auxiliary functions are HOP_START and HOP_END. Here they are used in a streaming query:

 SELECT STREAM HOP_START(rowtime, INTERVAL '1' HOUR),
   HOP_END(rowtime, INTERVAL '1' HOUR),
   MIN(unitPrice)
 FROM Orders
 GROUP BY HOP(rowtime, INTERVAL '1' HOUR), productId
 

Field Summary

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor and Description
SqlGroupFunction(org.apache.calcite.sql.SqlKind kind, SqlGroupFunction groupFunction, org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker) Creates a SqlGroupFunction.
SqlGroupFunction(String name, org.apache.calcite.sql.SqlKind kind, SqlGroupFunction groupFunction, org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker) Creates a SqlGroupFunction.
SqlGroupFunction(String name, org.apache.calcite.sql.SqlKind kind, SqlGroupFunction groupFunction, org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference, org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker) Creates a SqlGroupFunction.

Method Summary

Modifier and Type	Method and Description
SqlGroupFunction	auxiliary(org.apache.calcite.sql.SqlKind kind) Creates an auxiliary function from this grouped window function.
SqlGroupFunction	auxiliary(String name, org.apache.calcite.sql.SqlKind kind) Creates an auxiliary function from this grouped window function.
List<SqlGroupFunction>	getAuxiliaryFunctions() Returns a list of this grouped window function's auxiliary functions.
org.apache.calcite.sql.validate.SqlMonotonicity	getMonotonicity(org.apache.calcite.sql.SqlOperatorBinding call)
boolean	isGroup()
boolean	isGroupAuxiliary()

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

deriveType, getFunctionType, getNameAsId, getParamNames, 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, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getName, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, hashCode, inferReturnType, inferReturnType, isAggregator, isDeterministic, isDynamicFunction, 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

Constructor Detail

SqlGroupFunction

public SqlGroupFunction(String name,
                        org.apache.calcite.sql.SqlKind kind,
                        SqlGroupFunction groupFunction,
                        org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker)

Creates a SqlGroupFunction.

Parameters:

name - Function name

kind - Kind

groupFunction - Group function, if this is an auxiliary; null, if this is a group function

operandTypeChecker - Operand type checker

SqlGroupFunction

public SqlGroupFunction(org.apache.calcite.sql.SqlKind kind,
                        SqlGroupFunction groupFunction,
                        org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker)

Creates a SqlGroupFunction.

Parameters:

kind - Kind; also determines function name

groupFunction - Group function, if this is an auxiliary; null, if this is a group function

operandTypeChecker - Operand type checker

SqlGroupFunction

public SqlGroupFunction(String name,
                        org.apache.calcite.sql.SqlKind kind,
                        SqlGroupFunction groupFunction,
                        org.apache.calcite.sql.type.SqlReturnTypeInference returnTypeInference,
                        org.apache.calcite.sql.type.SqlOperandTypeChecker operandTypeChecker)

Creates a SqlGroupFunction.

Parameters:

name - Function name

kind - Kind

groupFunction - Group function, if this is an auxiliary; null, if this is a group function

returnTypeInference - Inference of the functions return type

operandTypeChecker - Operand type checker

Method Detail

auxiliary

public SqlGroupFunction auxiliary(org.apache.calcite.sql.SqlKind kind)

Creates an auxiliary function from this grouped window function.

Parameters:

kind - Kind; also determines function name

auxiliary

public SqlGroupFunction auxiliary(String name,
                                  org.apache.calcite.sql.SqlKind kind)

Creates an auxiliary function from this grouped window function.

Parameters:

name - Function name

kind - Kind

getAuxiliaryFunctions

public List<SqlGroupFunction> getAuxiliaryFunctions()

Returns a list of this grouped window function's auxiliary functions.

isGroup

public boolean isGroup()

Overrides:

isGroup in class org.apache.calcite.sql.SqlOperator

isGroupAuxiliary

public boolean isGroupAuxiliary()

Overrides:

isGroupAuxiliary in class org.apache.calcite.sql.SqlOperator

getMonotonicity

public org.apache.calcite.sql.validate.SqlMonotonicity getMonotonicity(org.apache.calcite.sql.SqlOperatorBinding call)

Overrides:

getMonotonicity in class org.apache.calcite.sql.SqlOperator