Class QueryRewriteContext

java.lang.Object
org.elasticsearch.index.query.QueryRewriteContext
Direct Known Subclasses:
CoordinatorRewriteContext, SearchExecutionContext

public class QueryRewriteContext extends Object
Context object used to rewrite QueryBuilder instances into simplified version.
  • Field Details

    • client

      protected final Client client
    • nowInMillis

      protected final LongSupplier nowInMillis
  • Constructor Details

  • Method Details

    • getXContentRegistry

      public NamedXContentRegistry getXContentRegistry()
      The registry used to build new XContentParsers. Contains registered named parsers needed to parse the query.
    • nowInMillis

      public long nowInMillis()
      Returns the time in milliseconds that is shared across all resources involved. Even across shards and nodes.
    • getWriteableRegistry

      public NamedWriteableRegistry getWriteableRegistry()
    • convertToSearchExecutionContext

      public SearchExecutionContext convertToSearchExecutionContext()
      Returns an instance of SearchExecutionContext if available of null otherwise
    • convertToCoordinatorRewriteContext

      public CoordinatorRewriteContext convertToCoordinatorRewriteContext()
    • registerAsyncAction

      public void registerAsyncAction(BiConsumer<Client,ActionListener<?>> asyncAction)
      Registers an async action that must be executed before the next rewrite round in order to make progress. This should be used if a rewriteabel needs to fetch some external resources in order to be executed ie. a document from an index.
    • hasAsyncActions

      public boolean hasAsyncActions()
      Returns true if there are any registered async actions.
    • executeAsyncActions

      public void executeAsyncActions(ActionListener<Object> listener)
      Executes all registered async actions and notifies the listener once it's done. The value that is passed to the listener is always null. The list of registered actions is cleared once this method returns.