Package org.elasticsearch.xpack.esql.planner

Class PlannerUtils

java.lang.Object

org.elasticsearch.xpack.esql.planner.PlannerUtils

public class PlannerUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PlannerUtils.LocalPlanResult	Result of local plan optimization containing both physical and logical plans.
static interface	PlannerUtils.PlanReduction
static final record	PlannerUtils.ReducedPlan
static enum	PlannerUtils.SimplePlanReduction
static final record	PlannerUtils.TopNReduction	The plan here is used as a fallback if the reduce driver cannot be planned in a way that avoids field extraction after TopN.

Field Summary

Fields

Modifier and Type	Field	Description
static final BlockFactory	NON_BREAKING_BLOCK_FACTORY	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
PlannerUtils()

Method Summary

Modifier and Type	Method	Description
static org.elasticsearch.core.Tuple<PhysicalPlan,PhysicalPlan>	breakPlanBetweenCoordinatorAndDataNode(PhysicalPlan plan, Configuration config)
static org.elasticsearch.core.Tuple<List<PhysicalPlan>,PhysicalPlan>	breakPlanIntoSubPlansAndMainPlan(PhysicalPlan plan)	When the plan contains children like MergeExec resulted from the planning of commands such as FORK, we need to break the plan into sub plans and a main coordinator plan.
static QueryBuilder	canMatchFilter(EsqlFlags flags, Configuration configuration, TransportVersion minTransportVersion, PhysicalPlan plan)	Extracts a filter that can be used to skip unmatched shards on the coordinator.
static void	forEachRelation(PhysicalPlan plan, Consumer<EsRelation> action)
static boolean	hasLimitedInput(LogicalPlan plan)	Checks that the input rows of the plan have been reduced by LIMIT.
static PhysicalPlan	integrateEsFilterIntoFragment(PhysicalPlan plan, QueryBuilder esFilter)
static PhysicalPlan	localPlan(PhysicalPlan plan, LocalLogicalPlanOptimizer logicalOptimizer, LocalPhysicalPlanOptimizer physicalOptimizer, PlanTimeProfile planTimeProfile)
static PhysicalPlan	localPlan(PhysicalPlan plan, LocalLogicalPlanOptimizer logicalOptimizer, LocalPhysicalPlanOptimizer physicalOptimizer, PlanTimeProfile planTimeProfile, Consumer<LogicalPlan> onLogicalPlanOptimized)
static PhysicalPlan	localPlan(PlannerSettings plannerSettings, EsqlFlags flags, List<SearchExecutionContext> searchContexts, Configuration configuration, FoldContext foldCtx, PhysicalPlan plan, PlanTimeProfile planTimeProfile)
static PhysicalPlan	localPlan(PlannerSettings plannerSettings, EsqlFlags flags, Configuration configuration, FoldContext foldCtx, PhysicalPlan plan, SearchStats searchStats, PlanTimeProfile planTimeProfile)
static PhysicalPlan	localPlan(PlannerSettings plannerSettings, EsqlFlags flags, Configuration configuration, FoldContext foldCtx, PhysicalPlan plan, SearchStats searchStats, FilterPushdownRegistry filterPushdownRegistry, PlanTimeProfile planTimeProfile)
static PhysicalPlan	localPlan(PlannerSettings plannerSettings, EsqlFlags flags, Configuration configuration, FoldContext foldCtx, PhysicalPlan plan, SearchStats searchStats, FilterPushdownRegistry filterPushdownRegistry, FormatReaderRegistry formatReaderRegistry, PlanTimeProfile planTimeProfile)
static PlannerUtils.LocalPlanResult	localPlanWithLogical(PhysicalPlan plan, LocalLogicalPlanOptimizer logicalOptimizer, LocalPhysicalPlanOptimizer physicalOptimizer, PlanTimeProfile planTimeProfile)
static PlannerUtils.LocalPlanResult	localPlanWithLogical(PlannerSettings plannerSettings, EsqlFlags flags, List<SearchExecutionContext> searchContexts, Configuration configuration, FoldContext foldCtx, PhysicalPlan plan, PlanTimeProfile planTimeProfile)
static PlannerUtils.LocalPlanResult	localPlanWithLogical(PlannerSettings plannerSettings, EsqlFlags flags, Configuration configuration, FoldContext foldCtx, PhysicalPlan plan, SearchStats searchStats, PlanTimeProfile planTimeProfile)
static PlannerUtils.PlanReduction	reductionPlan(PhysicalPlan plan)
static ElementType	toElementType(DataType dataType)	Map QL's DataType to the compute engine's ElementType.
static ElementType	toElementType(DataType dataType, MappedFieldType.FieldExtractPreference fieldExtractPreference)	Map QL's DataType to the compute engine's ElementType.
static ElementType	toSortableElementType(DataType dataType)	Map QL's DataType to the compute engine's ElementType, for sortable types only.
static boolean	usesScoring(QueryPlan<?> plan)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NON_BREAKING_BLOCK_FACTORY

@Deprecated(forRemoval=true)
public static final BlockFactory NON_BREAKING_BLOCK_FACTORY

Deprecated, for removal: This API element is subject to removal in a future version.

A non-breaking block factory used to create small pages during the planning TODO: Remove this

Constructor Details

PlannerUtils

public PlannerUtils()

Method Details

breakPlanIntoSubPlansAndMainPlan

