Package org.elasticsearch.xpack.esql.action

Class EsqlQueryRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

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

org.elasticsearch.xpack.esql.action.EsqlQueryRequest

All Implemented Interfaces:

CompositeIndicesRequest, Writeable, RefCounted, TaskAwareRequest, TransportRequest

Direct Known Subclasses:

PreparedEsqlQueryRequest

public class EsqlQueryRequest
extends EsqlQueryRequest
implements CompositeIndicesRequest

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 TimeValue	DEFAULT_KEEP_ALIVE
static TimeValue	DEFAULT_WAIT_FOR_COMPLETION

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
EsqlQueryRequest()
EsqlQueryRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
EsqlQueryRequest	acceptedPragmaRisks(boolean accepted)
void	addTable(String name, Map<String,Column> columns)	Add a "table" to the request for use with things like LOOKUP.
Boolean	allowPartialResults()
EsqlQueryRequest	allowPartialResults(boolean allowPartialResults)
boolean	async()
static EsqlQueryRequest	asyncEsqlQueryRequest(String query)
boolean	columnar()
EsqlQueryRequest	columnar(boolean columnar)
Task	createTask(TaskId taskId, String type, String action, TaskId parentTaskId, Map<String,String> headers)
QueryBuilder	filter()
EsqlQueryRequest	filter(QueryBuilder filter)
<T> T	get(QuerySettingDef<T> def)	Body-supplied value with registry-default fallback.
Boolean	includeCCSMetadata()
EsqlQueryRequest	includeCCSMetadata(Boolean include)
Boolean	includeExecutionMetadata()
EsqlQueryRequest	includeExecutionMetadata(Boolean include)
TimeValue	keepAlive()
EsqlQueryRequest	keepAlive(TimeValue keepAlive)
boolean	keepOnCompletion()
EsqlQueryRequest	keepOnCompletion(boolean keepOnCompletion)
Locale	locale()
void	locale(Locale locale)
QueryParams	params()
void	params(QueryParams params)
EsqlStatement	parse(EsqlParser parser, SettingsValidationContext settingsValidationCtx, InferenceSettings inferenceSettings)	Parses the query string into an EsqlStatement and validates its settings.
QueryPragmas	pragmas()
EsqlQueryRequest	pragmas(QueryPragmas pragmas)
boolean	profile()	Is profiling enabled?
EsqlQueryRequest	profile(boolean profile)	Enable profiling, sacrificing performance to return information about what operations are taking the most time.
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.
Map<QuerySettingDef<?>,Object>	requestSettings()
<T> EsqlQueryRequest	set(QuerySettingDef<T> def, T value)
static EsqlQueryRequest	syncEsqlQueryRequest(String query)
Map<String,Map<String,Column>>	tables()
ActionRequestValidationException	validate()
protected ActionRequestValidationException	validateQuery()
TimeValue	waitForCompletionTimeout()
EsqlQueryRequest	waitForCompletionTimeout(TimeValue waitForCompletionTimeout)

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult, writeTo

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, 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

DEFAULT_KEEP_ALIVE

public static TimeValue DEFAULT_KEEP_ALIVE

DEFAULT_WAIT_FOR_COMPLETION

public static TimeValue DEFAULT_WAIT_FOR_COMPLETION

Constructor Details

EsqlQueryRequest

public EsqlQueryRequest()

EsqlQueryRequest

public EsqlQueryRequest(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

syncEsqlQueryRequest

public static EsqlQueryRequest syncEsqlQueryRequest(String query)

asyncEsqlQueryRequest

public static EsqlQueryRequest asyncEsqlQueryRequest(String query)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

validateQuery

protected ActionRequestValidationException validateQuery()

query

public EsqlQueryRequest query(String query)

query

@Nullable
public String query()

Specified by:

query in class EsqlQueryRequest

queryDescription

public String queryDescription()

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 query(). Overridden by PreparedEsqlQueryRequest to return a display string when there is no query text.

parse

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

Parses the query string into an EsqlStatement and validates its settings. Overridden by PreparedEsqlQueryRequest to return a pre-built statement directly.

async

public boolean async()

columnar

public EsqlQueryRequest columnar(boolean columnar)

columnar

public boolean columnar()

profile

public EsqlQueryRequest profile(boolean profile)

Enable profiling, sacrificing performance to return information about what operations are taking the most time.

includeCCSMetadata

public EsqlQueryRequest includeCCSMetadata(Boolean include)

includeCCSMetadata

public Boolean includeCCSMetadata()

includeExecutionMetadata

public EsqlQueryRequest includeExecutionMetadata(Boolean include)

includeExecutionMetadata

public Boolean includeExecutionMetadata()

profile

public boolean profile()

Is profiling enabled?

locale

public void locale(Locale locale)

locale

public Locale locale()

filter

public EsqlQueryRequest filter(QueryBuilder filter)

filter

public QueryBuilder filter()

Specified by:

filter in class EsqlQueryRequest

pragmas

public EsqlQueryRequest pragmas(QueryPragmas pragmas)

pragmas

public QueryPragmas pragmas()

params

public QueryParams params()

params

public void params(QueryParams params)

waitForCompletionTimeout

public TimeValue waitForCompletionTimeout()

waitForCompletionTimeout

public EsqlQueryRequest waitForCompletionTimeout(TimeValue waitForCompletionTimeout)

keepAlive

public TimeValue keepAlive()

keepAlive

public EsqlQueryRequest keepAlive(TimeValue keepAlive)

keepOnCompletion

public boolean keepOnCompletion()

keepOnCompletion

public EsqlQueryRequest keepOnCompletion(boolean keepOnCompletion)

addTable

public void addTable(String name,
 Map<String,Column> columns)

Add a "table" to the request for use with things like LOOKUP.

tables

public Map<String,Map<String,Column>> tables()

allowPartialResults

public Boolean allowPartialResults()

allowPartialResults

public EsqlQueryRequest allowPartialResults(boolean allowPartialResults)

createTask

public Task createTask(TaskId taskId,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)

Specified by:

createTask in interface TaskAwareRequest

acceptedPragmaRisks

public EsqlQueryRequest acceptedPragmaRisks(boolean accepted)

set

public <T> EsqlQueryRequest set(QuerySettingDef<T> def,
 T value)

get

public <T> T get(QuerySettingDef<T> def)

Body-supplied value with registry-default fallback. Pre-resolution; for the merged value use the ResolvedSettings from QuerySettings.resolve(java.util.Map<org.elasticsearch.xpack.esql.plan.QuerySettingDef<?>, java.lang.Object>, org.elasticsearch.xpack.esql.plan.EsqlStatement, org.elasticsearch.xpack.esql.plan.SettingsValidationContext).

requestSettings

public Map<QuerySettingDef<?>,Object> requestSettings()