Package org.elasticsearch.xpack.esql.plugin

Class EsqlPlugin

java.lang.Object

org.elasticsearch.plugins.Plugin

org.elasticsearch.xpack.esql.plugin.EsqlPlugin

All Implemented Interfaces:

Closeable, AutoCloseable, ActionPlugin

public class EsqlPlugin
extends Plugin
implements ActionPlugin

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.plugins.Plugin

Plugin.PluginServices

Nested classes/interfaces inherited from interface org.elasticsearch.plugins.ActionPlugin

ActionPlugin.ActionHandler<Request extends ActionRequest,Response extends ActionResponse>

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<Boolean>	ESQL_QUERYLOG_INCLUDE_USER_SETTING
static final Setting<org.elasticsearch.core.TimeValue>	ESQL_QUERYLOG_THRESHOLD_DEBUG_SETTING
static final Setting<org.elasticsearch.core.TimeValue>	ESQL_QUERYLOG_THRESHOLD_INFO_SETTING
static final Setting<org.elasticsearch.core.TimeValue>	ESQL_QUERYLOG_THRESHOLD_TRACE_SETTING
static final Setting<org.elasticsearch.core.TimeValue>	ESQL_QUERYLOG_THRESHOLD_WARN_SETTING
static final String	ESQL_WORKER_THREAD_POOL_NAME
static final Setting<org.elasticsearch.core.TimeValue>	GROK_WATCHDOG_MAX_EXECUTION_TIME	Maximum time (in milliseconds) that a GROK matcher is allowed to run before being interrupted.
static final FeatureFlag	INLINESTATS_FEATURE_FLAG
static final Setting<Boolean>	QUERY_ALLOW_PARTIAL_RESULTS
static final Setting<Integer>	QUERY_RESULT_TRUNCATION_DEFAULT_SIZE
static final Setting<Integer>	QUERY_RESULT_TRUNCATION_MAX_SIZE
static final Setting<Double>	STORED_FIELDS_SEQUENTIAL_PROPORTION	Tuning parameter for deciding when to use the "merge" stored field loader.

Constructor Summary

Constructors

Constructor	Description
EsqlPlugin()

Method Summary

Modifier and Type	Method	Description
protected BlockFactoryProvider	blockFactoryProvider(CircuitBreaker breaker, BigArrays bigArrays, ByteSizeValue maxPrimitiveArraySize)
Collection<?>	createComponents(Plugin.PluginServices services)
List<ActionPlugin.ActionHandler<? extends ActionRequest,? extends ActionResponse>>	getActions()
List<ExecutorBuilder<?>>	getExecutorBuilders(Settings settings)
protected XPackLicenseState	getLicenseState()
List<NamedWriteableRegistry.Entry>	getNamedWriteables()
List<RestHandler>	getRestHandlers(Settings settings, NamedWriteableRegistry namedWriteableRegistry, RestController restController, ClusterSettings clusterSettings, IndexScopedSettings indexScopedSettings, SettingsFilter settingsFilter, IndexNameExpressionResolver indexNameExpressionResolver, Supplier<DiscoveryNodes> nodesInCluster, Predicate<NodeFeature> clusterSupportsFeature)
List<Setting<?>>	getSettings()	The settings defined by the ESQL plugin.

Methods inherited from class org.elasticsearch.plugins.Plugin

additionalSettings, close, getAdditionalIndexSettingProviders, getBootstrapChecks, getIndexTemplateMetadataUpgrader, getNamedXContent, getSettingsFilter, onIndexModule

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.plugins.ActionPlugin

getActionFilters, getMappedActionFilters, getRestHeaders, getTaskHeaders, indicesAliasesRequestValidators, mappingRequestValidators

Field Details

INLINESTATS_FEATURE_FLAG

public static final FeatureFlag INLINESTATS_FEATURE_FLAG

ESQL_WORKER_THREAD_POOL_NAME

public static final String ESQL_WORKER_THREAD_POOL_NAME

See Also:

• Constant Field Values

QUERY_RESULT_TRUNCATION_MAX_SIZE

public static final Setting<Integer> QUERY_RESULT_TRUNCATION_MAX_SIZE

QUERY_RESULT_TRUNCATION_DEFAULT_SIZE

