Package org.elasticsearch.xpack.esql.session

Class EsqlSession

java.lang.Object

org.elasticsearch.xpack.esql.session.EsqlSession

public class EsqlSession
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EsqlSession.PlanRunner	Interface for running the underlying plan.
static final record	EsqlSession.PreAnalysisResult

Constructor Summary

Constructors

Constructor	Description
EsqlSession(String sessionId, AnalyzerSettings clusterSettings, IndexResolver indexResolver, EnrichPolicyResolver enrichPolicyResolver, PreAnalyzer preAnalyzer, EsqlFunctionRegistry functionRegistry, Mapper mapper, Verifier verifier, PlanTelemetry planTelemetry, IndicesExpressionGrouper indicesExpressionGrouper, TransportActionServices services)

Method Summary

Modifier and Type	Method	Description
void	analyzedPlan(LogicalPlan parsed, Configuration configuration, EsqlExecutionInfo executionInfo, QueryBuilder requestFilter, ActionListener<Versioned<LogicalPlan>> logicalPlanListener)
void	execute(EsqlQueryRequest request, EsqlExecutionInfo executionInfo, EsqlSession.PlanRunner planRunner, ActionListener<Result> listener)	Execute an ESQL request.
void	executeOptimizedPlan(EsqlQueryRequest request, EsqlExecutionInfo executionInfo, EsqlSession.PlanRunner planRunner, LogicalPlan optimizedPlan, Configuration configuration, FoldContext foldContext, TransportVersion minimumVersion, ActionListener<Result> listener)	Execute an analyzed plan.
LogicalPlan	optimizedPlan(LogicalPlan logicalPlan, LogicalPlanOptimizer logicalPlanOptimizer)
void	preOptimizedPlan(LogicalPlan logicalPlan, LogicalPlanPreOptimizer logicalPlanPreOptimizer, ActionListener<LogicalPlan> listener)
String	sessionId()

Methods inherited from class java.lang.Object

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

Constructor Details

EsqlSession

public EsqlSession(String sessionId,
 AnalyzerSettings clusterSettings,
 IndexResolver indexResolver,
 EnrichPolicyResolver enrichPolicyResolver,
 PreAnalyzer preAnalyzer,
 EsqlFunctionRegistry functionRegistry,
 Mapper mapper,
 Verifier verifier,
 PlanTelemetry planTelemetry,
 IndicesExpressionGrouper indicesExpressionGrouper,
 TransportActionServices services)

Method Details

sessionId

public String sessionId()

execute

public void execute(EsqlQueryRequest request,
 EsqlExecutionInfo executionInfo,
 EsqlSession.PlanRunner planRunner,
 ActionListener<Result> listener)

Execute an ESQL request.

executeOptimizedPlan

public void executeOptimizedPlan(EsqlQueryRequest request,
 EsqlExecutionInfo executionInfo,
 EsqlSession.PlanRunner planRunner,
 LogicalPlan optimizedPlan,
 Configuration configuration,
 FoldContext foldContext,
 TransportVersion minimumVersion,
 ActionListener<Result> listener)

Execute an analyzed plan. Most code should prefer calling execute(org.elasticsearch.xpack.esql.action.EsqlQueryRequest, org.elasticsearch.xpack.esql.action.EsqlExecutionInfo, org.elasticsearch.xpack.esql.session.EsqlSession.PlanRunner, org.elasticsearch.action.ActionListener<org.elasticsearch.xpack.esql.session.Result>) but this is public for testing.

analyzedPlan

public void analyzedPlan(LogicalPlan parsed,
 Configuration configuration,
 EsqlExecutionInfo executionInfo,
 QueryBuilder requestFilter,
 ActionListener<Versioned<LogicalPlan>> logicalPlanListener)

optimizedPlan

public LogicalPlan optimizedPlan(LogicalPlan logicalPlan,
 LogicalPlanOptimizer logicalPlanOptimizer)

preOptimizedPlan

public void preOptimizedPlan(LogicalPlan logicalPlan,
 LogicalPlanPreOptimizer logicalPlanPreOptimizer,
 ActionListener<LogicalPlan> listener)