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

Class Enrich

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.Enrich

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisVerificationAware, PostOptimizationVerificationAware, PostOptimizationVerificationAware.CoordinatorOnly, TelemetryAware, Resolvable, GeneratingPlan<Enrich>, ExecutesOn, SortAgnostic, Streaming

public class Enrich
extends UnaryPlan
implements GeneratingPlan<Enrich>, PostOptimizationVerificationAware.CoordinatorOnly, PostAnalysisVerificationAware, TelemetryAware, Streaming, SortAgnostic, ExecutesOn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Enrich.Mode

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.xpack.esql.capabilities.PostOptimizationVerificationAware

PostOptimizationVerificationAware.CoordinatorOnly

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
static final NamedWriteableRegistry.Entry	ENTRY

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Enrich(Source source, LogicalPlan child, Enrich.Mode mode, Expression policyName, NamedExpression matchField, EnrichPolicy policy, Map<String,String> concreteIndices, List<NamedExpression> enrichFields)

Method Summary

Modifier and Type	Method	Description
protected AttributeSet	computeReferences()	This very likely needs to be overridden for QueryPlan.references() to be correct when inheriting.
Map<String,String>	concreteIndices()
List<NamedExpression>	enrichFields()
boolean	equals(Object o)
ExecutesOn.ExecuteLocation	executesOn()
boolean	expressionsResolved()
List<Attribute>	generatedAttributes()
String	getWriteableName()
int	hashCode()
protected NodeInfo<? extends LogicalPlan>	info()
NamedExpression	matchField()
Enrich.Mode	mode()
List<Attribute>	output()	The ordered list of attributes (i.e.
EnrichPolicy	policy()
Expression	policyName()
void	postAnalysisVerification(Failures failures)	Allows the implementer to validate itself.
void	postOptimizationVerification(Failures failures)	Validates the implementing expression - discovered failures are reported to the given Failures class.
UnaryPlan	replaceChild(LogicalPlan newChild)
String	resolvedPolicyName()
Enrich	withGeneratedNames(List<String> newNames)	Create a new instance of this node with new output Attributes using the given names.
void	writeTo(StreamOutput out)

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

child, inputSet, 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, 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, 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.GeneratingPlan

checkNumberOfNewNames

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

telemetryLabel

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

Enrich

public Enrich(Source source,
 LogicalPlan child,
 Enrich.Mode mode,
 Expression policyName,
 NamedExpression matchField,
 EnrichPolicy policy,
 Map<String,String> concreteIndices,
 List<NamedExpression> enrichFields)

Method Details

executesOn

public ExecutesOn.ExecuteLocation executesOn()

Specified by:

executesOn in interface ExecutesOn

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

matchField

public NamedExpression matchField()

enrichFields

public List<NamedExpression> enrichFields()

policy

public EnrichPolicy policy()

concreteIndices

public Map<String,String> concreteIndices()

policyName

public Expression policyName()

resolvedPolicyName

public String resolvedPolicyName()

mode

public Enrich.Mode mode()

computeReferences

protected AttributeSet computeReferences()

Description copied from class: QueryPlan

This very likely needs to be overridden for QueryPlan.references() to be correct when inheriting. This can be called on unresolved plans and therefore must not rely on calls to QueryPlan.output().

Overrides:

computeReferences in class QueryPlan<LogicalPlan>

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

replaceChild

public UnaryPlan replaceChild(LogicalPlan newChild)

Specified by:

replaceChild in class UnaryPlan

info

protected NodeInfo<? extends LogicalPlan> info()

Specified by:

info in class Node<LogicalPlan>

output

public List<Attribute> output()

Description copied from class: QueryPlan

The ordered list of attributes (i.e. columns) this plan produces when executed. Must be called only on resolved plans, otherwise may throw an exception or return wrong results.

Overrides:

output in class UnaryPlan

generatedAttributes

public List<Attribute> generatedAttributes()

Specified by:

generatedAttributes in interface GeneratingPlan<Enrich>

withGeneratedNames

public Enrich withGeneratedNames(List<String> newNames)

Description copied from interface: GeneratingPlan

Create a new instance of this node with new output Attributes using the given names. If an output attribute already has the desired name, we continue using it; otherwise, we create a new attribute with a new NameId.

Specified by:

withGeneratedNames in interface GeneratingPlan<Enrich>

equals

public boolean equals(Object o)

Overrides:

equals in class UnaryPlan

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryPlan

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.

postOptimizationVerification

public void postOptimizationVerification(Failures failures)

Description copied from interface: PostOptimizationVerificationAware

Validates the implementing expression - discovered failures are reported to the given Failures class.

Example: the Bucket function, which produces buckets over a numerical or date field, based on a number of literal arguments needs to check if its arguments are all indeed literals. This is how this verification is performed:

     

      @Override
      public void postOptimizationVerification(Failures failures) {
          String operation = sourceText();

          failures.add(isFoldable(buckets, operation, SECOND))
              .add(from != null ? isFoldable(from, operation, THIRD) : null)
              .add(to != null ? isFoldable(to, operation, FOURTH) : null);
      }
     
     

Specified by:

postOptimizationVerification in interface PostOptimizationVerificationAware