Class FieldExtractExec
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.FieldExtractExec
- All Implemented Interfaces:
NamedWriteable,Writeable,EstimatesRowSize
- Direct Known Subclasses:
TimeSeriesFieldExtractExec
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.plan.physical.EstimatesRowSize
EstimatesRowSize.StateNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionAttributes of a shape whose extent can be extracted directly from the doc-values encoded geometry.protected final MappedFieldType.FieldExtractPreferenceThe default forfieldExtractPreference(org.elasticsearch.xpack.esql.core.expression.Attribute)if the plan doesn't require a preference.Attributes that may be extracted as doc values even if that makes them less accurate.static final NamedWriteableRegistry.Entryprotected final Attribute -
Constructor Summary
ConstructorsModifierConstructorDescriptionFieldExtractExec(Source source, PhysicalPlan child, List<Attribute> attributesToExtract, MappedFieldType.FieldExtractPreference defaultPreference) protectedFieldExtractExec(Source source, PhysicalPlan child, List<Attribute> attributesToExtract, MappedFieldType.FieldExtractPreference defaultPreference, Set<Attribute> docValuesAttributes, Set<Attribute> boundsAttributes) -
Method Summary
Modifier and TypeMethodDescriptionprotected AttributeSetThis very likely needs to be overridden forQueryPlan.references()to be correct when inheriting.booleanEstimate the number of bytes that'll be loaded per position before the stream of pages is consumed.static AttributeinthashCode()protected NodeInfo<? extends FieldExtractExec> info()output()The ordered list of attributes (i.e.replaceChild(PhysicalPlan newChild) withBoundsAttributes(Set<Attribute> boundsAttributes) withDocValuesAttributes(Set<Attribute> docValuesAttributes) voidwriteTo(StreamOutput out) Methods inherited from class org.elasticsearch.xpack.esql.plan.physical.UnaryExec
child, inputSet, outputSet, replaceChildrenMethods inherited from class org.elasticsearch.xpack.esql.plan.QueryPlan
computeExpressions, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, references, transformExpressionsDown, transformExpressionsDown, transformExpressionsOnly, transformExpressionsOnly, transformExpressionsOnlyUp, transformExpressionsUp, transformExpressionsUpMethods 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, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp
-
Field Details
-
ENTRY
-
attributesToExtract
-
sourceAttribute
-
defaultPreference
The default forfieldExtractPreference(org.elasticsearch.xpack.esql.core.expression.Attribute)if the plan doesn't require a preference. -
docValuesAttributes
Attributes that may be extracted as doc values even if that makes them less accurate. This is mostly used for geo fields which lose a lot of precision in their doc values, but in some cases doc values provides enough precision to do the job.This is never serialized between nodes and only used locally.
-
boundsAttributes
Attributes of a shape whose extent can be extracted directly from the doc-values encoded geometry.This is never serialized between nodes and only used locally.
-
-
Constructor Details
-
FieldExtractExec
public FieldExtractExec(Source source, PhysicalPlan child, List<Attribute> attributesToExtract, MappedFieldType.FieldExtractPreference defaultPreference) -
FieldExtractExec
protected FieldExtractExec(Source source, PhysicalPlan child, List<Attribute> attributesToExtract, MappedFieldType.FieldExtractPreference defaultPreference, Set<Attribute> docValuesAttributes, Set<Attribute> boundsAttributes)
-
-
Method Details
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
getWriteableName
- Specified by:
getWriteableNamein interfaceNamedWriteable
-
extractSourceAttributesFrom
-
computeReferences
Description copied from class:QueryPlanThis very likely needs to be overridden forQueryPlan.references()to be correct when inheriting. This can be called on unresolved plans and therefore must not rely on calls toQueryPlan.output().- Overrides:
computeReferencesin classQueryPlan<PhysicalPlan>
-
info
- Specified by:
infoin classNode<PhysicalPlan>
-
replaceChild
- Specified by:
replaceChildin classUnaryExec
-
withDocValuesAttributes
-
withBoundsAttributes
-
attributesToExtract
-
sourceAttribute
-
docValuesAttributes
-
boundsAttributes
-
output
Description copied from class:QueryPlanThe 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. -
estimateRowSize
Description copied from interface:EstimatesRowSizeEstimate the number of bytes that'll be loaded per position before the stream of pages is consumed.- Specified by:
estimateRowSizein interfaceEstimatesRowSize- Returns:
-
hashCode
public int hashCode() -
equals
-
nodeString
- Overrides:
nodeStringin classNode<PhysicalPlan>
-
fieldExtractPreference
-