Package org.elasticsearch.xpack.esql.plan.physical

Class EnrichExec

java.lang.Object

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

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

org.elasticsearch.xpack.esql.plan.physical.PhysicalPlan

org.elasticsearch.xpack.esql.plan.physical.UnaryExec

org.elasticsearch.xpack.esql.plan.physical.EnrichExec

All Implemented Interfaces:

NamedWriteable, Writeable, ExecutesOn, EstimatesRowSize

public class EnrichExec
extends UnaryExec
implements EstimatesRowSize, ExecutesOn

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.plan.physical.EstimatesRowSize

EstimatesRowSize.State

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

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
EnrichExec(Source source, PhysicalPlan child, Enrich.Mode mode, String matchType, NamedExpression matchField, String policyName, String policyMatchField, 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)
PhysicalPlan	estimateRowSize(EstimatesRowSize.State state)	Estimate the number of bytes that'll be loaded per position before the stream of pages is consumed.
ExecutesOn.ExecuteLocation	executesOn()
String	getWriteableName()
int	hashCode()
protected NodeInfo<EnrichExec>	info()
NamedExpression	matchField()
String	matchType()
Enrich.Mode	mode()
List<Attribute>	output()	The ordered list of attributes (i.e.
String	policyMatchField()
String	policyName()
EnrichExec	replaceChild(PhysicalPlan newChild)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.plan.physical.UnaryExec

child, inputSet, outputSet, replaceChildren

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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

EnrichExec

public EnrichExec(Source source,
 PhysicalPlan child,
 Enrich.Mode mode,
 String matchType,
 NamedExpression matchField,
 String policyName,
 String policyMatchField,
 Map<String,String> concreteIndices,
 List<NamedExpression> enrichFields)

Parameters:

matchField - the match field in the source data

policyName - the enrich policy name

policyMatchField - the match field name in the policy

concreteIndices - a map from cluster to concrete enrich indices

enrichFields - the enrich fields

Method Details

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

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<PhysicalPlan>

info

protected NodeInfo<EnrichExec> info()

Specified by:

info in class Node<PhysicalPlan>

replaceChild

public EnrichExec replaceChild(PhysicalPlan newChild)

Specified by:

replaceChild in class UnaryExec

mode

public Enrich.Mode mode()

matchType

public String matchType()

matchField

public NamedExpression matchField()

concreteIndices

public Map<String,String> concreteIndices()

enrichFields

public List<NamedExpression> enrichFields()

policyName

public String policyName()

policyMatchField

public String policyMatchField()

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 UnaryExec

estimateRowSize

public PhysicalPlan estimateRowSize(EstimatesRowSize.State state)

Description copied from interface: EstimatesRowSize

Estimate the number of bytes that'll be loaded per position before the stream of pages is consumed.

Specified by:

estimateRowSize in interface EstimatesRowSize

Returns:

equals

public boolean equals(Object o)

Overrides:

equals in class UnaryExec

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryExec

executesOn

public ExecutesOn.ExecuteLocation executesOn()

Specified by:

executesOn in interface ExecutesOn