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

Class HighlightExec

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

All Implemented Interfaces:

NamedWriteable, Writeable

public class HighlightExec
extends UnaryExec

Nested Class Summary

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

Node.NodeStringFormat

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_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
HighlightExec(Source source, PhysicalPlan child, String prefix, Expression query, List<NamedExpression> fields, MapExpression options, List<Attribute> generatedFields)

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.
boolean	equals(Object obj)
List<NamedExpression>	fields()
List<Attribute>	generatedFields()
String	getWriteableName()
int	hashCode()
protected NodeInfo<HighlightExec>	info()	Normally, you want to use one of the static create methods to implement this.
MapExpression	options()
List<Attribute>	output()	The ordered list of attributes (i.e.
String	prefix()
Expression	query()
HighlightExec	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

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, nodeString, nodeString, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, toString, toString, 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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

HighlightExec

public HighlightExec(Source source,
 PhysicalPlan child,
 String prefix,
 Expression query,
 List<NamedExpression> fields,
 MapExpression options,
 List<Attribute> generatedFields)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

prefix

public String prefix()

query

public Expression query()

fields

public List<NamedExpression> fields()

options

public MapExpression options()

generatedFields

public List<Attribute> generatedFields()

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

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>

replaceChild

public HighlightExec replaceChild(PhysicalPlan newChild)

Specified by:

replaceChild in class UnaryExec

info

protected NodeInfo<HighlightExec> 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<PhysicalPlan>

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryExec

equals

public boolean equals(Object obj)

Overrides:

equals in class UnaryExec