public static org.elasticsearch.core.Tuple<List<PhysicalPlan>,PhysicalPlan> breakPlanIntoSubPlansAndMainPlan(PhysicalPlan plan)

When the plan contains children like MergeExec resulted from the planning of commands such as FORK, we need to break the plan into sub plans and a main coordinator plan. The result pages from each sub plan will be funneled to the main coordinator plan. To achieve this, we wire each sub plan with a ExchangeSinkExec and add a ExchangeSourceExec to the main coordinator plan. There is an additional split of each sub plan into a data node plan and coordinator plan. This split is not done here, but as part of PlannerUtils#breakPlanBetweenCoordinatorAndDataNode.

breakPlanBetweenCoordinatorAndDataNode

public static org.elasticsearch.core.Tuple<PhysicalPlan,PhysicalPlan> breakPlanBetweenCoordinatorAndDataNode(PhysicalPlan plan,
 Configuration config)

reductionPlan

public static PlannerUtils.PlanReduction reductionPlan(PhysicalPlan plan)

forEachRelation

public static void forEachRelation(PhysicalPlan plan,
 Consumer<EsRelation> action)

localPlanWithLogical

public static PlannerUtils.LocalPlanResult localPlanWithLogical(PlannerSettings plannerSettings,
 EsqlFlags flags,
 List<SearchExecutionContext> searchContexts,
 Configuration configuration,
 FoldContext foldCtx,
 PhysicalPlan plan,
 PlanTimeProfile planTimeProfile)

localPlanWithLogical

public static PlannerUtils.LocalPlanResult localPlanWithLogical(PlannerSettings plannerSettings,
 EsqlFlags flags,
 Configuration configuration,
 FoldContext foldCtx,
 PhysicalPlan plan,
 SearchStats searchStats,
 PlanTimeProfile planTimeProfile)

localPlanWithLogical

public static PlannerUtils.LocalPlanResult localPlanWithLogical(PhysicalPlan plan,
 LocalLogicalPlanOptimizer logicalOptimizer,
 LocalPhysicalPlanOptimizer physicalOptimizer,
 PlanTimeProfile planTimeProfile)

localPlan

public static PhysicalPlan localPlan(PlannerSettings plannerSettings,
 EsqlFlags flags,
 List<SearchExecutionContext> searchContexts,
 Configuration configuration,
 FoldContext foldCtx,
 PhysicalPlan plan,
 PlanTimeProfile planTimeProfile)

localPlan

public static PhysicalPlan localPlan(PlannerSettings plannerSettings,
 EsqlFlags flags,
 Configuration configuration,
 FoldContext foldCtx,
 PhysicalPlan plan,
 SearchStats searchStats,
 PlanTimeProfile planTimeProfile)

localPlan

public static PhysicalPlan localPlan(PlannerSettings plannerSettings,
 EsqlFlags flags,
 Configuration configuration,
 FoldContext foldCtx,
 PhysicalPlan plan,
 SearchStats searchStats,
 FilterPushdownRegistry filterPushdownRegistry,
 PlanTimeProfile planTimeProfile)

localPlan

public static PhysicalPlan localPlan(PlannerSettings plannerSettings,
 EsqlFlags flags,
 Configuration configuration,
 FoldContext foldCtx,
 PhysicalPlan plan,
 SearchStats searchStats,
 FilterPushdownRegistry filterPushdownRegistry,
 FormatReaderRegistry formatReaderRegistry,
 PlanTimeProfile planTimeProfile)

integrateEsFilterIntoFragment

public static PhysicalPlan integrateEsFilterIntoFragment(PhysicalPlan plan,
 @Nullable
 QueryBuilder esFilter)

localPlan

public static PhysicalPlan localPlan(PhysicalPlan plan,
 LocalLogicalPlanOptimizer logicalOptimizer,
 LocalPhysicalPlanOptimizer physicalOptimizer,
 PlanTimeProfile planTimeProfile)

localPlan

public static PhysicalPlan localPlan(PhysicalPlan plan,
 LocalLogicalPlanOptimizer logicalOptimizer,
 LocalPhysicalPlanOptimizer physicalOptimizer,
 PlanTimeProfile planTimeProfile,
 @Nullable
 Consumer<LogicalPlan> onLogicalPlanOptimized)

canMatchFilter

public static QueryBuilder canMatchFilter(EsqlFlags flags,
 Configuration configuration,
 TransportVersion minTransportVersion,
 PhysicalPlan plan)

Extracts a filter that can be used to skip unmatched shards on the coordinator.

toSortableElementType

public static ElementType toSortableElementType(DataType dataType)

Map QL's DataType to the compute engine's ElementType, for sortable types only. This specifically excludes spatial data types, which are not themselves sortable.

toElementType

public static ElementType toElementType(DataType dataType)

Map QL's DataType to the compute engine's ElementType.

toElementType

public static ElementType toElementType(DataType dataType,
 MappedFieldType.FieldExtractPreference fieldExtractPreference)

Map QL's DataType to the compute engine's ElementType. Under some situations, the same data type might be extracted into a different element type. For example, spatial types can be extracted into doc-values under specific conditions, otherwise they extract as BytesRef.

usesScoring

public static boolean usesScoring(QueryPlan<?> plan)

hasLimitedInput

public static boolean hasLimitedInput(LogicalPlan plan)

Checks that the input rows of the plan have been reduced by LIMIT. In the case where non-unary plans are used, such as Fork or UnionAll, we check that the rows from each branch are reduced by LIMIT.