Package org.apache.druid.query.expression

Class TimestampExtractExprMacro.TimestampExtractExpr

java.lang.Object

org.apache.druid.math.expr.ExprMacroTable.BaseMacroFunctionExpr

org.apache.druid.math.expr.ExprMacroTable.BaseScalarMacroFunctionExpr

org.apache.druid.query.expression.TimestampExtractExprMacro.TimestampExtractExpr

All Implemented Interfaces:

Cacheable, Expr, ExprMacroTable.ExprMacroFunctionExpr

Enclosing class:

TimestampExtractExprMacro

public class TimestampExtractExprMacro.TimestampExtractExpr
extends ExprMacroTable.BaseScalarMacroFunctionExpr

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.druid.math.expr.Expr

Expr.BindingAnalysis, Expr.InputBindingInspector, Expr.ObjectBinding, Expr.Shuttle, Expr.VectorInputBinding, Expr.VectorInputBindingInspector

Field Summary

Fields inherited from class org.apache.druid.math.expr.ExprMacroTable.BaseMacroFunctionExpr

args, macro

Fields inherited from interface org.apache.druid.math.expr.Expr

ARG_JOINER, NULL_LITERAL

Method Summary

Modifier and Type	Method	Description
<T> ExprVectorProcessor<T>	asVectorProcessor(Expr.VectorInputBindingInspector inspector)	Builds a 'vectorized' expression processor, that can operate on batches of input values for use in vectorized query engines.
boolean	canVectorize(Expr.InputBindingInspector inspector)	Check if an expression can be 'vectorized', for a given set of inputs.
ExprEval	eval(Expr.ObjectBinding bindings)	Evaluate the Expr with the bindings which supply IdentifierExpr with their values, producing an ExprEval with the result.
ExpressionType	getOutputType(Expr.InputBindingInspector inspector)	Given an Expr.InputBindingInspector, compute what the output ExpressionType will be for this expression.

Methods inherited from class org.apache.druid.math.expr.ExprMacroTable.BaseScalarMacroFunctionExpr

supplyAnalyzeInputs

Methods inherited from class org.apache.druid.math.expr.ExprMacroTable.BaseMacroFunctionExpr

analyzeInputs, equals, getArgs, hashCode, stringify, toString, visit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.math.expr.Expr

asBitmapColumnIndex, asColumnIndexSupplier, asSingleThreaded, decorateCacheKeyBuilder, getBindingIfIdentifier, getCacheKey, getIdentifierExprIfIdentifierExpr, getIdentifierIfIdentifier, getLiteralValue, isIdentifier, isLiteral, isNullLiteral, rewriteBindings

Method Details

eval

@Nonnull
public ExprEval eval(Expr.ObjectBinding bindings)

Description copied from interface: Expr

Evaluate the Expr with the bindings which supply IdentifierExpr with their values, producing an ExprEval with the result.

getOutputType

@Nullable
public ExpressionType getOutputType(Expr.InputBindingInspector inspector)

Description copied from interface: Expr

Given an Expr.InputBindingInspector, compute what the output ExpressionType will be for this expression. In the vectorized expression engine, if Expr.canVectorize(InputBindingInspector) returns true, a return value of null MUST ONLY indicate that the expression has all null inputs (non-existent columns) or null constants for the entire expression. Otherwise, all vectorizable expressions must produce an output type to correctly operate with the vectorized engine. Outside the context of vectorized expressions, a return value of null can also indicate that the given type information was not enough to resolve the output type, so the expression must be evaluated using default Expr.eval(org.apache.druid.math.expr.Expr.ObjectBinding) handling where types are only known after evaluation, through ExprEval.type(), such as transform expressions at ingestion time

canVectorize

public boolean canVectorize(Expr.InputBindingInspector inspector)

Description copied from interface: Expr

Check if an expression can be 'vectorized', for a given set of inputs. If this method returns true, Expr.asVectorProcessor(org.apache.druid.math.expr.Expr.VectorInputBindingInspector) is expected to produce a ExprVectorProcessor which can evaluate values in batches to use with vectorized query engines.

Note that this method is insufficient by itself for determining to use vector processors, as it only checks whether the expression tree itself supports vectorization, but ignores schema-level constraints that ExpressionPlanner enforces.

Most callers should instead prefer to use ExpressionPlanner.plan(ColumnInspector, Expr) and check for ExpressionPlan.Trait.VECTORIZABLE on the resulting plan.

Specified by:

canVectorize in interface Expr

Overrides:

canVectorize in class ExprMacroTable.BaseMacroFunctionExpr

asVectorProcessor

public <T> ExprVectorProcessor<T> asVectorProcessor(Expr.VectorInputBindingInspector inspector)

Description copied from interface: Expr

Builds a 'vectorized' expression processor, that can operate on batches of input values for use in vectorized query engines.

Specified by:

asVectorProcessor in interface Expr

Overrides:

asVectorProcessor in class ExprMacroTable.BaseMacroFunctionExpr