Package org.elasticsearch.xpack.esql.plan.logical.fuse

Class Fuse

java.lang.Object

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

org.elasticsearch.xpack.esql.plan.QueryPlan<LogicalPlan>

org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

org.elasticsearch.xpack.esql.plan.logical.UnaryPlan

org.elasticsearch.xpack.esql.plan.logical.fuse.Fuse

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisVerificationAware, TelemetryAware, Resolvable, ExecutesOn, ExecutesOn.Coordinator

public class Fuse
extends UnaryPlan
implements TelemetryAware, PostAnalysisVerificationAware, ExecutesOn.Coordinator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Fuse.FuseType

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

LogicalPlan.Stage

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.plan.logical.ExecutesOn

ExecutesOn.Coordinator, ExecutesOn.ExecuteLocation, ExecutesOn.Remote

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

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

Field Summary

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Fuse(Source source, LogicalPlan child, Attribute score, Attribute discriminator, List<NamedExpression> keys, Fuse.FuseType fuseType, MapExpression options)

Method Summary

Modifier and Type	Method	Description
Attribute	discriminator()
boolean	expressionsResolved()
Fuse.FuseType	fuseType()
String	getWriteableName()
protected NodeInfo<? extends LogicalPlan>	info()	Normally, you want to use one of the static create methods to implement this.
List<NamedExpression>	keys()
MapExpression	options()
void	postAnalysisVerification(Failures failures)	Allows the implementer to validate itself.
UnaryPlan	replaceChild(LogicalPlan newChild)
Attribute	score()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.UnaryPlan

child, equals, hashCode, inputSet, output, outputSet, replaceChildren

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

analyzed, childrenResolved, optimized, preAnalyzed, preOptimized, resolved, setAnalyzed, setOptimized, setPreAnalyzed, setPreOptimized

Methods inherited from class org.elasticsearch.xpack.esql.plan.QueryPlan

computeExpressions, computeReferences, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, references, transformExpressionsDown, transformExpressionsDown, transformExpressionsOnly, transformExpressionsOnly, transformExpressionsOnlyUp, transformExpressionsUp, transformExpressionsUp

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

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, nodeString, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, transformChildren, transformDown, transformDown, transformDown, 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.plan.logical.ExecutesOn.Coordinator

executesOn

Methods inherited from interface org.elasticsearch.xpack.esql.capabilities.TelemetryAware

telemetryLabel

Constructor Details

Fuse

public Fuse(Source source,
 LogicalPlan child,
 Attribute score,
 Attribute discriminator,
 List<NamedExpression> keys,
 Fuse.FuseType fuseType,
 MapExpression options)

Method Details

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

info

protected NodeInfo<? extends LogicalPlan> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Specified by:

info in class Node<LogicalPlan>

replaceChild

public UnaryPlan replaceChild(LogicalPlan newChild)

Specified by:

replaceChild in class UnaryPlan

keys

public List<NamedExpression> keys()

discriminator

public Attribute discriminator()

score

public Attribute score()

fuseType

public Fuse.FuseType fuseType()

options

public MapExpression options()

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

postAnalysisVerification

public void postAnalysisVerification(Failures failures)

Description copied from interface: PostAnalysisVerificationAware

Allows the implementer to validate itself. This usually involves checking its internal setup, which often means checking the parameters it received on construction: their data or syntactic type, class, their count, expressions' structure etc. The discovered failures are added to the given Failures object.

It is often more useful to perform the checks as extended as it makes sense, over stopping at the first failure. This will allow the author to progress faster to a correct query.

Example: the Filter class, which models the WHERE command, checks that the expression it filters on - condition - is of a Boolean or NULL type:

     
     @Override
     void postAnalysisVerification(Failures failures) {
          if (condition.dataType() != NULL && condition.dataType() != BOOLEAN) {
              failures.add(fail(condition, "Condition expression needs to be boolean, found [{}]", condition.dataType()));
          }
     }
     
     

Specified by:

postAnalysisVerification in interface PostAnalysisVerificationAware

Parameters:

failures - the object to add failures to.