Uses of Class org.apache.lucene.index.IndexWriterConfig (Lucene 10.5.1 core API)
Description: use: package: org.apache.lucene.index, class: IndexWriterConfig

# Uses of Class
org.apache.lucene.index.IndexWriterConfig

Packages that use IndexWriterConfig
Package
Description
org.apache.lucene.index
Code to maintain and access indices.

- ## Uses of IndexWriterConfig in org.apache.lucene.index

  Methods in org.apache.lucene.index that return IndexWriterConfig
  Modifier and Type
  Method
  Description
  `IndexWriterConfig`
  IndexWriterConfig.`setCheckPendingFlushUpdate(boolean checkPendingFlushOnUpdate)`
  `IndexWriterConfig`
  IndexWriterConfig.`setCodec(Codec codec)`
  Set the `Codec`.
  `IndexWriterConfig`
  IndexWriterConfig.`setCommitOnClose(boolean commitOnClose)`
  Sets if calls `IndexWriter.close()` should first commit before closing.
  `IndexWriterConfig`
  IndexWriterConfig.`setIndexCommit(IndexCommit commit)`
  Expert: allows to open a certain commit point.
  `IndexWriterConfig`
  IndexWriterConfig.`setIndexCreatedVersionMajor(int indexCreatedVersionMajor)`
  Expert: set the compatibility version to use for this index.
  `IndexWriterConfig`
  IndexWriterConfig.`setIndexDeletionPolicy(IndexDeletionPolicy delPolicy)`
  Expert: allows an optional `IndexDeletionPolicy` implementation to be specified.
  `IndexWriterConfig`
  IndexWriterConfig.`setIndexSort(Sort sort)`
  Set the `Sort` order to use for all (flushed and merged) segments.
  `IndexWriterConfig`
  IndexWriterConfig.`setIndexWriterEventListener(IndexWriterEventListener eventListener)`
  Set event listener to record key events in IndexWriter
  `IndexWriterConfig`
  IndexWriterConfig.`setInfoStream(PrintStream printStream)`
  Convenience method that uses `PrintStreamInfoStream`.
  `IndexWriterConfig`
  IndexWriterConfig.`setInfoStream(InfoStream infoStream)`
  Information about merges, deletes and a message when maxFieldLength is reached will be printed to this.
  `IndexWriterConfig`
  IndexWriterConfig.`setLeafSorter(Comparator<LeafReader> leafSorter)`
  Set the comparator for sorting leaf readers.
  `IndexWriterConfig`
  IndexWriterConfig.`setMaxBufferedDocs(int maxBufferedDocs)`
  `IndexWriterConfig`
  IndexWriterConfig.`setMaxFullFlushMergeWaitMillis(long maxFullFlushMergeWaitMillis)`
  Expert: sets the amount of time to wait for merges (during `IndexWriter.commit()` or `IndexWriter.getReader(boolean, boolean)`) returned by MergePolicy.findFullFlushMerges(...).
  `IndexWriterConfig`
  IndexWriterConfig.`setMergedSegmentWarmer(IndexWriter.IndexReaderWarmer mergeSegmentWarmer)`
  `IndexWriterConfig`
  IndexWriterConfig.`setMergePolicy(MergePolicy mergePolicy)`
  `IndexWriterConfig`
  IndexWriterConfig.`setMergeScheduler(MergeScheduler mergeScheduler)`
  Expert: sets the merge scheduler used by this writer.
  `IndexWriterConfig`
  IndexWriterConfig.`setOpenMode(IndexWriterConfig.OpenMode openMode)`
  Specifies `IndexWriterConfig.OpenMode` of the index.
  `IndexWriterConfig`
  IndexWriterConfig.`setParentField(String parentField)`
  Sets the parent document field.
  `IndexWriterConfig`
  IndexWriterConfig.`setRAMBufferSizeMB(double ramBufferSizeMB)`
  `IndexWriterConfig`
  IndexWriterConfig.`setRAMPerThreadHardLimitMB(int perThreadHardLimitMB)`
  Expert: Sets the maximum memory consumption per thread triggering a forced flush if exceeded.
  `IndexWriterConfig`
  IndexWriterConfig.`setReaderPooling(boolean readerPooling)`
  By default, IndexWriter does not pool the SegmentReaders it must open for deletions and merging, unless a near-real-time reader has been obtained by calling `DirectoryReader.open(IndexWriter)`.
  `IndexWriterConfig`
  IndexWriterConfig.`setSimilarity(Similarity similarity)`
  Expert: set the `Similarity` implementation used by this IndexWriter.
  `IndexWriterConfig`
  IndexWriterConfig.`setSoftDeletesField(String softDeletesField)`
  Sets the soft deletes field.
  `IndexWriterConfig`
  IndexWriterConfig.`setUseCompoundFile(boolean useCompoundFile)`
  Constructors in org.apache.lucene.index with parameters of type IndexWriterConfig
  Modifier
  Constructor
  Description
  ``
  `IndexUpgrader(Directory dir, IndexWriterConfig iwc, boolean deletePriorCommits)`
  Creates index upgrader on the given directory, using an `IndexWriter` using the given config.
  ``
  `IndexWriter(Directory d, IndexWriterConfig conf)`
  Constructs a new IndexWriter per the settings given in `conf`.