Package org.elasticsearch.xpack.esql.session

Class EsqlSession

java.lang.Object

org.elasticsearch.xpack.esql.session.EsqlSession

public class EsqlSession
extends Object

Combines all components necessary for the coordinating node to plan and execute an ESQL query, including (pre-)analyzing, optimizing and running the physical plan.

In particular, this is where we perform remote calls to pre-analyze the query, that is, to resolve indices, enrich policies and their mappings.

Note that this is not a session in the traditional sense of a stateful connection. This will produce a single result set that is either returned to the user directly or stored for later retrieval if the query was async.

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, TransportVersion localClusterMinimumVersion, AnalyzerSettings analyzerSettings, IndexResolver indexResolver, EnrichPolicyResolver enrichPolicyResolver, ViewResolver viewResolver, ExternalSourceResolver externalSourceResolver, EsqlParser parser, PreAnalyzer preAnalyzer, EsqlFunctionRegistry functionRegistry, Mapper mapper, Verifier verifier, Metrics metrics, PlanTelemetry planTelemetry, IndicesExpressionGrouper indicesExpressionGrouper, ProjectMetadata projectMetadata, PlannerSettings plannerSettings, TransportActionServices services)

Method Summary

Modifier and Type	Method	Description
static ApproximationSettings	approximationSettings(EsqlQueryRequest request, EsqlStatement statement)
void	execute(EsqlQueryRequest request, EsqlExecutionInfo executionInfo, EsqlSession.PlanRunner planRunner, ActionListener<Versioned<Result>> listener)	Execute an ESQL request.
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,
 TransportVersion localClusterMinimumVersion,
 AnalyzerSettings analyzerSettings,
 IndexResolver indexResolver,
 EnrichPolicyResolver enrichPolicyResolver,
 ViewResolver viewResolver,
 ExternalSourceResolver externalSourceResolver,
 EsqlParser parser,
 PreAnalyzer preAnalyzer,
 EsqlFunctionRegistry functionRegistry,
 Mapper mapper,
 Verifier verifier,
 Metrics metrics,
 PlanTelemetry planTelemetry,
 IndicesExpressionGrouper indicesExpressionGrouper,
 ProjectMetadata projectMetadata,
 PlannerSettings plannerSettings,
 TransportActionServices services)

Method Details

sessionId

public String sessionId()

execute

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

Execute an ESQL request.

approximationSettings

public static ApproximationSettings approximationSettings(EsqlQueryRequest request,
 EsqlStatement statement)