public static final Setting<Integer> QUERY_RESULT_TRUNCATION_DEFAULT_SIZE

QUERY_ALLOW_PARTIAL_RESULTS

public static final Setting<Boolean> QUERY_ALLOW_PARTIAL_RESULTS

ESQL_QUERYLOG_THRESHOLD_WARN_SETTING

public static final Setting<org.elasticsearch.core.TimeValue> ESQL_QUERYLOG_THRESHOLD_WARN_SETTING

ESQL_QUERYLOG_THRESHOLD_INFO_SETTING

public static final Setting<org.elasticsearch.core.TimeValue> ESQL_QUERYLOG_THRESHOLD_INFO_SETTING

ESQL_QUERYLOG_THRESHOLD_DEBUG_SETTING

public static final Setting<org.elasticsearch.core.TimeValue> ESQL_QUERYLOG_THRESHOLD_DEBUG_SETTING

ESQL_QUERYLOG_THRESHOLD_TRACE_SETTING

public static final Setting<org.elasticsearch.core.TimeValue> ESQL_QUERYLOG_THRESHOLD_TRACE_SETTING

ESQL_QUERYLOG_INCLUDE_USER_SETTING

public static final Setting<Boolean> ESQL_QUERYLOG_INCLUDE_USER_SETTING

GROK_WATCHDOG_MAX_EXECUTION_TIME

public static final Setting<org.elasticsearch.core.TimeValue> GROK_WATCHDOG_MAX_EXECUTION_TIME

Maximum time (in milliseconds) that a GROK matcher is allowed to run before being interrupted. Limits how long a GROK matcher can run to protect against expensive regex patterns. Read directly from each node's own ClusterSettings wherever the matcher is built for execution (see LocalExecutionPlanner#planGrok) rather than being carried in the ES|QL Configuration wire format, since every node can resolve this node-scoped setting on its own — including live updates, since it is also dynamic.

STORED_FIELDS_SEQUENTIAL_PROPORTION

public static final Setting<Double> STORED_FIELDS_SEQUENTIAL_PROPORTION

Tuning parameter for deciding when to use the "merge" stored field loader. Think of it as "how similar to a sequential block of documents do I have to be before I'll use the merge reader?" So a value of 1 means I have to be exactly a sequential block, like 0, 1, 2, 3, .. 1299, 1300. A value of .2 means we'll use the sequential reader even if we only need one in ten documents.

The default value of this was experimentally derived using a script. And a little paranoia. A lower default value was looking good locally, but I'm concerned about the implications of effectively using this all the time.

Constructor Details

EsqlPlugin

public EsqlPlugin()

Method Details

createComponents

public Collection<?> createComponents(Plugin.PluginServices services)

Overrides:

createComponents in class Plugin

blockFactoryProvider

protected BlockFactoryProvider blockFactoryProvider(CircuitBreaker breaker,
 BigArrays bigArrays,
 ByteSizeValue maxPrimitiveArraySize)

getLicenseState

protected XPackLicenseState getLicenseState()

getSettings

public List<Setting<?>> getSettings()

The settings defined by the ESQL plugin.

Overrides:

getSettings in class Plugin

Returns:

the settings

getActions

public List<ActionPlugin.ActionHandler<? extends ActionRequest,? extends ActionResponse>> getActions()

Specified by:

getActions in interface ActionPlugin

getRestHandlers

public List<RestHandler> getRestHandlers(Settings settings,
 NamedWriteableRegistry namedWriteableRegistry,
 RestController restController,
 ClusterSettings clusterSettings,
 IndexScopedSettings indexScopedSettings,
 SettingsFilter settingsFilter,
 IndexNameExpressionResolver indexNameExpressionResolver,
 Supplier<DiscoveryNodes> nodesInCluster,
 Predicate<NodeFeature> clusterSupportsFeature)

Specified by:

getRestHandlers in interface ActionPlugin

getNamedWriteables

public List<NamedWriteableRegistry.Entry> getNamedWriteables()

Overrides:

getNamedWriteables in class Plugin

getExecutorBuilders

public List<ExecutorBuilder<?>> getExecutorBuilders(Settings settings)

Overrides:

getExecutorBuilders in class Plugin