Package com.apple.foundationdb.record.lucene

Class LuceneRecordContextProperties

java.lang.Object
com.apple.foundationdb.record.lucene.LuceneRecordContextProperties
public final class LuceneRecordContextProperties extends Object
The list of RecordLayerPropertyKey for configuration of the lucene indexing for a FDBRecordContext.

  • Field Details

    • LUCENE_INDEX_COMPRESSION_ENABLED

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Boolean> LUCENE_INDEX_COMPRESSION_ENABLED
      A defined RecordLayerPropertyKey for Boolean type to control whether the compression of lucene index is enabled. It is used as a key to get the property value from RecordLayerPropertyStorage.getPropertyValue(RecordLayerPropertyKey). Call RecordLayerPropertyKey.buildValue(Supplier) with a supplier if you want to override this property with a value other than default.

    • LUCENE_INDEX_ENCRYPTION_ENABLED

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Boolean> LUCENE_INDEX_ENCRYPTION_ENABLED
      A defined RecordLayerPropertyKey for Boolean type to control whether the encryption of lucene index is enabled. It is used as a key to get the property value from RecordLayerPropertyStorage.getPropertyValue(RecordLayerPropertyKey). Call RecordLayerPropertyKey.buildValue(Supplier) with a supplier if you want to override this property with a value other than default.

    • LUCENE_EXECUTOR_SERVICE

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<ExecutorService> LUCENE_EXECUTOR_SERVICE
      An ExecutorService to use for parallel execution in LuceneRecordCursor.

    • LUCENE_SPELLCHECK_SEARCH_UPPER_LIMIT

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Integer> LUCENE_SPELLCHECK_SEARCH_UPPER_LIMIT
      A defined RecordLayerPropertyKey for Integertype to control the number of spellcheck suggestions to look up. It is used as a key to get the property value from RecordLayerPropertyStorage.getPropertyValue(RecordLayerPropertyKey). Call RecordLayerPropertyKey.buildValue(Supplier) with a supplier if you want to override this property with a value other than default.

    • LUCENE_MERGE_MAX_SIZE

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Double> LUCENE_MERGE_MAX_SIZE
      Maximum segment size to produce during normal merging for ordinary full-text search with Lucene.

    • LUCENE_MERGE_SEGMENTS_PER_TIER

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Double> LUCENE_MERGE_SEGMENTS_PER_TIER
      Count of segments after which to merge for ordinary full-text search with Lucene.

    • LUCENE_MULTIPLE_MERGE_OPTIMIZATION_ENABLED

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Boolean> LUCENE_MULTIPLE_MERGE_OPTIMIZATION_ENABLED
      This controls whether Lucene indexes' directories (and their directories for auto-complete) should be merged based on probability to reduce multiple merges per transaction.

    • LUCENE_INDEX_CURSOR_PAGE_SIZE

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Integer> LUCENE_INDEX_CURSOR_PAGE_SIZE
      This controls the page size to scan the basic Lucene index.

    • LUCENE_OPEN_PARALLELISM

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Integer> LUCENE_OPEN_PARALLELISM
      This controls the number of threads used when opening segments in parallel.

    • LUCENE_AGILE_COMMIT_TIME_QUOTA

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Integer> LUCENE_AGILE_COMMIT_TIME_QUOTA
      During merge, commit the agile context right after this time quota is reached. Milliseconds units.

    • LUCENE_AGILE_COMMIT_SIZE_QUOTA

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Integer> LUCENE_AGILE_COMMIT_SIZE_QUOTA
      During merge, commit the agile context right after write size exceeds this value. Bytes units.

    • LUCENE_AGILE_DISABLE_AGILITY_CONTEXT

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Boolean> LUCENE_AGILE_DISABLE_AGILITY_CONTEXT
      If set to true, disable the agility context feature and force every merge to be performed in a single transaction.

    • LUCENE_REPARTITION_DOCUMENT_COUNT

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Integer> LUCENE_REPARTITION_DOCUMENT_COUNT
      Number of documents to move from a partition when its size exceeds LuceneIndexOptions.INDEX_PARTITION_HIGH_WATERMARK.

    • LUCENE_MAX_DOCUMENTS_TO_MOVE_DURING_REPARTITIONING

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Integer> LUCENE_MAX_DOCUMENTS_TO_MOVE_DURING_REPARTITIONING
      Maximum number of documents to move during a re-balancing run.

    • LUCENE_FILE_LOCK_TIME_WINDOW_MILLISECONDS

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Integer> LUCENE_FILE_LOCK_TIME_WINDOW_MILLISECONDS
      Lucene file lock time window in milliseconds. If a file lock is older (or younger) than this value, the lock will be considered invalid.

    • LUCENE_USE_CONCURRENT_MERGE_SCHEDULER

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Boolean> LUCENE_USE_CONCURRENT_MERGE_SCHEDULER
      Use concurrent merge scheduler. The default is now to assume deferred operations when available, and hence assume that merge will not be performed during IO but in a background process.

    • LUCENE_USE_DEFAULT_PRIORITY_DURING_MERGE

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Boolean> LUCENE_USE_DEFAULT_PRIORITY_DURING_MERGE
      Use "default transaction priority" during merge. The default of this prop is true because merge over multiple transactions may be preventing user operations.

    • LUCENE_BLOCK_CACHE_MAXIMUM_SIZE

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Integer> LUCENE_BLOCK_CACHE_MAXIMUM_SIZE
      Lucene block cache maximum size. At most these many blocks will be stored in cache.

    • LUCENE_USE_LEGACY_ASYNC_TO_SYNC

      public static final com.apple.foundationdb.record.provider.foundationdb.properties.RecordLayerPropertyKey<Boolean> LUCENE_USE_LEGACY_ASYNC_TO_SYNC
      Lucene async to sync behavior: Whether to use the legacy async to sync calls or the non-exception-mapping behavior.

  • Constructor Details

    • LuceneRecordContextProperties

      public LuceneRecordContextProperties()