How to use

setSoftDeletesField

method

in

org.apache.lucene.index.IndexWriterConfig

private static IndexWriter newIndexWriter(final IndexWriterConfig.OpenMode openMode, final Directory dir, final IndexCommit commit)
  throws IOException {
  assert openMode == IndexWriterConfig.OpenMode.APPEND || commit == null : "can't specify create flag with a commit";
  IndexWriterConfig iwc = new IndexWriterConfig(null)
    .setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
    .setCommitOnClose(false)
    .setIndexCommit(commit)
    // we don't want merges to happen here - we call maybe merge on the engine
    // later once we stared it up otherwise we would need to wait for it here
    // we also don't specify a codec here and merges should use the engines for this index
    .setMergePolicy(NoMergePolicy.INSTANCE)
    .setOpenMode(openMode);
  return new IndexWriter(dir, iwc);
}

protected void addNewHistoryCommit(Directory indexDirectory, Terminal terminal, boolean updateLocalCheckpoint) throws IOException {
  final String historyUUID = UUIDs.randomBase64UUID();
  terminal.println("Marking index with the new history uuid : " + historyUUID);
  // commit the new history id
  final IndexWriterConfig iwc = new IndexWriterConfig(null)
    // we don't want merges to happen here - we call maybe merge on the engine
    // later once we stared it up otherwise we would need to wait for it here
    // we also don't specify a codec here and merges should use the engines for this index
    .setCommitOnClose(false)
    .setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
    .setMergePolicy(NoMergePolicy.INSTANCE)
    .setOpenMode(IndexWriterConfig.OpenMode.APPEND);
  // IndexWriter acquires directory lock by its own
  try (IndexWriter indexWriter = new IndexWriter(indexDirectory, iwc)) {
    final Map<String, String> userData = new HashMap<>();
    indexWriter.getLiveCommitData().forEach(e -> userData.put(e.getKey(), e.getValue()));
    if (updateLocalCheckpoint) {
      // In order to have a safe commit invariant, we have to assign the global checkpoint to the max_seqno of the last commit.
      // We can only safely do it because we will generate a new history uuid this shard.
      final SequenceNumbers.CommitInfo commitInfo = SequenceNumbers.loadSeqNoInfoFromLuceneCommit(userData.entrySet());
      // Also advances the local checkpoint of the last commit to its max_seqno.
      userData.put(SequenceNumbers.LOCAL_CHECKPOINT_KEY, Long.toString(commitInfo.maxSeqNo));
    }
    // commit the new history id
    userData.put(Engine.HISTORY_UUID_KEY, historyUUID);
    indexWriter.setLiveCommitData(userData.entrySet());
    indexWriter.commit();
  }
}

/**
 * This method removes all lucene files from the given directory. It will first try to delete all commit points / segments
 * files to ensure broken commits or corrupted indices will not be opened in the future. If any of the segment files can't be deleted
 * this operation fails.
 */
public static void cleanLuceneIndex(Directory directory) throws IOException {
  try (Lock writeLock = directory.obtainLock(IndexWriter.WRITE_LOCK_NAME)) {
    for (final String file : directory.listAll()) {
      if (file.startsWith(IndexFileNames.SEGMENTS) || file.equals(IndexFileNames.OLD_SEGMENTS_GEN)) {
        directory.deleteFile(file); // remove all segment_N files
      }
    }
  }
  try (IndexWriter writer = new IndexWriter(directory, new IndexWriterConfig(Lucene.STANDARD_ANALYZER)
      .setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
      .setMergePolicy(NoMergePolicy.INSTANCE) // no merges
      .setCommitOnClose(false) // no commits
      .setOpenMode(IndexWriterConfig.OpenMode.CREATE))) // force creation - don't append...
  {
    // do nothing and close this will kick of IndexFileDeleter which will remove all pending files
  }
}

.setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
.setCommitOnClose(false)

.setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
.setIndexCommit(cp)
.setCommitOnClose(false)

.setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
.setOpenMode(IndexWriterConfig.OpenMode.CREATE)
.setCommitOnClose(true));

