Class QueryPragmas
java.lang.Object
org.elasticsearch.xpack.esql.plugin.QueryPragmas
- All Implemented Interfaces:
Writeable
Holds the pragmas for an ESQL query. Just a wrapper of settings for now.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionHow to cutslicesto cut each shard into.static final QueryPragmasstatic final Setting<MappedFieldType.FieldExtractPreference> static final Setting<ByteSizeValue> Size of a page in entries with0being a special value asking to adaptively size based on the number of columns in the page.static final Setting<org.elasticsearch.core.TimeValue> The minimum interval between syncs of theDriverStatus, making the status available to task API. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintdataPartitioning(DataPartitioning defaultDataPartitioning) intReturns the maximum number of workers for enrich lookup.booleanintThe default preference for extracting fields, defaults toNONE.The maximum amount of memory we can use forExpression.fold(org.elasticsearch.xpack.esql.core.expression.FoldContext)during planing.inthashCode()booleanisEmpty()intThe maximum number of nodes to be queried at once by this query.intThe maximum number of shards can be executed concurrently on a single node by this query.booleanReturns true if each data node should perform a local reduction for sort, limit, topN, stats or false if the coordinator node will perform the reduction.intpageSize()Size of a page in entries with0being a special value asking to adaptively size based on the number of columns in the page.org.elasticsearch.core.TimeValueThe minimum interval between syncs of theDriverStatus, making the status available to task API.inttoString()intAmount of attempts moved shards could be retried.voidwriteTo(StreamOutput out)
-
Field Details
-
EXCHANGE_BUFFER_SIZE
-
EXCHANGE_CONCURRENT_CLIENTS
-
ENRICH_MAX_WORKERS
-
TASK_CONCURRENCY
-
DATA_PARTITIONING
How to cutslicesto cut each shard into. Is parsed to the enumDataPartitioningwhich has more documentation. Not anSetting.enumSetting(java.lang.Class<T>, java.lang.String, T, org.elasticsearch.common.settings.Setting.Property...)because those can't havenulldefaults.nullhere means "use the default from the cluster setting namedPhysicalSettings.DEFAULT_DATA_PARTITIONING." -
PAGE_SIZE
Size of a page in entries with0being a special value asking to adaptively size based on the number of columns in the page. -
STATUS_INTERVAL
The minimum interval between syncs of theDriverStatus, making the status available to task API. -
MAX_CONCURRENT_NODES_PER_CLUSTER
-
MAX_CONCURRENT_SHARDS_PER_NODE
-
UNAVAILABLE_SHARD_RESOLUTION_ATTEMPTS
-
NODE_LEVEL_REDUCTION
-
FOLD_LIMIT
-
FIELD_EXTRACT_PREFERENCE
-
EMPTY
-
-
Constructor Details
-
QueryPragmas
-
QueryPragmas
- Throws:
IOException
-
-
Method Details
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
getSettings
-
exchangeBufferSize
public int exchangeBufferSize() -
concurrentExchangeClients
public int concurrentExchangeClients() -
dataPartitioning
-
taskConcurrency
public int taskConcurrency() -
pageSize
public int pageSize()Size of a page in entries with0being a special value asking to adaptively size based on the number of columns in the page. -
statusInterval
public org.elasticsearch.core.TimeValue statusInterval()The minimum interval between syncs of theDriverStatus, making the status available to task API. -
enrichMaxWorkers
public int enrichMaxWorkers()Returns the maximum number of workers for enrich lookup. A higher number of workers reduces latency but increases cluster load. Defaults to 1. -
maxConcurrentNodesPerCluster
public int maxConcurrentNodesPerCluster()The maximum number of nodes to be queried at once by this query. This is safeguard to avoid overloading the cluster. -
maxConcurrentShardsPerNode
public int maxConcurrentShardsPerNode()The maximum number of shards can be executed concurrently on a single node by this query. This is a safeguard to avoid opening and holding many shards (equivalent to many file descriptors) or having too many field infos created by a single query. -
nodeLevelReduction
public boolean nodeLevelReduction()Returns true if each data node should perform a local reduction for sort, limit, topN, stats or false if the coordinator node will perform the reduction. -
foldLimit
The maximum amount of memory we can use forExpression.fold(org.elasticsearch.xpack.esql.core.expression.FoldContext)during planing. This defaults to 5% of memory available on the current node. If this method is called on the coordinating node, this is 5% of the coordinating node's memory. If it's called on a data node, it's 5% of the data node. That's an exciting inconsistency. But it's important. Bigger nodes have more space to do folding. -
fieldExtractPreference
The default preference for extracting fields, defaults toNONE. Some fields must be extracted in some special way because of how they are used in the plan. But most fields can be loaded in many ways so they pick the ways that they think are most efficient in theirMappedFieldType.blockLoader(org.elasticsearch.index.mapper.MappedFieldType.BlockLoaderContext)method. This can influence their choice. -
isEmpty
public boolean isEmpty() -
equals
-
hashCode
public int hashCode() -
toString
-