Index: lucene/core/src/java/org/apache/lucene/index/PersistentSnapshotDeletionPolicy.java
===================================================================
--- lucene/core/src/java/org/apache/lucene/index/PersistentSnapshotDeletionPolicy.java (revision 1478318)
+++ lucene/core/src/java/org/apache/lucene/index/PersistentSnapshotDeletionPolicy.java (working copy)
@@ -19,10 +19,7 @@
import java.io.Closeable;
import java.io.IOException;
-import java.util.HashMap;
-import java.util.List;
import java.util.Map.Entry;
-import java.util.Map;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.StoredField;
@@ -34,7 +31,7 @@
* A {@link SnapshotDeletionPolicy} which adds a persistence layer so that
* snapshots can be maintained across the life of an application. The snapshots
* are persisted in a {@link Directory} and are committed as soon as
- * {@link #snapshot(String)} or {@link #release(String)} is called.
+ * {@link #snapshot()} or {@link #release(IndexCommit)} is called.
*
* NOTE: this class receives a {@link Directory} to persist the data into
* a Lucene index. It is highly recommended to use a dedicated directory (and on
@@ -50,12 +47,17 @@
* should make sure every {@link IndexWriter} has its own
* {@link PersistentSnapshotDeletionPolicy} and that they all write to a
* different {@link Directory}.
+ *
+ *
This class adds a {@link #release(long)} method to
+ * release commits from a previous snapshot's {@link IndexCommit#getGeneration}.
+ *
+ * @lucene.experimental
*/
public class PersistentSnapshotDeletionPolicy extends SnapshotDeletionPolicy implements Closeable {
// Used to validate that the given directory includes just one document w/ the
- // given ID field. Otherwise, it's not a valid Directory for snapshotting.
- private static final String SNAPSHOTS_ID = "$SNAPSHOTS_DOC$";
+ // given gen field. Otherwise, it's not a valid Directory for snapshotting.
+ private static final String SNAPSHOTS_GENS = "$SNAPSHOTS_DOC$";
// The index writer which maintains the snapshots metadata
private final IndexWriter writer;
@@ -66,20 +68,20 @@
* cannot instantiate the deletion policy (because e.g., some other process
* keeps a lock on the snapshots directory).
*/
- public static Map readSnapshotsInfo(Directory dir) throws IOException {
+ private void loadPriorSnapshots(Directory dir) throws IOException {
IndexReader r = DirectoryReader.open(dir);
- Map snapshots = new HashMap();
try {
int numDocs = r.numDocs();
// index is allowed to have exactly one document or 0.
if (numDocs == 1) {
StoredDocument doc = r.document(r.maxDoc() - 1);
- if (doc.getField(SNAPSHOTS_ID) == null) {
+ if (doc.getField(SNAPSHOTS_GENS) == null) {
throw new IllegalStateException("directory is not a valid snapshots store!");
}
for (StorableField f : doc) {
- if (!f.name().equals(SNAPSHOTS_ID))
- snapshots.put(f.name(), f.stringValue());
+ if (!f.name().equals(SNAPSHOTS_GENS)) {
+ refCounts.put(Long.parseLong(f.name()), Integer.parseInt(f.stringValue()));
+ }
}
} else if (numDocs != 0) {
throw new IllegalStateException(
@@ -88,7 +90,6 @@
} finally {
r.close();
}
- return snapshots;
}
/**
@@ -98,7 +99,7 @@
* @param primary
* the {@link IndexDeletionPolicy} that is used on non-snapshotted
* commits. Snapshotted commits, by definition, are not deleted until
- * explicitly released via {@link #release(String)}.
+ * explicitly released via {@link #release}.
* @param dir
* the {@link Directory} which will be used to persist the snapshots
* information.
@@ -112,7 +113,7 @@
*/
public PersistentSnapshotDeletionPolicy(IndexDeletionPolicy primary,
Directory dir, OpenMode mode, Version matchVersion) throws IOException {
- super(primary, null);
+ super(primary);
// Initialize the index writer over the snapshot directory.
writer = new IndexWriter(dir, new IndexWriterConfig(matchVersion, null).setOpenMode(mode));
@@ -127,9 +128,7 @@
// Initializes the snapshots information. This code should basically run
// only if mode != CREATE, but if it is, it's no harm as we only open the
// reader once and immediately close it.
- for (Entry e : readSnapshotsInfo(dir).entrySet()) {
- registerSnapshotInfo(e.getKey(), e.getValue(), null);
- }
+ loadPriorSnapshots(dir);
} catch (RuntimeException e) {
writer.close(); // don't leave any open file handles
throw e;
@@ -139,43 +138,41 @@
}
}
+ /**
+ * Snapshots the last commit. Once this method returns, the
+ * snapshot information is persisted in the directory.
+ *
+ * @see SnapshotDeletionPolicy#snapshot
+ */
@Override
- public synchronized void onInit(List commits)
- throws IOException {
- // super.onInit() needs to be called first to ensure that initialization
- // behaves as expected. The superclass, SnapshotDeletionPolicy, ensures
- // that any snapshot IDs with empty IndexCommits are released. Since this
- // happens, this class needs to persist these changes.
- super.onInit(commits);
- persistSnapshotInfos(null, null);
+ public synchronized IndexCommit snapshot() throws IOException {
+ IndexCommit ic = super.snapshot();
+ persist();
+ return ic;
}
/**
- * Snapshots the last commit using the given ID. Once this method returns, the
- * snapshot information is persisted in the directory.
+ * Deletes a snapshotted commit. Once this method returns, the snapshot
+ * information is persisted in the directory.
*
- * @see SnapshotDeletionPolicy#snapshot(String)
+ * @see SnapshotDeletionPolicy#release
*/
@Override
- public synchronized IndexCommit snapshot(String id) throws IOException {
- checkSnapshotted(id);
- if (SNAPSHOTS_ID.equals(id)) {
- throw new IllegalArgumentException(id + " is reserved and cannot be used as a snapshot id");
- }
- persistSnapshotInfos(id, lastCommit.getSegmentsFileName());
- return super.snapshot(id);
+ public synchronized void release(IndexCommit commit) throws IOException {
+ super.release(commit);
+ persist();
}
/**
- * Deletes a snapshotted commit by ID. Once this method returns, the snapshot
- * information is committed to the directory.
+ * Deletes a snapshotted commit by generation. Once this method returns, the snapshot
+ * information is persisted in the directory.
*
- * @see SnapshotDeletionPolicy#release(String)
+ * @see IndexCommit#getGeneration
+ * @see SnapshotDeletionPolicy#release
*/
- @Override
- public synchronized void release(String id) throws IOException {
- super.release(id);
- persistSnapshotInfos(null, null);
+ public synchronized void release(long gen) throws IOException {
+ super.releaseGen(gen);
+ persist();
}
/** Closes the index which writes the snapshots to the directory. */
@@ -184,19 +181,15 @@
}
/**
- * Persists all snapshots information. If the given id and segment are not
- * null, it persists their information as well.
+ * Persists all snapshots information.
*/
- private void persistSnapshotInfos(String id, String segment) throws IOException {
+ private void persist() throws IOException {
writer.deleteAll();
Document d = new Document();
- d.add(new StoredField(SNAPSHOTS_ID, ""));
- for (Entry e : super.getSnapshots().entrySet()) {
- d.add(new StoredField(e.getKey(), e.getValue()));
+ d.add(new StoredField(SNAPSHOTS_GENS, ""));
+ for (Entry e : refCounts.entrySet()) {
+ d.add(new StoredField(e.getKey().toString(), e.getValue().toString()));
}
- if (id != null) {
- d.add(new StoredField(id, segment));
- }
writer.addDocument(d);
writer.commit();
}
Index: lucene/core/src/java/org/apache/lucene/index/SnapshotDeletionPolicy.java
===================================================================
--- lucene/core/src/java/org/apache/lucene/index/SnapshotDeletionPolicy.java (revision 1478318)
+++ lucene/core/src/java/org/apache/lucene/index/SnapshotDeletionPolicy.java (working copy)
@@ -19,18 +19,15 @@
import java.util.Collection;
import java.util.HashMap;
-import java.util.HashSet;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
-import java.util.Set;
-import java.util.Map.Entry;
import java.io.IOException;
import org.apache.lucene.store.Directory;
/**
- * An {@link IndexDeletionPolicy} that wraps around any other
+ * An {@link IndexDeletionPolicy} that wraps any other
* {@link IndexDeletionPolicy} and adds the ability to hold and later release
* snapshots of an index. While a snapshot is held, the {@link IndexWriter} will
* not remove any files associated with it even if the index is otherwise being
@@ -41,37 +38,158 @@
*
*
* This class maintains all snapshots in-memory, and so the information is not
- * persisted and not protected against system failures. If persistency is
- * important, you can use {@link PersistentSnapshotDeletionPolicy} (or your own
- * extension) and when creating a new instance of this deletion policy, pass the
- * persistent snapshots information to
- * {@link #SnapshotDeletionPolicy(IndexDeletionPolicy, Map)}.
+ * persisted and not protected against system failures. If persistence is
+ * important, you can use {@link PersistentSnapshotDeletionPolicy}.
*
* @lucene.experimental
*/
public class SnapshotDeletionPolicy extends IndexDeletionPolicy {
- /** Holds a Snapshot's information. */
- private static class SnapshotInfo {
- String id;
- String segmentsFileName;
- IndexCommit commit;
-
- public SnapshotInfo(String id, String segmentsFileName, IndexCommit commit) {
- this.id = id;
- this.segmentsFileName = segmentsFileName;
- this.commit = commit;
+ /** Records how many snapshots are held against each
+ * commit generation */
+ protected Map refCounts = new HashMap();
+
+ /** Used to map gen to IndexCommit. */
+ protected Map indexCommits = new HashMap();
+
+ /** Wrapped {@link IndexDeletionPolicy} */
+ private IndexDeletionPolicy primary;
+
+ /** Most recently committed {@link IndexCommit}. */
+ protected IndexCommit lastCommit;
+
+ /** Sole constructor, taking the incoming {@link
+ * IndexDeletionPolicy} to wrap. */
+ public SnapshotDeletionPolicy(IndexDeletionPolicy primary) {
+ this.primary = primary;
+ }
+
+ @Override
+ public synchronized void onCommit(List commits)
+ throws IOException {
+ primary.onCommit(wrapCommits(commits));
+ lastCommit = commits.get(commits.size() - 1);
+ }
+
+ @Override
+ public synchronized void onInit(List commits)
+ throws IOException {
+ primary.onInit(wrapCommits(commits));
+ for(IndexCommit commit : commits) {
+ if (refCounts.containsKey(commit.getGeneration())) {
+ indexCommits.put(commit.getGeneration(), commit);
+ }
}
-
- @Override
- public String toString() {
- return id + " : " + segmentsFileName;
+ lastCommit = commits.get(commits.size() - 1);
+ }
+
+ /**
+ * Release a snapshotted commit.
+ *
+ * @param commit
+ * the commit previously returned by {@link #snapshot}
+ */
+ public synchronized void release(IndexCommit commit) throws IOException {
+ long gen = commit.getGeneration();
+ releaseGen(gen);
+ }
+
+ /** Release a snapshot by generation. */
+ protected void releaseGen(long gen) throws IOException {
+ Integer refCount = refCounts.get(gen);
+ if (refCount == null) {
+ throw new IllegalArgumentException("commit gen=" + gen + " is not currently snapshotted");
}
+ int refCountInt = refCount.intValue();
+ assert refCountInt > 0;
+ refCountInt--;
+ if (refCountInt == 0) {
+ refCounts.remove(gen);
+ indexCommits.remove(gen);
+ } else {
+ refCounts.put(gen, refCountInt);
+ }
}
+ /**
+ * Snapshots the last commit and returns it. Once a commit is 'snapshotted,' it is protected
+ * from deletion (as long as this {@link IndexDeletionPolicy} is used). The
+ * snapshot can be removed by calling {@link #release(IndexCommit)} followed
+ * by a call to {@link IndexWriter#deleteUnusedFiles()}.
+ *
+ *
+ * NOTE: while the snapshot is held, the files it references will not
+ * be deleted, which will consume additional disk space in your index. If you
+ * take a snapshot at a particularly bad time (say just before you call
+ * forceMerge) then in the worst case this could consume an extra 1X of your
+ * total index size, until you release the snapshot.
+ *
+ * @throws IllegalStateException
+ * if this index does not have any commits yet
+ * @return the {@link IndexCommit} that was snapshotted.
+ */
+ public synchronized IndexCommit snapshot() throws IOException {
+ if (lastCommit == null) {
+ // No commit yet, eg this is a new IndexWriter:
+ throw new IllegalStateException("No index commit to snapshot");
+ }
+
+ long gen = lastCommit.getGeneration();
+
+ Integer refCount = refCounts.get(gen);
+ int refCountInt;
+ if (refCount == null) {
+ indexCommits.put(gen, lastCommit);
+ refCountInt = 0;
+ } else {
+ refCountInt = refCount.intValue();
+ }
+
+ refCounts.put(gen, refCountInt+1);
+
+ return lastCommit;
+ }
+
+ /** Returns the total number of snapshots currently held. */
+ public synchronized int getSnapshotCount() {
+ int total = 0;
+ for(Integer refCount : refCounts.values()) {
+ total += refCount.intValue();
+ }
+
+ return total;
+ }
+
+ /** Retrieve an {@link IndexCommit} from its generation;
+ * returns null if this IndexCommit is not currently
+ * snapshotted */
+ public synchronized IndexCommit getIndexCommit(long gen) {
+ return indexCommits.get(gen);
+ }
+
+ @Override
+ public synchronized IndexDeletionPolicy clone() {
+ SnapshotDeletionPolicy other = (SnapshotDeletionPolicy) super.clone();
+ other.primary = this.primary.clone();
+ other.lastCommit = null;
+ other.refCounts = new HashMap(refCounts);
+ other.indexCommits = new HashMap(indexCommits);
+ return other;
+ }
+
+ /** Wraps each {@link IndexCommit} as a {@link
+ * SnapshotCommitPoint}. */
+ private List wrapCommits(List commits) {
+ List wrappedCommits = new ArrayList(commits.size());
+ for (IndexCommit ic : commits) {
+ wrappedCommits.add(new SnapshotCommitPoint(ic));
+ }
+ return wrappedCommits;
+ }
+
/** Wraps a provided {@link IndexCommit} and prevents it
* from being deleted. */
- protected class SnapshotCommitPoint extends IndexCommit {
+ private class SnapshotCommitPoint extends IndexCommit {
/** The {@link IndexCommit} we are preventing from deletion. */
protected IndexCommit cp;
@@ -87,20 +205,12 @@
return "SnapshotDeletionPolicy.SnapshotCommitPoint(" + cp + ")";
}
- /**
- * Returns true if this segment can be deleted. The default implementation
- * returns false if this segment is currently held as snapshot.
- */
- protected boolean shouldDelete(String segmentsFileName) {
- return !segmentsFileToIDs.containsKey(segmentsFileName);
- }
-
@Override
public void delete() {
synchronized (SnapshotDeletionPolicy.this) {
// Suppress the delete request if this commit point is
// currently snapshotted.
- if (shouldDelete(getSegmentsFileName())) {
+ if (!refCounts.containsKey(cp.getGeneration())) {
cp.delete();
}
}
@@ -141,246 +251,4 @@
return cp.getSegmentCount();
}
}
-
- /** Snapshots info */
- private Map idToSnapshot = new HashMap();
-
- // multiple IDs could point to the same commit point (segments file name)
- private Map> segmentsFileToIDs = new HashMap>();
-
- private IndexDeletionPolicy primary;
-
- /** Most recently committed {@link IndexCommit}. */
- protected IndexCommit lastCommit;
-
- /** Sole constructor, taking the incoming {@link
- * IndexDeletionPolicy} to wrap. */
- public SnapshotDeletionPolicy(IndexDeletionPolicy primary) {
- this.primary = primary;
- }
-
- /**
- * {@link SnapshotDeletionPolicy} wraps another {@link IndexDeletionPolicy} to
- * enable flexible snapshotting.
- *
- * @param primary
- * the {@link IndexDeletionPolicy} that is used on non-snapshotted
- * commits. Snapshotted commits, are not deleted until explicitly
- * released via {@link #release(String)}
- * @param snapshotsInfo
- * A mapping of snapshot ID to the segments filename that is being
- * snapshotted. The expected input would be the output of
- * {@link #getSnapshots()}. A null value signals that there are no
- * initial snapshots to maintain.
- */
- public SnapshotDeletionPolicy(IndexDeletionPolicy primary,
- Map snapshotsInfo) {
- this(primary);
-
- if (snapshotsInfo != null) {
- // Add the ID->segmentIDs here - the actual IndexCommits will be
- // reconciled on the call to onInit()
- for (Entry e : snapshotsInfo.entrySet()) {
- registerSnapshotInfo(e.getKey(), e.getValue(), null);
- }
- }
- }
-
- /**
- * Checks if the given id is already used by another snapshot, and throws
- * {@link IllegalStateException} if it is.
- */
- protected void checkSnapshotted(String id) {
- if (isSnapshotted(id)) {
- throw new IllegalStateException("Snapshot ID " + id
- + " is already used - must be unique");
- }
- }
-
- /** Registers the given snapshot information. */
- protected void registerSnapshotInfo(String id, String segment, IndexCommit commit) {
- idToSnapshot.put(id, new SnapshotInfo(id, segment, commit));
- Set ids = segmentsFileToIDs.get(segment);
- if (ids == null) {
- ids = new HashSet();
- segmentsFileToIDs.put(segment, ids);
- }
- ids.add(id);
- }
-
- /** Wraps each {@link IndexCommit} as a {@link
- * SnapshotCommitPoint}. */
- protected List wrapCommits(List commits) {
- List wrappedCommits = new ArrayList(commits.size());
- for (IndexCommit ic : commits) {
- wrappedCommits.add(new SnapshotCommitPoint(ic));
- }
- return wrappedCommits;
- }
-
- /**
- * Get a snapshotted IndexCommit by ID. The IndexCommit can then be used to
- * open an IndexReader on a specific commit point, or rollback the index by
- * opening an IndexWriter with the IndexCommit specified in its
- * {@link IndexWriterConfig}.
- *
- * @param id
- * a unique identifier of the commit that was snapshotted.
- * @throws IllegalStateException
- * if no snapshot exists by the specified ID.
- * @return The {@link IndexCommit} for this particular snapshot.
- */
- public synchronized IndexCommit getSnapshot(String id) {
- SnapshotInfo snapshotInfo = idToSnapshot.get(id);
- if (snapshotInfo == null) {
- throw new IllegalStateException("No snapshot exists by ID: " + id);
- }
- return snapshotInfo.commit;
- }
-
- /**
- * Get all the snapshots in a map of snapshot IDs to the segments they
- * 'cover.' This can be passed to
- * {@link #SnapshotDeletionPolicy(IndexDeletionPolicy, Map)} in order to
- * initialize snapshots at construction.
- */
- public synchronized Map getSnapshots() {
- Map snapshots = new HashMap();
- for (Entry e : idToSnapshot.entrySet()) {
- snapshots.put(e.getKey(), e.getValue().segmentsFileName);
- }
- return snapshots;
- }
-
- /**
- * Returns true if the given ID is already used by a snapshot. You can call
- * this method before {@link #snapshot(String)} if you are not sure whether
- * the ID is already used or not.
- */
- public boolean isSnapshotted(String id) {
- return idToSnapshot.containsKey(id);
- }
-
- @Override
- public synchronized void onCommit(List commits)
- throws IOException {
- primary.onCommit(wrapCommits(commits));
- lastCommit = commits.get(commits.size() - 1);
- }
-
- @Override
- public synchronized void onInit(List commits)
- throws IOException {
- primary.onInit(wrapCommits(commits));
- lastCommit = commits.get(commits.size() - 1);
-
- /*
- * Assign snapshotted IndexCommits to their correct snapshot IDs as
- * specified in the constructor.
- */
- for (IndexCommit commit : commits) {
- Set ids = segmentsFileToIDs.get(commit.getSegmentsFileName());
- if (ids != null) {
- for (String id : ids) {
- idToSnapshot.get(id).commit = commit;
- }
- }
- }
-
- /*
- * Second, see if there are any instances where a snapshot ID was specified
- * in the constructor but an IndexCommit doesn't exist. In this case, the ID
- * should be removed.
- *
- * Note: This code is protective for extreme cases where IDs point to
- * non-existent segments. As the constructor should have received its
- * information via a call to getSnapshots(), the data should be well-formed.
- */
- // Find lost snapshots
- ArrayList idsToRemove = null;
- for (Entry e : idToSnapshot.entrySet()) {
- if (e.getValue().commit == null) {
- if (idsToRemove == null) {
- idsToRemove = new ArrayList();
- }
- idsToRemove.add(e.getKey());
- }
- }
- // Finally, remove those 'lost' snapshots.
- if (idsToRemove != null) {
- for (String id : idsToRemove) {
- SnapshotInfo info = idToSnapshot.remove(id);
- segmentsFileToIDs.remove(info.segmentsFileName);
- }
- }
- }
-
- /**
- * Release a snapshotted commit by ID.
- *
- * @param id
- * a unique identifier of the commit that is un-snapshotted.
- * @throws IllegalStateException
- * if no snapshot exists by this ID.
- */
- public synchronized void release(String id) throws IOException {
- SnapshotInfo info = idToSnapshot.remove(id);
- if (info == null) {
- throw new IllegalStateException("Snapshot doesn't exist: " + id);
- }
- Set ids = segmentsFileToIDs.get(info.segmentsFileName);
- if (ids != null) {
- ids.remove(id);
- if (ids.size() == 0) {
- segmentsFileToIDs.remove(info.segmentsFileName);
- }
- }
- }
-
- /**
- * Snapshots the last commit. Once a commit is 'snapshotted,' it is protected
- * from deletion (as long as this {@link IndexDeletionPolicy} is used). The
- * commit can be removed by calling {@link #release(String)} using the same ID
- * parameter followed by a call to {@link IndexWriter#deleteUnusedFiles()}.
- *
- * NOTE: ID must be unique in the system. If the same ID is used twice,
- * an {@link IllegalStateException} is thrown.
- *
- * NOTE: while the snapshot is held, the files it references will not
- * be deleted, which will consume additional disk space in your index. If you
- * take a snapshot at a particularly bad time (say just before you call
- * forceMerge) then in the worst case this could consume an extra 1X of your
- * total index size, until you release the snapshot.
- *
- * @param id
- * a unique identifier of the commit that is being snapshotted.
- * @throws IllegalStateException
- * if either there is no 'last commit' to snapshot, or if the
- * parameter 'ID' refers to an already snapshotted commit.
- * @return the {@link IndexCommit} that was snapshotted.
- */
- public synchronized IndexCommit snapshot(String id) throws IOException {
- if (lastCommit == null) {
- // no commit exists. Really shouldn't happen, but might be if SDP is
- // accessed before onInit or onCommit were called.
- throw new IllegalStateException("No index commit to snapshot");
- }
-
- // Can't use the same snapshot ID twice...
- checkSnapshotted(id);
-
- registerSnapshotInfo(id, lastCommit.getSegmentsFileName(), lastCommit);
- return lastCommit;
- }
-
- @Override
- public IndexDeletionPolicy clone() {
- SnapshotDeletionPolicy other = (SnapshotDeletionPolicy) super.clone();
- other.primary = this.primary.clone();
- other.lastCommit = null;
- other.segmentsFileToIDs = new HashMap>(segmentsFileToIDs);
- other.idToSnapshot = new HashMap(idToSnapshot);
- return other;
- }
-
}
Index: lucene/core/src/test/org/apache/lucene/index/TestSnapshotDeletionPolicy.java
===================================================================
--- lucene/core/src/test/org/apache/lucene/index/TestSnapshotDeletionPolicy.java (revision 1478318)
+++ lucene/core/src/test/org/apache/lucene/index/TestSnapshotDeletionPolicy.java (working copy)
@@ -18,8 +18,9 @@
*/
import java.io.IOException;
+import java.util.ArrayList;
import java.util.Collection;
-import java.util.Map;
+import java.util.List;
import java.util.Random;
import org.apache.lucene.analysis.MockAnalyzer;
@@ -28,7 +29,6 @@
import org.apache.lucene.document.TextField;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.IndexInput;
-import org.apache.lucene.store.MockDirectoryWrapper;
import org.apache.lucene.util.LuceneTestCase;
import org.apache.lucene.util.ThreadInterruptedException;
import org.junit.Test;
@@ -63,30 +63,33 @@
}
}
+ protected List snapshots = new ArrayList();
+
protected void prepareIndexAndSnapshots(SnapshotDeletionPolicy sdp,
- IndexWriter writer, int numSnapshots, String snapshotPrefix)
+ IndexWriter writer, int numSnapshots)
throws RuntimeException, IOException {
for (int i = 0; i < numSnapshots; i++) {
// create dummy document to trigger commit.
writer.addDocument(new Document());
writer.commit();
- sdp.snapshot(snapshotPrefix + i);
+ snapshots.add(sdp.snapshot());
}
}
protected SnapshotDeletionPolicy getDeletionPolicy() throws IOException {
- return getDeletionPolicy(null);
+ return new SnapshotDeletionPolicy(new KeepOnlyLastCommitDeletionPolicy());
}
- protected SnapshotDeletionPolicy getDeletionPolicy(Map snapshots) throws IOException {
- return new SnapshotDeletionPolicy(new KeepOnlyLastCommitDeletionPolicy(), snapshots);
- }
-
- protected void assertSnapshotExists(Directory dir, SnapshotDeletionPolicy sdp, int numSnapshots) throws Exception {
+ protected void assertSnapshotExists(Directory dir, SnapshotDeletionPolicy sdp, int numSnapshots, boolean checkIndexCommitSame) throws Exception {
for (int i = 0; i < numSnapshots; i++) {
- IndexCommit snapshot = sdp.getSnapshot("snapshot" + i);
+ IndexCommit snapshot = snapshots.get(i);
checkMaxDoc(snapshot, i + 1);
checkSnapshotExists(dir, snapshot);
+ if (checkIndexCommitSame) {
+ assertSame(snapshot, sdp.getIndexCommit(snapshot.getGeneration()));
+ } else {
+ assertEquals(snapshot.getGeneration(), sdp.getIndexCommit(snapshot.getGeneration()).getGeneration());
+ }
}
}
@@ -177,13 +180,14 @@
*/
public void backupIndex(Directory dir, SnapshotDeletionPolicy dp) throws Exception {
// To backup an index we first take a snapshot:
+ IndexCommit snapshot = dp.snapshot();
try {
- copyFiles(dir, dp.snapshot("id"));
+ copyFiles(dir, snapshot);
} finally {
// Make sure to release the snapshot, otherwise these
// files will never be deleted during this IndexWriter
// session:
- dp.release("id");
+ dp.release(snapshot);
}
}
@@ -240,13 +244,13 @@
Directory dir = newDirectory();
IndexWriter writer = new IndexWriter(dir, getConfig(random(), getDeletionPolicy()));
SnapshotDeletionPolicy sdp = (SnapshotDeletionPolicy) writer.getConfig().getIndexDeletionPolicy();
- prepareIndexAndSnapshots(sdp, writer, numSnapshots, "snapshot");
+ prepareIndexAndSnapshots(sdp, writer, numSnapshots);
writer.close();
- assertSnapshotExists(dir, sdp, numSnapshots);
+ assertSnapshotExists(dir, sdp, numSnapshots, true);
// open a reader on a snapshot - should succeed.
- DirectoryReader.open(sdp.getSnapshot("snapshot0")).close();
+ DirectoryReader.open(snapshots.get(0)).close();
// open a new IndexWriter w/ no snapshots to keep and assert that all snapshots are gone.
sdp = getDeletionPolicy();
@@ -254,15 +258,6 @@
writer.deleteUnusedFiles();
writer.close();
assertEquals("no snapshots should exist", 1, DirectoryReader.listCommits(dir).size());
-
- for (int i = 0; i < numSnapshots; i++) {
- try {
- sdp.getSnapshot("snapshot" + i);
- fail("snapshot shouldn't have existed, but did: snapshot" + i);
- } catch (IllegalStateException e) {
- // expected - snapshot should not exist
- }
- }
dir.close();
}
@@ -273,14 +268,16 @@
final SnapshotDeletionPolicy sdp = (SnapshotDeletionPolicy) writer.getConfig().getIndexDeletionPolicy();
Thread[] threads = new Thread[10];
+ final IndexCommit[] snapshots = new IndexCommit[threads.length];
for (int i = 0; i < threads.length; i++) {
+ final int finalI = i;
threads[i] = new Thread() {
@Override
public void run() {
try {
writer.addDocument(new Document());
writer.commit();
- sdp.snapshot(getName());
+ snapshots[finalI] = sdp.snapshot();
} catch (Exception e) {
throw new RuntimeException(e);
}
@@ -301,8 +298,8 @@
writer.addDocument(new Document());
writer.commit();
- for (Thread t : threads) {
- sdp.release(t.getName());
+ for (int i=0;i snapshots) throws IOException {
- SnapshotDeletionPolicy sdp = getDeletionPolicy();
- if (snapshots != null) {
- for (Entry e: snapshots.entrySet()) {
- sdp.registerSnapshotInfo(e.getKey(), e.getValue(), null);
- }
- }
- return sdp;
- }
-
- @Override
@Test
public void testExistingSnapshots() throws Exception {
int numSnapshots = 3;
Directory dir = newDirectory();
IndexWriter writer = new IndexWriter(dir, getConfig(random(), getDeletionPolicy()));
PersistentSnapshotDeletionPolicy psdp = (PersistentSnapshotDeletionPolicy) writer.getConfig().getIndexDeletionPolicy();
- prepareIndexAndSnapshots(psdp, writer, numSnapshots, "snapshot");
+ prepareIndexAndSnapshots(psdp, writer, numSnapshots);
writer.close();
psdp.close();
@@ -88,19 +74,16 @@
psdp = new PersistentSnapshotDeletionPolicy(
new KeepOnlyLastCommitDeletionPolicy(), snapshotDir, OpenMode.APPEND,
TEST_VERSION_CURRENT);
- new IndexWriter(dir, getConfig(random(), psdp)).close();
- assertSnapshotExists(dir, psdp, numSnapshots);
- assertEquals(numSnapshots, psdp.getSnapshots().size());
+ IndexWriter iw = new IndexWriter(dir, getConfig(random(), psdp));
+ psdp = (PersistentSnapshotDeletionPolicy) iw.getConfig().getIndexDeletionPolicy();
+ iw.close();
+
+ assertSnapshotExists(dir, psdp, numSnapshots, false);
psdp.close();
dir.close();
}
- @Test(expected=IllegalArgumentException.class)
- public void testIllegalSnapshotId() throws Exception {
- getDeletionPolicy().snapshot("$SNAPSHOTS_DOC$");
- }
-
@Test
public void testInvalidSnapshotInfos() throws Exception {
// Add the correct number of documents (1), but without snapshot information
@@ -113,6 +96,7 @@
TEST_VERSION_CURRENT);
fail("should not have succeeded to read from an invalid Directory");
} catch (IllegalStateException e) {
+ // expected
}
}
@@ -144,21 +128,40 @@
Directory dir = newDirectory();
IndexWriter writer = new IndexWriter(dir, getConfig(random(), getDeletionPolicy()));
PersistentSnapshotDeletionPolicy psdp = (PersistentSnapshotDeletionPolicy) writer.getConfig().getIndexDeletionPolicy();
- prepareIndexAndSnapshots(psdp, writer, 1, "snapshot");
+ prepareIndexAndSnapshots(psdp, writer, 1);
writer.close();
- psdp.release("snapshot0");
+ psdp.release(snapshots.get(0));
psdp.close();
psdp = new PersistentSnapshotDeletionPolicy(
new KeepOnlyLastCommitDeletionPolicy(), snapshotDir, OpenMode.APPEND,
TEST_VERSION_CURRENT);
- assertEquals("Should have no snapshots !", 0, psdp.getSnapshots().size());
+ assertEquals("Should have no snapshots !", 0, psdp.getSnapshotCount());
psdp.close();
dir.close();
}
@Test
+ public void testSnapshotReleaseByGeneration() throws Exception {
+ Directory dir = newDirectory();
+ IndexWriter writer = new IndexWriter(dir, getConfig(random(), getDeletionPolicy()));
+ PersistentSnapshotDeletionPolicy psdp = (PersistentSnapshotDeletionPolicy) writer.getConfig().getIndexDeletionPolicy();
+ prepareIndexAndSnapshots(psdp, writer, 1);
+ writer.close();
+
+ psdp.release(snapshots.get(0).getGeneration());
+ psdp.close();
+
+ psdp = new PersistentSnapshotDeletionPolicy(
+ new KeepOnlyLastCommitDeletionPolicy(), snapshotDir, OpenMode.APPEND,
+ TEST_VERSION_CURRENT);
+ assertEquals("Should have no snapshots !", 0, psdp.getSnapshotCount());
+ psdp.close();
+ dir.close();
+ }
+
+ @Test
public void testStaticRead() throws Exception {
// While PSDP is open, it keeps a lock on the snapshots directory and thus
// prevents reading the snapshots information. This test checks that the
@@ -167,7 +170,7 @@
Directory dir = newDirectory();
IndexWriter writer = new IndexWriter(dir, getConfig(random(), getDeletionPolicy()));
PersistentSnapshotDeletionPolicy psdp = (PersistentSnapshotDeletionPolicy) writer.getConfig().getIndexDeletionPolicy();
- prepareIndexAndSnapshots(psdp, writer, numSnapshots, "snapshot");
+ prepareIndexAndSnapshots(psdp, writer, numSnapshots);
writer.close();
dir.close();
@@ -176,16 +179,11 @@
new PersistentSnapshotDeletionPolicy(
new KeepOnlyLastCommitDeletionPolicy(), snapshotDir, OpenMode.APPEND,
TEST_VERSION_CURRENT);
- fail("should not have reached here - the snapshots directory should be locked!");
+ fail("should not have reached here - the snapshots directory should be locked!");
} catch (LockObtainFailedException e) {
// expected
} finally {
psdp.close();
}
-
- // Reading the snapshots info should succeed though
- Map snapshots = PersistentSnapshotDeletionPolicy.readSnapshotsInfo(snapshotDir);
- assertEquals("expected " + numSnapshots + " snapshots, got " + snapshots.size(), numSnapshots, snapshots.size());
}
-
}
Index: lucene/core/src/test/org/apache/lucene/index/TestDirectoryReader.java
===================================================================
--- lucene/core/src/test/org/apache/lucene/index/TestDirectoryReader.java (revision 1478318)
+++ lucene/core/src/test/org/apache/lucene/index/TestDirectoryReader.java (working copy)
@@ -898,13 +898,13 @@
SnapshotDeletionPolicy sdp = (SnapshotDeletionPolicy) writer.getConfig().getIndexDeletionPolicy();
writer.addDocument(new Document());
writer.commit();
- sdp.snapshot("c1");
+ sdp.snapshot();
writer.addDocument(new Document());
writer.commit();
- sdp.snapshot("c2");
+ sdp.snapshot();
writer.addDocument(new Document());
writer.commit();
- sdp.snapshot("c3");
+ sdp.snapshot();
writer.close();
long currentGen = 0;
for (IndexCommit ic : DirectoryReader.listCommits(dir)) {