Class QueryPragmas

java.lang.Object
org.elasticsearch.xpack.esql.plugin.QueryPragmas
All Implemented Interfaces:
Writeable

public final class QueryPragmas extends Object implements Writeable
Holds the pragmas for an ESQL query. Just a wrapper of settings for now.
  • Field Details

    • EXCHANGE_BUFFER_SIZE

      public static final Setting<Integer> EXCHANGE_BUFFER_SIZE
    • EXCHANGE_CONCURRENT_CLIENTS

      public static final Setting<Integer> EXCHANGE_CONCURRENT_CLIENTS
    • ENRICH_MAX_WORKERS

      public static final Setting<Integer> ENRICH_MAX_WORKERS
    • DATA_PARTITIONING

      public static final Setting<DataPartitioning> DATA_PARTITIONING
    • PAGE_SIZE

      public static final Setting<Integer> PAGE_SIZE
      Size of a page in entries with 0 being a special value asking to adaptively size based on the number of columns in the page.
    • STATUS_INTERVAL

      public static final Setting<org.elasticsearch.core.TimeValue> STATUS_INTERVAL
      The minimum interval between syncs of the DriverStatus, making the status available to task API.
    • MAX_CONCURRENT_SHARDS_PER_NODE

      public static final Setting<Integer> MAX_CONCURRENT_SHARDS_PER_NODE
    • NODE_LEVEL_REDUCTION

      public static final Setting<Boolean> NODE_LEVEL_REDUCTION
    • FOLD_LIMIT

      public static final Setting<ByteSizeValue> FOLD_LIMIT
    • EMPTY

      public static final QueryPragmas EMPTY
  • Constructor Details

  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • getSettings

      public Settings getSettings()
    • exchangeBufferSize

      public int exchangeBufferSize()
    • concurrentExchangeClients

      public int concurrentExchangeClients()
    • dataPartitioning

      public DataPartitioning dataPartitioning()
    • taskConcurrency

      public int taskConcurrency()
    • pageSize

      public int pageSize()
      Size of a page in entries with 0 being 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 the DriverStatus, 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.
    • 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

      public ByteSizeValue foldLimit()
      The maximum amount of memory we can use for Expression.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.
    • isEmpty

      public boolean isEmpty()
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object