Expose explicit 2-phase commit in IndexWriter

• Key: LUCENE-1274
• Type: New Feature
• Status: Closed
• Resolution: Fixed
• Priority: Minor
• Assignee: Michael McCandless
• Reporter: Michael McCandless
• Component/s: Index
• Affects Version/s: 1.9, 2.0.0, 2.1, 2.2, 2.3, 2.3.1
• Fix Version/s: 2.4

Description

Currently when IndexWriter commits, it does so with a two-phase
commit, internally: first it prepares all the new index files, syncs
them; then it writes a new segments_N file and syncs that, and only if
that is successful does it remove any now un-referenced index files.

However, these two phases are done privately, internal to the commit()
method.

But when Lucene is involved in a transaction with external resources
(eg a database), it's very useful to explicitly break out the prepare
phase from the commit phase.

Spinoff from this thread:

http://mail-archives.apache.org/mod_mbox/lucene-java-dev/200804.mbox/[e-mail]%3E

Comments

I plan to rename abort() to rollback() (deprecating abort()), then add
a new method "prepareCommit()" to IndexWriter. If you call this, then
IndexWriter is left in a mode where a commit is pending. You must
follow this up either with a call to rollback(), which reverts all
changes done since you first opened IndexWriter and closes it, or
commit(), which completes the transaction. prepareCommit() requires
that IndexWriter is opened with autoCommit false.

[Michael McCandless]

Attached patch. I plan to commit in a few days.