Package org.elasticsearch.xpack.esql.action

Class PreparedEsqlQueryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.LegacyActionRequest

org.elasticsearch.xpack.core.esql.action.EsqlQueryRequest

org.elasticsearch.xpack.esql.action.EsqlQueryRequest

org.elasticsearch.xpack.esql.action.PreparedEsqlQueryRequest

All Implemented Interfaces:

CompositeIndicesRequest, Writeable, org.elasticsearch.core.RefCounted, TaskAwareRequest, TransportRequest

public final class PreparedEsqlQueryRequest
extends EsqlQueryRequest

An EsqlQueryRequest backed by a pre-built EsqlStatement, bypassing ES|QL string parsing. Used by internal callers (such as the Prometheus REST endpoints) that construct an EsqlStatement directly instead of going through ES|QL string construction and parsing.

The query string carried by this request is only used for logging and display; it plays no role in execution.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREPARED_QUERY_PREFIX

Fields inherited from class org.elasticsearch.xpack.esql.action.EsqlQueryRequest

DEFAULT_KEEP_ALIVE, DEFAULT_WAIT_FOR_COMPLETION

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Method Summary

Modifier and Type	Method	Description
static PreparedEsqlQueryRequest	async(EsqlStatement statement, String queryDescription)	Creates an asynchronous request backed by the given pre-built statement.
static PreparedEsqlQueryRequest	from(EsqlQueryRequest source, EsqlStatement statement, String queryDescription)	Creates a request backed by statement with all other properties copied from source.
EsqlStatement	parse(EsqlParser parser, SettingsValidationContext settingsValidationCtx, InferenceSettings inferenceSettings)	Returns the pre-built statement directly, without invoking the parser, after validating its settings.
String	query()
EsqlQueryRequest	query(String query)
String	queryDescription()	Returns a non-null human-readable description of the query for logging, task descriptions, and error messages.
EsqlStatement	statement()	Returns the pre-built statement carried by this request.
static PreparedEsqlQueryRequest	sync(EsqlStatement statement, String queryDescription)	Creates a synchronous request backed by the given pre-built statement.
protected ActionRequestValidationException	validateQuery()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.action.EsqlQueryRequest

addTable, allowPartialResults, allowPartialResults, approximation, approximation, async, asyncEsqlQueryRequest, columnar, columnar, createTask, filter, filter, includeCCSMetadata, includeCCSMetadata, includeExecutionMetadata, includeExecutionMetadata, keepAlive, keepAlive, keepOnCompletion, keepOnCompletion, locale, locale, params, params, pragmas, pragmas, profile, profile, projectRouting, projectRouting, syncEsqlQueryRequest, tables, timeZone, timeZone, validate, waitForCompletionTimeout, waitForCompletionTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Field Details

PREPARED_QUERY_PREFIX

public static final String PREPARED_QUERY_PREFIX

See Also:

• Constant Field Values

Method Details

sync

public static PreparedEsqlQueryRequest sync(EsqlStatement statement,
 String queryDescription)

Creates a synchronous request backed by the given pre-built statement.

async

public static PreparedEsqlQueryRequest async(EsqlStatement statement,
 String queryDescription)

Creates an asynchronous request backed by the given pre-built statement.

from

public static PreparedEsqlQueryRequest from(EsqlQueryRequest source,
 EsqlStatement statement,
 String queryDescription)

Creates a request backed by statement with all other properties copied from source.

statement

public EsqlStatement statement()

Returns the pre-built statement carried by this request.

query

@Nullable
public String query()

Overrides:

query in class EsqlQueryRequest

query

public EsqlQueryRequest query(String query)

Overrides:

query in class EsqlQueryRequest

queryDescription

public String queryDescription()

Description copied from class: EsqlQueryRequest

Returns a non-null human-readable description of the query for logging, task descriptions, and error messages. For regular requests this is the same as EsqlQueryRequest.query(). Overridden by PreparedEsqlQueryRequest to return a display string when there is no query text.

Overrides:

queryDescription in class EsqlQueryRequest

validateQuery

protected ActionRequestValidationException validateQuery()

Overrides:

validateQuery in class EsqlQueryRequest

parse

public EsqlStatement parse(EsqlParser parser,
 SettingsValidationContext settingsValidationCtx,
 InferenceSettings inferenceSettings)

Returns the pre-built statement directly, without invoking the parser, after validating its settings.

Overrides:

parse in class EsqlQueryRequest

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException