Class EngineConfig

  • public final class EngineConfig
    extends java.lang.Object
    • Field Detail


        public static final Setting<java.lang.String> INDEX_CODEC_SETTING
        Index setting to change the low level lucene codec used for writing new segments. This setting is not realtime updateable. This setting is also settable on the node and the index level, it's commonly used in hot/cold node archs where index is likely allocated on both `kind` of nodes.

        public static final Setting<java.lang.Boolean> INDEX_OPTIMIZE_AUTO_GENERATED_IDS
        Configures an index to optimize documents with auto generated ids for append only. If this setting is updated from false to true might not take effect immediately. In other words, disabling the optimization will be immediately applied while re-enabling it might not be applied until the engine is in a safe state to do so. Depending on the engine implementation a change to this setting won't be reflected re-enabled optimization until the engine is restarted or the index is closed and reopened. The default is true
    • Constructor Detail

      • EngineConfig

        public EngineConfig​(ShardId shardId,
                            java.lang.String allocationId,
                            ThreadPool threadPool,
                            IndexSettings indexSettings,
                            Engine.Warmer warmer,
                            Store store,
                            org.apache.lucene.index.MergePolicy mergePolicy,
                            org.apache.lucene.analysis.Analyzer analyzer,
                            CodecService codecService,
                            Engine.EventListener eventListener,
                            TranslogConfig translogConfig,
                            TimeValue flushMergesAfter,
                            java.util.List<> externalRefreshListener,
                            java.util.List<> internalRefreshListener,
                            CircuitBreakerService circuitBreakerService,
                            java.util.function.LongSupplier globalCheckpointSupplier,
                            java.util.function.Supplier<RetentionLeases> retentionLeasesSupplier,
                            java.util.function.LongSupplier primaryTermSupplier,
                            EngineConfig.TombstoneDocSupplier tombstoneDocSupplier)
        Creates a new EngineConfig
    • Method Detail

      • retentionLeasesSupplier

        public java.util.function.Supplier<RetentionLeases> retentionLeasesSupplier()
        A supplier of the outstanding retention leases. This is used during merged operations to determine which operations that have been soft deleted should be retained.
        a supplier of outstanding retention leases
      • setEnableGcDeletes

        public void setEnableGcDeletes​(boolean enableGcDeletes)
        Enables / disables gc deletes
        See Also:
      • getIndexingBufferSize

        public ByteSizeValue getIndexingBufferSize()
        Returns the initial index buffer size. This setting is only read on startup and otherwise controlled by IndexingMemoryController
      • isEnableGcDeletes

        public boolean isEnableGcDeletes()
        Returns true iff delete garbage collection in the engine should be enabled. This setting is updateable in realtime and forces a volatile read. Consumers can safely read this value directly go fetch it's latest value. The default is true

        Engine GC deletion if enabled collects deleted documents from in-memory realtime data structures after a certain amount of time (IndexSettings.getGcDeletesInMillis() if enabled. Before deletes are GCed they will cause re-adding the document that was deleted to fail.

      • getCodec

        public org.apache.lucene.codecs.Codec getCodec()
        Returns the Codec used in the engines IndexWriter

        Note: this settings is only read on startup.

      • getWarmer

        public Engine.Warmer getWarmer()
        Returns an Engine.Warmer used to warm new searchers before they are used for searching.
      • getStore

        public Store getStore()
        Returns the Store instance that provides access to the Directory used for the engines IndexWriter to write it's index files to.

        Note: In order to use this instance the consumer needs to increment the stores reference before it's used the first time and hold it's reference until it's not needed anymore.

      • getGlobalCheckpointSupplier

        public java.util.function.LongSupplier getGlobalCheckpointSupplier()
        Returns the global checkpoint tracker
      • getMergePolicy

        public org.apache.lucene.index.MergePolicy getMergePolicy()
        Returns the MergePolicy for the engines IndexWriter
      • getEventListener

        public Engine.EventListener getEventListener()
        Returns a listener that should be called on engine failure
      • getIndexSettings

        public IndexSettings getIndexSettings()
        Returns the index settings for this index.
      • getShardId

        public ShardId getShardId()
        Returns the engines shard ID
      • getAllocationId

        public java.lang.String getAllocationId()
        Returns the allocation ID for the shard.
        the allocation ID
      • getAnalyzer

        public org.apache.lucene.analysis.Analyzer getAnalyzer()
        Returns the analyzer as the default analyzer in the engines IndexWriter
      • getSimilarity

        public getSimilarity()
        Returns the Similarity used for indexing and searching.
      • getQueryCache

        public getQueryCache()
        Return the cache to use for queries.
      • getQueryCachingPolicy

        public getQueryCachingPolicy()
        Return the policy to use when caching queries.
      • getTranslogConfig

        public TranslogConfig getTranslogConfig()
        Returns the translog config for this engine
      • getFlushMergesAfter

        public TimeValue getFlushMergesAfter()
        Returns a TimeValue at what time interval after the last write modification to the engine finished merges should be automatically flushed. This is used to free up transient disk usage of potentially large segments that are written after the engine became inactive from an indexing perspective.
      • getExternalRefreshListener

        public java.util.List<> getExternalRefreshListener()
        The refresh listeners to add to Lucene for externally visible refreshes
      • getInternalRefreshListener

        public java.util.List<> getInternalRefreshListener()
        The refresh listeners to add to Lucene for internally visible refreshes. These listeners will also be invoked on external refreshes
      • isAutoGeneratedIDsOptimizationEnabled

        public boolean isAutoGeneratedIDsOptimizationEnabled()
        returns true if the engine is allowed to optimize indexing operations with an auto-generated ID
      • getIndexSort

        public getIndexSort()
        Return the sort order of this index, or null if the index has no sort.
      • getCircuitBreakerService

        public CircuitBreakerService getCircuitBreakerService()
        Returns the circuit breaker service for this engine, or null if none is to be used.
      • getPrimaryTermSupplier

        public java.util.function.LongSupplier getPrimaryTermSupplier()
        Returns a supplier that supplies the latest primary term value of the associated shard.