Package org.elasticsearch.xpack.esql.expression.function.scalar.multivalue

Class MvSetOperationFunction

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

org.elasticsearch.xpack.esql.core.expression.function.scalar.BinaryScalarFunction

org.elasticsearch.xpack.esql.expression.function.scalar.multivalue.MvSetOperationFunction

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper

Direct Known Subclasses:

MvDifference, MvIntersection, MvUnion

public abstract class MvSetOperationFunction
extends BinaryScalarFunction
implements EvaluatorMapper

Base class for multi-value set operations.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

EvaluatorMapper.ToEvaluator

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected DataType	dataType

Fields inherited from class org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

MAX_BYTES_REF_RESULT_SIZE

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MvSetOperationFunction(Source source, Expression left, Expression right)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
Object	fold(FoldContext ctx)	Evaluate this expression statically to a constant.
protected static <T> void	processListOperation(Block.Builder builder, int position, Block field1, Block field2, BiFunction<Integer,Block,T> getValue, Consumer<T> addValue, BiConsumer<List<T>,List<T>> combineOp)	Shared collection operation processing logic.
protected static <T> void	processSetOperation(Block.Builder builder, int position, Block field1, Block field2, BiFunction<Integer,Block,T> getValue, Consumer<T> addValue, BiConsumer<Set<T>,Set<T>> combineOp)	Shared set operation processing logic.
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.scalar.BinaryScalarFunction

foldable, left, replaceChildren, replaceChildren, right, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, equals, functionName, hashCode, nodeString, nullable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, nodeName, nodeProperties, nodeString, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

fold, toEvaluator

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Field Details

dataType

protected DataType dataType

Constructor Details

MvSetOperationFunction

protected MvSetOperationFunction(Source source,
 Expression left,
 Expression right)

Method Details

fold

public Object fold(FoldContext ctx)

Description copied from class: Expression

Evaluate this expression statically to a constant. It is an error to call this if Expression.foldable() returns false.

Overrides:

fold in class Expression

dataType

public DataType dataType()

Description copied from class: Expression

The DataType returned by executing the tree rooted at this expression. If Expression.typeResolved() returns an error then the behavior of this method is undefined. It may return a valid type. Or it may throw an exception. Or it may return a totally nonsensical type.

Specified by:

dataType in class Expression

resolveType

protected Expression.TypeResolution resolveType()

Description copied from class: Expression

The implementation of Expression.typeResolved(), which is just a caching wrapper around this method. See it's javadoc for what this method should return.

Implementations will rarely interact with the Expression.TypeResolution class directly, instead usually calling the utility methods on TypeResolutions.

Implementations should fail if Expression.childrenResolved() returns false.

Overrides:

resolveType in class Expression

processSetOperation

protected static <T> void processSetOperation(Block.Builder builder,
 int position,
 Block field1,
 Block field2,
 BiFunction<Integer,Block,T> getValue,
 Consumer<T> addValue,
 BiConsumer<Set<T>,Set<T>> combineOp)

Shared set operation processing logic.

processListOperation

protected static <T> void processListOperation(Block.Builder builder,
 int position,
 Block field1,
 Block field2,
 BiFunction<Integer,Block,T> getValue,
 Consumer<T> addValue,
 BiConsumer<List<T>,List<T>> combineOp)

Shared collection operation processing logic.