iwc.setSoftDeletesField(Lucene.SOFT_DELETES_FIELD);
if (softDeleteEnabled) {
  mergePolicy = new RecoverySourcePruneMergePolicy(SourceFieldMapper.RECOVERY_SOURCE_NAME, softDeletesPolicy::getRetentionQuery,

protected void addNewHistoryCommit(Directory indexDirectory, Terminal terminal, boolean updateLocalCheckpoint) throws IOException {
  final String historyUUID = UUIDs.randomBase64UUID();
  terminal.println("Marking index with the new history uuid : " + historyUUID);
  // commit the new history id
  final IndexWriterConfig iwc = new IndexWriterConfig(null)
    // we don't want merges to happen here - we call maybe merge on the engine
    // later once we stared it up otherwise we would need to wait for it here
    // we also don't specify a codec here and merges should use the engines for this index
    .setCommitOnClose(false)
    .setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
    .setMergePolicy(NoMergePolicy.INSTANCE)
    .setOpenMode(IndexWriterConfig.OpenMode.APPEND);
  // IndexWriter acquires directory lock by its own
  try (IndexWriter indexWriter = new IndexWriter(indexDirectory, iwc)) {
    final Map<String, String> userData = new HashMap<>();
    indexWriter.getLiveCommitData().forEach(e -> userData.put(e.getKey(), e.getValue()));
    if (updateLocalCheckpoint) {
      // In order to have a safe commit invariant, we have to assign the global checkpoint to the max_seqno of the last commit.
      // We can only safely do it because we will generate a new history uuid this shard.
      final SequenceNumbers.CommitInfo commitInfo = SequenceNumbers.loadSeqNoInfoFromLuceneCommit(userData.entrySet());
      // Also advances the local checkpoint of the last commit to its max_seqno.
      userData.put(SequenceNumbers.LOCAL_CHECKPOINT_KEY, Long.toString(commitInfo.maxSeqNo));
    }
    // commit the new history id
    userData.put(Engine.HISTORY_UUID_KEY, historyUUID);
    indexWriter.setLiveCommitData(userData.entrySet());
    indexWriter.commit();
  }
}

private static IndexWriter newIndexWriter(final IndexWriterConfig.OpenMode openMode, final Directory dir, final IndexCommit commit)
  throws IOException {
  assert openMode == IndexWriterConfig.OpenMode.APPEND || commit == null : "can't specify create flag with a commit";
  IndexWriterConfig iwc = new IndexWriterConfig(null)
    .setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
    .setCommitOnClose(false)
    .setIndexCommit(commit)
    // we don't want merges to happen here - we call maybe merge on the engine
    // later once we stared it up otherwise we would need to wait for it here
    // we also don't specify a codec here and merges should use the engines for this index
    .setMergePolicy(NoMergePolicy.INSTANCE)
    .setOpenMode(openMode);
  return new IndexWriter(dir, iwc);
}

protected void addNewHistoryCommit(Directory indexDirectory, Terminal terminal, boolean updateLocalCheckpoint) throws IOException {
  final String historyUUID = UUIDs.randomBase64UUID();
  terminal.println("Marking index with the new history uuid : " + historyUUID);
  // commit the new history id
  final IndexWriterConfig iwc = new IndexWriterConfig(null)
    // we don't want merges to happen here - we call maybe merge on the engine
    // later once we stared it up otherwise we would need to wait for it here
    // we also don't specify a codec here and merges should use the engines for this index
    .setCommitOnClose(false)
    .setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
    .setMergePolicy(NoMergePolicy.INSTANCE)
    .setOpenMode(IndexWriterConfig.OpenMode.APPEND);
  // IndexWriter acquires directory lock by its own
  try (IndexWriter indexWriter = new IndexWriter(indexDirectory, iwc)) {
    final Map<String, String> userData = new HashMap<>();
    indexWriter.getLiveCommitData().forEach(e -> userData.put(e.getKey(), e.getValue()));
    if (updateLocalCheckpoint) {
      // In order to have a safe commit invariant, we have to assign the global checkpoint to the max_seqno of the last commit.
      // We can only safely do it because we will generate a new history uuid this shard.
      final SequenceNumbers.CommitInfo commitInfo = SequenceNumbers.loadSeqNoInfoFromLuceneCommit(userData.entrySet());
      // Also advances the local checkpoint of the last commit to its max_seqno.
      userData.put(SequenceNumbers.LOCAL_CHECKPOINT_KEY, Long.toString(commitInfo.maxSeqNo));
    }
    // commit the new history id
    userData.put(Engine.HISTORY_UUID_KEY, historyUUID);
    indexWriter.setLiveCommitData(userData.entrySet());
    indexWriter.commit();
  }
}

/**
 * This method removes all lucene files from the given directory. It will first try to delete all commit points / segments
 * files to ensure broken commits or corrupted indices will not be opened in the future. If any of the segment files can't be deleted
 * this operation fails.
 */
public static void cleanLuceneIndex(Directory directory) throws IOException {
  try (Lock writeLock = directory.obtainLock(IndexWriter.WRITE_LOCK_NAME)) {
    for (final String file : directory.listAll()) {
      if (file.startsWith(IndexFileNames.SEGMENTS) || file.equals(IndexFileNames.OLD_SEGMENTS_GEN)) {
        directory.deleteFile(file); // remove all segment_N files
      }
    }
  }
  try (IndexWriter writer = new IndexWriter(directory, new IndexWriterConfig(Lucene.STANDARD_ANALYZER)
      .setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
      .setMergePolicy(NoMergePolicy.INSTANCE) // no merges
      .setCommitOnClose(false) // no commits
      .setOpenMode(IndexWriterConfig.OpenMode.CREATE))) // force creation - don't append...
  {
    // do nothing and close this will kick of IndexFileDeleter which will remove all pending files
  }
}

.setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
.setCommitOnClose(false)

.setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
.setIndexCommit(cp)
.setCommitOnClose(false)

.setSoftDeletesField(Lucene.SOFT_DELETES_FIELD)
.setOpenMode(IndexWriterConfig.OpenMode.CREATE)
.setCommitOnClose(true));

iwc.setSoftDeletesField(Lucene.SOFT_DELETES_FIELD);
if (softDeleteEnabled) {
  mergePolicy = new RecoverySourcePruneMergePolicy(SourceFieldMapper.RECOVERY_SOURCE_NAME, softDeletesPolicy::getRetentionQuery,