Skip to content

Apache Lucene open-source search software

Add updateDocuments API which accept a query (reopen) (#12346)

Patrick Zhai0c293909c050
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 53272260fea..50229e12dae 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -130,6 +130,9 @@ API Changes
* GITHUB#12268: Add BitSet.clear() without parameters for clearing the entire set
(Jonathan Ellis)
+* GITHUB#12346: add new IndexWriter#updateDocuments(Query, Iterable<Document>) API
+ to update documents atomically, with respect to refresh and commit using a query. (Patrick Zhai)
+
New Features
---------------------
diff --git a/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterDeleteQueue.java b/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterDeleteQueue.java
index 95f1da9e562..f6f6bce44f4 100644
--- a/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterDeleteQueue.java
+++ b/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterDeleteQueue.java
@@ -142,6 +142,10 @@ final class DocumentsWriterDeleteQueue implements Accountable, Closeable {
return new TermNode(term);
}
+ static Node<Query> newNode(Query query) {
+ return new QueryNode(query);
+ }
+
static Node<DocValuesUpdate[]> newNode(DocValuesUpdate... updates) {
return new DocValuesUpdatesNode(updates);
}
@@ -437,6 +441,23 @@ final class DocumentsWriterDeleteQueue implements Accountable, Closeable {
}
}
+ private static final class QueryNode extends Node<Query> {
+
+ QueryNode(Query query) {
+ super(query);
+ }
+
+ @Override
+ void apply(BufferedUpdates bufferedDeletes, int docIDUpto) {
+ bufferedDeletes.addQuery(item, docIDUpto);
+ }
+
+ @Override
+ public String toString() {
+ return "del=" + item;
+ }
+ }
+
private static final class QueryArrayNode extends Node<Query[]> {
QueryArrayNode(Query[] query) {
super(query);
diff --git a/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java b/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
index c089cda0f6f..33cec219fac 100644
--- a/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
+++ b/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
@@ -1521,6 +1521,19 @@ public class IndexWriter
delTerm == null ? null : DocumentsWriterDeleteQueue.newNode(delTerm), docs);
}
+ /**
+ * Similar to {@link #updateDocuments(Term, Iterable)}, but take a query instead of a term to
+ * identify the documents to be updated
+ *
+ * @lucene.experimental
+ */
+ public long updateDocuments(
+ Query delQuery, Iterable<? extends Iterable<? extends IndexableField>> docs)
+ throws IOException {
+ return updateDocuments(
+ delQuery == null ? null : DocumentsWriterDeleteQueue.newNode(delQuery), docs);
+ }
+
private long updateDocuments(
final DocumentsWriterDeleteQueue.Node<?> delNode,
Iterable<? extends Iterable<? extends IndexableField>> docs)
diff --git a/lucene/core/src/test/org/apache/lucene/index/TestIndexWriter.java b/lucene/core/src/test/org/apache/lucene/index/TestIndexWriter.java
index 156d4f596f6..d101927f7e0 100644
--- a/lucene/core/src/test/org/apache/lucene/index/TestIndexWriter.java
+++ b/lucene/core/src/test/org/apache/lucene/index/TestIndexWriter.java
@@ -3476,7 +3476,12 @@ public class TestIndexWriter extends LuceneTestCase {
Document doc = new Document();
doc.add(new StringField("id", id, Field.Store.YES));
if (mixDeletes && random().nextBoolean()) {
- writer.updateDocuments(new Term("id", id), Arrays.asList(doc, doc));
+ if (random().nextBoolean()) {
+ writer.updateDocuments(new Term("id", id), Arrays.asList(doc, doc));
+ } else {
+ writer.updateDocuments(
+ new TermQuery(new Term("id", id)), Arrays.asList(doc, doc));
+ }
} else {
writer.softUpdateDocuments(
new Term("id", id),
diff --git a/lucene/test-framework/src/java/org/apache/lucene/tests/index/RandomIndexWriter.java b/lucene/test-framework/src/java/org/apache/lucene/tests/index/RandomIndexWriter.java
index 11cd73a2aaf..2988957ba29 100644
--- a/lucene/test-framework/src/java/org/apache/lucene/tests/index/RandomIndexWriter.java
+++ b/lucene/test-framework/src/java/org/apache/lucene/tests/index/RandomIndexWriter.java
@@ -39,6 +39,7 @@ import org.apache.lucene.index.TieredMergePolicy;
import org.apache.lucene.internal.tests.IndexWriterAccess;
import org.apache.lucene.internal.tests.TestSecrets;
import org.apache.lucene.search.Query;
+import org.apache.lucene.search.TermQuery;
import org.apache.lucene.store.Directory;
import org.apache.lucene.tests.analysis.MockAnalyzer;
import org.apache.lucene.tests.util.LuceneTestCase;
@@ -283,7 +284,12 @@ public class RandomIndexWriter implements Closeable {
w.softUpdateDocuments(
delTerm, docs, new NumericDocValuesField(config.getSoftDeletesField(), 1));
} else {
- seqNo = w.updateDocuments(delTerm, docs);
+ if (r.nextInt(10) < 3) {
+ // 30% chance
+ seqNo = w.updateDocuments(new TermQuery(delTerm), docs);
+ } else {
+ seqNo = w.updateDocuments(delTerm, docs);
+ }
}
maybeFlushOrCommit();
return seqNo;