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

Class EsStatsQueryExec

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

org.elasticsearch.xpack.esql.plan.physical.EsStatsQueryExec

All Implemented Interfaces:

NamedWriteable, Writeable, DataSourceExec, EstimatesRowSize

public class EsStatsQueryExec
extends LeafExec
implements EstimatesRowSize, DataSourceExec

Specialized query class for retrieving statistics about the underlying data and not the actual documents. For that see EsQueryExec

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EsStatsQueryExec.BasicStat
static final record	EsStatsQueryExec.ByStat
static interface	EsStatsQueryExec.Stat
static enum	EsStatsQueryExec.StatsType

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.plan.physical.EstimatesRowSize

EstimatesRowSize.State

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

Constructor Summary

Constructors

Constructor	Description
EsStatsQueryExec(Source source, String indexPattern, QueryBuilder query, Expression limit, List<Attribute> attributes, EsStatsQueryExec.Stat stat)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
PhysicalPlan	estimateRowSize(EstimatesRowSize.State state)	Estimate the number of bytes that'll be loaded per position before the stream of pages is consumed.
String	getWriteableName()
int	hashCode()
protected NodeInfo<EsStatsQueryExec>	info()	Normally, you want to use one of the static create methods to implement this.
Expression	limit()
void	nodeString(StringBuilder sb, Node.NodeStringFormat format)	Append this Node's string representation to sb.
List<Attribute>	output()	The ordered list of attributes (i.e.
QueryBuilder	query()
EsStatsQueryExec.Stat	stat()
void	writeTo(StreamOutput out)

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

computeReferences, replaceChildren

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

computeExpressions, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, inputSet, outputSet, 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, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, 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

Methods inherited from interface org.elasticsearch.xpack.esql.plan.physical.DataSourceExec

source

Constructor Details

EsStatsQueryExec

public EsStatsQueryExec(Source source,
 String indexPattern,
 @Nullable
 QueryBuilder query,
 Expression limit,
 List<Attribute> attributes,
 EsStatsQueryExec.Stat stat)

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

info

protected NodeInfo<EsStatsQueryExec> 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>

query

@Nullable
public QueryBuilder query()

stat

public EsStatsQueryExec.Stat stat()

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.

Specified by:

output in interface DataSourceExec

Specified by:

output in class QueryPlan<PhysicalPlan>

limit

public Expression limit()

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

hashCode

public int hashCode()

Specified by:

hashCode in class PhysicalPlan

equals

public boolean equals(Object obj)

Specified by:

equals in class PhysicalPlan

nodeString

public void nodeString(StringBuilder sb,
 Node.NodeStringFormat format)

Description copied from class: Node

Append this Node's string representation to sb. This does not include this node's Node.children().

Overrides:

nodeString in class Node<PhysicalPlan>

Parameters:

sb - target for the string

format - configuration for rendering the string representation