java.lang.Object

org.elasticsearch.search.internal.ReaderContext

All Implemented Interfaces:: java.io.Closeable, java.lang.AutoCloseable, Releasable

Direct Known Subclasses:: LegacyReaderContext

public class ReaderContext
extends java.lang.Object
implements Releasable

Holds a reference to a point in time Engine.Searcher that will be used to construct SearchContext. This class also implements RefCounted since in some situations like in SearchService a SearchContext can be closed concurrently due to independent events ie. when an index gets removed. To prevent accessing closed IndexReader / IndexSearcher instances the SearchContext can be guarded by a reference count and fail if it's been closed by an external event.

Field Summary

Fields

Modifier and Type Field Description

protected Engine.SearcherSupplier searcherSupplier

Constructor Summary

Constructors
Constructor	Description
`ReaderContext(ShardSearchContextId id, IndexService indexService, IndexShard indexShard, Engine.SearcherSupplier searcherSupplier, long keepAliveInMillis, boolean singleSession)`

Method Summary

Modifier and Type	Method	Description
`Engine.Searcher`	`acquireSearcher(java.lang.String source)`
`void`	`addOnClose(Releasable releasable)`
`void`	`close()`
`AggregatedDfs`	`getAggregatedDfs(AggregatedDfs other)`
`<T> T`	`getFromContext(java.lang.String key)`	Returns the object or `null` if the given key does not have a value in the context
`RescoreDocIds`	`getRescoreDocIds(RescoreDocIds other)`
`ShardSearchRequest`	`getShardSearchRequest(ShardSearchRequest other)`
`long`	`getStartTimeInNano()`
`ShardSearchContextId`	`id()`
`IndexService`	`indexService()`
`IndexShard`	`indexShard()`
`boolean`	`isExpired()`
`Releasable`	`markAsUsed(long keepAliveInMillis)`	Returns a releasable to indicate that the caller has stopped using this reader.
`void`	`putInContext(java.lang.String key, java.lang.Object value)`	Puts the object into the context
`ScrollContext`	`scrollContext()`
`void`	`setAggregatedDfs(AggregatedDfs aggregatedDfs)`
`void`	`setRescoreDocIds(RescoreDocIds rescoreDocIds)`
`boolean`	`singleSession()`	Returns `true` for readers that are intended to use in a single query.
`void`	`validate(TransportRequest request)`

Methods inherited from class java.lang.Object

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

Field Details
- searcherSupplier
  
  protected final Engine.SearcherSupplier searcherSupplier
Constructor Details
- ReaderContext
  
  public ReaderContext(ShardSearchContextId id, IndexService indexService, IndexShard indexShard, Engine.SearcherSupplier searcherSupplier, long keepAliveInMillis, boolean singleSession)
Method Details
- validate
  
  public void validate(TransportRequest request)
- close
  
  public final void close()
  
  Specified by:
  
  close in interface java.lang.AutoCloseable
  
  Specified by:
  
  close in interface java.io.Closeable
  
  Specified by:
  
  close in interface Releasable
- addOnClose
  
  public void addOnClose(Releasable releasable)
- id
  
  public ShardSearchContextId id()
- indexService
  
  public IndexService indexService()
- indexShard
  
  public IndexShard indexShard()
- acquireSearcher
  
  public Engine.Searcher acquireSearcher(java.lang.String source)
- markAsUsed
  
  public Releasable markAsUsed(long keepAliveInMillis)
  
  Returns a releasable to indicate that the caller has stopped using this reader. The time to live of the reader after usage can be extended using the provided keepAliveInMillis.
- isExpired
  
  public boolean isExpired()
- getShardSearchRequest
  
  public ShardSearchRequest getShardSearchRequest(ShardSearchRequest other)
- scrollContext
  
  public ScrollContext scrollContext()
- getAggregatedDfs
  
  public AggregatedDfs getAggregatedDfs(AggregatedDfs other)
- setAggregatedDfs
  
  public void setAggregatedDfs(AggregatedDfs aggregatedDfs)
- getRescoreDocIds
  
  public RescoreDocIds getRescoreDocIds(RescoreDocIds other)
- setRescoreDocIds
  
  public void setRescoreDocIds(RescoreDocIds rescoreDocIds)
- singleSession
  
  public boolean singleSession()
  
  Returns true for readers that are intended to use in a single query. For readers that are intended to use in multiple queries (i.e., scroll or readers), we should not release them after the fetch phase or the query phase with empty results.
- getFromContext
  
  public <T> T getFromContext(java.lang.String key)
  
  Returns the object or null if the given key does not have a value in the context
- putInContext
  
  public void putInContext(java.lang.String key, java.lang.Object value)
  
  Puts the object into the context
- getStartTimeInNano
  
  public long getStartTimeInNano()

Class ReaderContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details