public class IndexWriter extends java.lang.Object implements java.io.Closeable, TwoPhaseCommit, Accountable, MergePolicy.MergeContext
IndexWriter
creates and maintains an index.
The IndexWriterConfig.OpenMode
option on
IndexWriterConfig.setOpenMode(OpenMode)
determines
whether a new index is created, or whether an existing index is
opened. Note that you can open an index with IndexWriterConfig.OpenMode.CREATE
even while readers are using the index. The old readers will
continue to search the "point in time" snapshot they had opened,
and won't see the newly created index until they re-open. If
IndexWriterConfig.OpenMode.CREATE_OR_APPEND
is used IndexWriter will create a
new index if there is not already an index at the provided path
and otherwise open the existing index.
In either case, documents are added with addDocument
and removed with deleteDocuments(Term...)
or deleteDocuments(Query...)
. A document can be updated with updateDocument
(which just deletes
and then adds the entire document). When finished adding, deleting
and updating documents, close
should be called.
Each method that changes the index returns a long
sequence number, which
expresses the effective order in which each change was applied.
commit()
also returns a sequence number, describing which
changes are in the commit point and which are not. Sequence numbers
are transient (not saved into the index in any way) and only valid
within a single IndexWriter
instance.
These changes are buffered in memory and periodically
flushed to the Directory
(during the above method
calls). A flush is triggered when there are enough added documents
since the last flush. Flushing is triggered either by RAM usage of the
documents (see IndexWriterConfig.setRAMBufferSizeMB(double)
) or the
number of added documents (see IndexWriterConfig.setMaxBufferedDocs(int)
).
The default is to flush when RAM usage hits
IndexWriterConfig.DEFAULT_RAM_BUFFER_SIZE_MB
MB. For
best indexing speed you should flush by RAM usage with a
large RAM buffer.
In contrast to the other flush options IndexWriterConfig.setRAMBufferSizeMB(double)
and
IndexWriterConfig.setMaxBufferedDocs(int)
, deleted terms
won't trigger a segment flush. Note that flushing just moves the
internal buffered state in IndexWriter into the index, but
these changes are not visible to IndexReader until either
commit()
or close()
is called. A flush may
also trigger one or more segment merges which by default
run with a background thread so as not to block the
addDocument calls (see below
for changing the MergeScheduler
).
Opening an IndexWriter
creates a lock file for the directory in use. Trying to open
another IndexWriter
on the same directory will lead to a
LockObtainFailedException
.
Expert: IndexWriter
allows an optional
IndexDeletionPolicy
implementation to be specified. You
can use this to control when prior commits are deleted from
the index. The default policy is KeepOnlyLastCommitDeletionPolicy
which removes all prior commits as soon as a new commit is
done. Creating your own policy can allow you to explicitly
keep previous "point in time" commits alive in the index for
some time, either because this is useful for your application,
or to give readers enough time to refresh to the new commit
without having the old commit deleted out from under them.
The latter is necessary when multiple computers take turns opening
their own IndexWriter
and IndexReader
s
against a single shared index mounted via remote filesystems
like NFS which do not support "delete on last close" semantics.
A single computer accessing an index via NFS is fine with the
default deletion policy since NFS clients emulate "delete on
last close" locally. That said, accessing an index via NFS
will likely result in poor performance compared to a local IO
device.
Expert:
IndexWriter
allows you to separately change
the MergePolicy
and the MergeScheduler
.
The MergePolicy
is invoked whenever there are
changes to the segments in the index. Its role is to
select which merges to do, if any, and return a MergePolicy.MergeSpecification
describing the merges.
The default is LogByteSizeMergePolicy
. Then, the MergeScheduler
is invoked with the requested merges and
it decides when and how to run the merges. The default is
ConcurrentMergeScheduler
.
NOTE: if you hit a VirtualMachineError, or disaster strikes during a checkpoint then IndexWriter will close itself. This is a defensive measure in case any internal state (buffered documents, deletions, reference counts) were corrupted. Any subsequent calls will throw an AlreadyClosedException.
NOTE: IndexWriter
instances are completely thread
safe, meaning multiple threads can call any of its
methods, concurrently. If your application requires
external synchronization, you should not
synchronize on the IndexWriter
instance as
this may cause deadlock; use your own (non-Lucene) objects
instead.
NOTE: If you call
Thread.interrupt()
on a thread that's within
IndexWriter, IndexWriter will try to catch this (eg, if
it's in a wait() or Thread.sleep()), and will then throw
the unchecked exception ThreadInterruptedException
and clear the interrupt status on the thread.
Modifier and Type | Class and Description |
---|---|
private static interface |
IndexWriter.DocModifier |
static class |
IndexWriter.DocStats
DocStats for this index
|
private static interface |
IndexWriter.Event
Interface for internal atomic events.
|
static interface |
IndexWriter.IndexReaderWarmer
If
DirectoryReader.open(IndexWriter) has
been called (ie, this writer is in near real-time
mode), then after a merge completes, this class can be
invoked to warm the reader on the newly merged
segment, before the merge commits. |
Modifier and Type | Field and Description |
---|---|
private static int |
actualMaxDocs |
private Analyzer |
analyzer |
(package private) BufferedUpdatesStream |
bufferedUpdatesStream |
private java.util.concurrent.atomic.AtomicLong |
changeCount |
private boolean |
closed |
private boolean |
closing |
(package private) Codec |
codec |
private java.lang.Object |
commitLock |
private java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> |
commitUserData |
private LiveIndexWriterConfig |
config |
(package private) IndexFileDeleter |
deleter |
private boolean |
didMessageState |
private Directory |
directory |
private Directory |
directoryOrig |
(package private) DocumentsWriter |
docWriter |
private boolean |
enableTestPoints
Used only for testing.
|
private java.util.Queue<IndexWriter.Event> |
eventQueue |
private java.util.Collection<java.lang.String> |
filesToCommit |
(package private) java.util.concurrent.atomic.AtomicInteger |
flushCount |
(package private) java.util.concurrent.atomic.AtomicInteger |
flushDeletesCount |
private DocumentsWriter.FlushNotifications |
flushNotifications |
private java.lang.Object |
fullFlushLock |
(package private) FieldInfos.FieldNumbers |
globalFieldNumberMap |
(package private) InfoStream |
infoStream
If enabled, information about merges will be printed to this.
|
private long |
lastCommitChangeCount |
static int |
MAX_DOCS
Hard limit on maximum number of documents that may be added to the
index.
|
static int |
MAX_POSITION
Maximum value of the token position in an indexed field.
|
static int |
MAX_STORED_STRING_LENGTH
Maximum length string for a stored field.
|
static int |
MAX_TERM_LENGTH
Absolute hard maximum length for a term, in bytes once
encoded as UTF8.
|
(package private) java.util.concurrent.atomic.AtomicBoolean |
maybeMerge |
private java.util.List<MergePolicy.OneMerge> |
mergeExceptions |
(package private) java.util.concurrent.atomic.AtomicLong |
mergeFinishedGen
Counts how many merges have completed; this is used by
FrozenBufferedUpdates.apply(org.apache.lucene.index.BufferedUpdatesStream.SegmentState[])
to handle concurrently apply deletes/updates with merges completing. |
private long |
mergeGen |
private int |
mergeMaxNumSegments |
private MergeScheduler |
mergeScheduler |
(package private) java.util.HashSet<SegmentCommitInfo> |
mergingSegments |
(package private) SegmentInfos |
pendingCommit |
(package private) long |
pendingCommitChangeCount |
private java.util.LinkedList<MergePolicy.OneMerge> |
pendingMerges |
(package private) java.util.concurrent.atomic.AtomicLong |
pendingNumDocs
How many documents are in the index, or are in the process of being
added (reserved).
|
(package private) long |
pendingSeqNo |
private ReaderPool |
readerPool |
private java.util.List<SegmentCommitInfo> |
rollbackSegments |
private java.util.Set<MergePolicy.OneMerge> |
runningMerges |
private SegmentInfos |
segmentInfos |
private java.util.Map<SegmentCommitInfo,java.lang.Boolean> |
segmentsToMerge |
(package private) boolean |
softDeletesEnabled |
static java.lang.String |
SOURCE
Key for the source of a segment in the
diagnostics . |
static java.lang.String |
SOURCE_ADDINDEXES_READERS
Source of a segment which results from a call to
addIndexes(CodecReader...) . |
static java.lang.String |
SOURCE_FLUSH
Source of a segment which results from a flush.
|
static java.lang.String |
SOURCE_MERGE
Source of a segment which results from a merge of other segments.
|
private long |
startCommitTime
System.nanoTime() when commit started; used to write
an infoStream message about how long commit took.
|
private boolean |
stopMerges |
(package private) java.util.concurrent.atomic.AtomicReference<java.lang.Throwable> |
tragedy |
(package private) static int |
UNBOUNDED_MAX_MERGE_SEGMENTS |
static java.lang.String |
WRITE_LOCK_NAME
Name of the write lock in the index.
|
private java.util.concurrent.atomic.AtomicBoolean |
writeDocValuesLock |
private Lock |
writeLock |
Constructor and Description |
---|
IndexWriter(Directory d,
IndexWriterConfig conf)
Constructs a new IndexWriter per the settings given in
conf . |
Modifier and Type | Method and Description |
---|---|
private void |
_mergeInit(MergePolicy.OneMerge merge) |
private void |
abortMerges()
Aborts running merges.
|
private java.util.List<Lock> |
acquireWriteLocks(Directory... dirs)
Acquires write locks on all the directories; be sure
to match with a call to
IOUtils.close(java.io.Closeable...) in a
finally clause. |
long |
addDocument(java.lang.Iterable<? extends IndexableField> doc)
Adds a document to this index.
|
long |
addDocuments(java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs)
Atomically adds a block of documents with sequentially
assigned document IDs, such that an external reader
will see all or none of the documents.
|
long |
addIndexes(CodecReader... readers)
Merges the provided indexes into this index.
|
long |
addIndexes(Directory... dirs)
Adds all segments from an array of indexes into this index.
|
(package private) void |
addMergeException(MergePolicy.OneMerge merge) |
private long |
adjustPendingNumDocs(long numDocs) |
void |
advanceSegmentInfosVersion(long newVersion)
If
SegmentInfos.getVersion() is below newVersion then update it to this value. |
(package private) void |
applyAllDeletesAndUpdates() |
private boolean |
assertSoftDeletesCount(CodecReader reader,
int expectedCount) |
private DocValuesUpdate[] |
buildDocValuesUpdate(Term term,
Field[] updates) |
private static void |
carryOverHardDeletes(ReadersAndUpdates mergedReadersAndUpdates,
int maxDoc,
Bits mergeLiveDocs,
Bits prevHardLiveDocs,
Bits currentHardLiveDocs,
MergeState.DocMap segDocMap,
MergeState.DocMap segLeafDocMap)
This method carries over hard-deleted documents that are applied to the source segment during a merge.
|
(package private) void |
changed()
Called internally if any index state has changed.
|
(package private) void |
checkpoint()
Called whenever the SegmentInfos has been updated and
the index files referenced exist (correctly) in the
index directory.
|
(package private) void |
checkpointNoSIS()
Checkpoints with IndexFileDeleter, so it's aware of
new files, and increments changeCount, so on
close/commit we will write a new segments file, but
does NOT bump segmentInfos.version.
|
(package private) SegmentInfos |
cloneSegmentInfos()
Tests should use this method to snapshot the current segmentInfos to have a consistent view
|
void |
close()
Closes all open resources and releases the write lock.
|
private void |
closeMergeReaders(MergePolicy.OneMerge merge,
boolean suppressExceptions) |
long |
commit()
Commits all pending changes (added and deleted
documents, segment merges, added
indexes, etc.) to the index, and syncs all referenced
index files, such that a reader will see the changes
and the index updates will survive an OS or machine
crash or power loss.
|
private long |
commitInternal(MergePolicy mergePolicy) |
private boolean |
commitMerge(MergePolicy.OneMerge merge,
MergeState mergeState) |
private ReadersAndUpdates |
commitMergedDeletesAndUpdates(MergePolicy.OneMerge merge,
MergeState mergeState)
Carefully merges deletes and updates for the segments we just merged.
|
private SegmentCommitInfo |
copySegmentAsIs(SegmentCommitInfo info,
java.lang.String segName,
IOContext context)
Copies the segment files as-is into the IndexWriter's directory.
|
private void |
countSoftDeletes(CodecReader reader,
Bits wrappedLiveDocs,
Bits hardLiveDocs,
Counter softDeleteCounter,
Counter hardDeleteCounter) |
(package private) static void |
createCompoundFile(InfoStream infoStream,
TrackingDirectoryWrapper directory,
SegmentInfo info,
IOContext context,
IOUtils.IOConsumer<java.util.Collection<java.lang.String>> deleteFiles)
NOTE: this method creates a compound file for all files returned by
info.files().
|
void |
decRefDeleter(SegmentInfos segmentInfos)
Record that the files referenced by this
SegmentInfos are no longer in use. |
long |
deleteAll()
Delete all documents in the index.
|
long |
deleteDocuments(Query... queries)
Deletes the document(s) matching any of the provided queries.
|
long |
deleteDocuments(Term... terms)
Deletes the document(s) containing any of the
terms.
|
private void |
deleteNewFiles(java.util.Collection<java.lang.String> files)
Tries to delete the given files if unreferenced
|
void |
deleteUnusedFiles()
Expert: remove any index files that are no longer
used.
|
protected void |
doAfterFlush()
A hook for extending classes to execute operations after pending added and
deleted documents have been flushed to the Directory but before the change
is committed (new segments_N file written).
|
protected void |
doBeforeFlush()
A hook for extending classes to execute operations before pending added and
deleted documents are flushed to the Directory.
|
private boolean |
doFlush(boolean applyAllDeletes)
Returns true a segment was flushed or deletes were applied.
|
private void |
doWait() |
(package private) void |
dropDeletedSegment(SegmentCommitInfo info)
Drops a segment that has 100% deleted documents.
|
protected void |
ensureOpen()
Used internally to throw an
AlreadyClosedException if this IndexWriter has been
closed (closed=true ) or is in the process of
closing (closing=true ). |
protected void |
ensureOpen(boolean failIfClosing)
Used internally to throw an
AlreadyClosedException if this
IndexWriter has been closed or is in the process of closing. |
private void |
ensureValidMerge(MergePolicy.OneMerge merge) |
private boolean |
filesExist(SegmentInfos toSync) |
private void |
finishCommit() |
(package private) void |
finished(FrozenBufferedUpdates packet) |
void |
flush()
|
(package private) void |
flush(boolean triggerMerge,
boolean applyAllDeletes)
Flush all in-memory buffered updates (adds and deletes)
to the Directory.
|
private void |
flushFailed(SegmentInfo info)
Cleans up residuals from a segment that could not be entirely flushed due to an error
|
boolean |
flushNextBuffer()
Expert: Flushes the next pending writer per thread buffer if available or the largest active
non-pending writer per thread buffer in the calling thread.
|
void |
forceMerge(int maxNumSegments)
Forces merge policy to merge segments until there are
<= maxNumSegments . |
void |
forceMerge(int maxNumSegments,
boolean doWait)
Just like
forceMerge(int) , except you can
specify whether the call should block until
all merging completes. |
void |
forceMergeDeletes()
Forces merging of all segments that have deleted
documents.
|
void |
forceMergeDeletes(boolean doWait)
Just like
forceMergeDeletes() , except you can
specify whether the call should block until the
operation completes. |
(package private) static int |
getActualMaxDocs() |
Analyzer |
getAnalyzer()
Returns the analyzer used by this index.
|
(package private) int |
getBufferedDeleteTermsSize() |
LiveIndexWriterConfig |
getConfig()
Returns a
LiveIndexWriterConfig , which can be used to query the IndexWriter
current settings, as well as modify "live" ones. |
Directory |
getDirectory()
Returns the Directory used by this index.
|
IndexWriter.DocStats |
getDocStats()
Returns accurate
IndexWriter.DocStats form this writer. |
(package private) DocumentsWriter |
getDocsWriter() |
java.util.Set<java.lang.String> |
getFieldNames()
Return an unmodifiable set of all field names as visible
from this IndexWriter, across all segments of the index.
|
private FieldInfos.FieldNumbers |
getFieldNumberMap()
Loads or returns the already loaded the global field number map for this
SegmentInfos . |
(package private) int |
getFlushCount() |
(package private) int |
getFlushDeletesCount() |
long |
getFlushingBytes()
Returns the number of bytes currently being flushed
|
InfoStream |
getInfoStream()
Returns the info stream that can be used to log messages
|
java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> |
getLiveCommitData()
Returns the commit user data iterable previously set with
setLiveCommitData(Iterable) , or null if nothing has been set yet. |
long |
getMaxCompletedSequenceNumber()
Returns the highest sequence number across
all completed operations, or 0 if no operations have finished yet.
|
java.util.Set<SegmentCommitInfo> |
getMergingSegments()
Expert: to be used by a
MergePolicy to avoid
selecting merges for segments already being merged. |
MergePolicy.OneMerge |
getNextMerge()
Expert: the
MergeScheduler calls this method to retrieve the next
merge requested by the MergePolicy |
(package private) int |
getNumBufferedDeleteTerms() |
(package private) int |
getNumBufferedDocuments() |
(package private) int |
getPendingUpdatesCount() |
(package private) ReadersAndUpdates |
getPooledInstance(SegmentCommitInfo info,
boolean create) |
(package private) DirectoryReader |
getReader() |
(package private) DirectoryReader |
getReader(boolean applyAllDeletes,
boolean writeAllDeletes)
Expert: returns a readonly reader, covering all
committed as well as un-committed changes to the index.
|
(package private) long |
getReaderPoolRamBytesUsed() |
(package private) int |
getSegmentCount() |
java.lang.Throwable |
getTragicException()
If this
IndexWriter was closed as a side-effect of a tragic exception,
e.g. |
private void |
handleMergeException(java.lang.Throwable t,
MergePolicy.OneMerge merge) |
boolean |
hasDeletions()
Returns true if this index has deletions (including
buffered deletions).
|
boolean |
hasPendingMerges()
Expert: returns true if there are merges waiting to be scheduled.
|
boolean |
hasUncommittedChanges()
Returns true if there may be changes that have not been
committed.
|
(package private) boolean |
holdsFullFlushLock() |
void |
incRefDeleter(SegmentInfos segmentInfos)
Record that the files referenced by this
SegmentInfos are still in use. |
(package private) boolean |
isClosed() |
(package private) static boolean |
isCongruentSort(Sort indexSort,
Sort otherSort)
Returns true if
indexSort is a prefix of otherSort . |
protected boolean |
isEnableTestPoints()
Tests should override this to enable test points.
|
(package private) boolean |
isFullyDeleted(ReadersAndUpdates readersAndUpdates) |
boolean |
isOpen()
Returns
true if this IndexWriter is still open. |
(package private) java.util.List<SegmentCommitInfo> |
listOfSegmentCommitInfos()
Returns an unmodifiable view of the list of all segments of the current segmentInfos
|
(package private) int |
maxDoc(int i) |
private boolean |
maxNumSegmentsMergesPending()
Returns true if any merges in pendingMerges or
runningMerges are maxNumSegments merges.
|
private void |
maybeCloseOnTragicEvent() |
void |
maybeMerge()
Expert: asks the mergePolicy whether any merges are
necessary now and if so, runs the requested merges and
then iterate (test again if merges are needed) until no
more merges are returned by the mergePolicy.
|
(package private) void |
maybeMerge(MergePolicy mergePolicy,
MergeTrigger trigger,
int maxNumSegments) |
void |
merge(MergePolicy.OneMerge merge)
Merges the indicated segments, replacing them in the stack with a
single segment.
|
(package private) void |
mergeFinish(MergePolicy.OneMerge merge)
Does fininishing for a merge, which is fast but holds
the synchronized lock on IndexWriter instance.
|
(package private) void |
mergeInit(MergePolicy.OneMerge merge)
Does initial setup for a merge, which is fast but holds
the synchronized lock on IndexWriter instance.
|
private int |
mergeMiddle(MergePolicy.OneMerge merge,
MergePolicy mergePolicy)
Does the actual (time-consuming) work of the merge,
but without holding synchronized lock on IndexWriter
instance
|
(package private) void |
mergeSuccess(MergePolicy.OneMerge merge)
Hook that's called when the specified merge is complete.
|
private void |
messageState() |
(package private) SegmentCommitInfo |
newestSegment() |
(package private) java.lang.String |
newSegmentName() |
private void |
noDupDirs(Directory... dirs) |
(package private) boolean |
nrtIsCurrent(SegmentInfos infos) |
int |
numDeletedDocs(SegmentCommitInfo info)
Obtain the number of deleted docs for a pooled reader.
|
int |
numDeletesToMerge(SegmentCommitInfo info)
Returns the number of deletes a merge would claim back if the given segment is merged.
|
int |
numRamDocs()
Expert: Return the number of documents currently
buffered in RAM.
|
(package private) void |
onTragicEvent(java.lang.Throwable tragedy,
java.lang.String location)
This method should be called on a tragic event ie.
|
long |
prepareCommit()
Expert: prepare for commit.
|
private long |
prepareCommitInternal() |
private void |
processEvents(boolean triggerMerge) |
private void |
publishFlushedSegment(SegmentCommitInfo newSegment,
FieldInfos fieldInfos,
FrozenBufferedUpdates packet,
FrozenBufferedUpdates globalPacket,
Sorter.DocMap sortMap)
Atomically adds the segment private delete packet and publishes the flushed
segments SegmentInfo to the index writer.
|
(package private) void |
publishFlushedSegments(boolean forced)
Publishes the flushed segment, segment-private deletes (if any) and its
associated global delete (if present) to IndexWriter.
|
(package private) long |
publishFrozenUpdates(FrozenBufferedUpdates packet) |
long |
ramBytesUsed()
Return the memory usage of this object in bytes.
|
(package private) static FieldInfos |
readFieldInfos(SegmentCommitInfo si) |
(package private) boolean |
registerMerge(MergePolicy.OneMerge merge)
Checks whether this merge involves any segments
already participating in a merge.
|
(package private) void |
release(ReadersAndUpdates readersAndUpdates) |
private void |
release(ReadersAndUpdates readersAndUpdates,
boolean assertLiveInfo) |
private void |
reserveDocs(long addedNumDocs)
Anything that will add N docs to the index should reserve first to
make sure it's allowed.
|
private void |
resetMergeExceptions() |
void |
rollback()
Close the
IndexWriter without committing
any changes that have occurred since the last commit
(or since it was opened, if commit hasn't been called). |
private void |
rollbackInternal() |
private void |
rollbackInternalNoCommit() |
(package private) boolean |
segmentCommitInfoExist(SegmentCommitInfo sci)
Checks if the provided segment exists in the current segmentInfos
|
(package private) java.lang.String |
segString()
Returns a string description of all segments, for
debugging.
|
(package private) java.lang.String |
segString(java.lang.Iterable<SegmentCommitInfo> infos) |
private java.lang.String |
segString(SegmentCommitInfo info)
Returns a string description of the specified
segment, for debugging.
|
(package private) static void |
setDiagnostics(SegmentInfo info,
java.lang.String source) |
private static void |
setDiagnostics(SegmentInfo info,
java.lang.String source,
java.util.Map<java.lang.String,java.lang.String> details) |
void |
setLiveCommitData(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> commitUserData)
Sets the iterator to provide the commit user data map at commit time.
|
void |
setLiveCommitData(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> commitUserData,
boolean doIncrementVersion)
Sets the commit user data iterator, controlling whether to advance the
SegmentInfos.getVersion() . |
(package private) static void |
setMaxDocs(int maxDocs)
Used only for testing.
|
private boolean |
shouldClose(boolean waitForClose) |
private void |
shutdown()
Gracefully closes (commits, waits for merges), but calls rollback
if there's an exc so the IndexWriter is always closed.
|
private void |
skipDeletedDoc(DocValuesFieldUpdates.Iterator[] updatesIters,
int deletedDoc) |
long |
softUpdateDocument(Term term,
java.lang.Iterable<? extends IndexableField> doc,
Field... softDeletes)
Expert:
Updates a document by first updating the document(s)
containing
term with the given doc-values fields
and then adding the new document. |
long |
softUpdateDocuments(Term term,
java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs,
Field... softDeletes)
Expert:
Atomically updates documents matching the provided
term with the given doc-values fields
and adds a block of documents with sequentially
assigned document IDs, such that an external reader
will see all or none of the documents.
|
private void |
startCommit(SegmentInfos toSync)
Walk through all files referenced by the current
segmentInfos and ask the Directory to sync each file,
if it wasn't already.
|
private void |
testPoint(java.lang.String message) |
private void |
testReserveDocs(long addedNumDocs)
Does a best-effort check, that the current index would accept this many additional docs, but does not actually reserve them.
|
(package private) SegmentInfos |
toLiveInfos(SegmentInfos sis) |
private void |
tooManyDocs(long addedNumDocs) |
private void |
tragicEvent(java.lang.Throwable tragedy,
java.lang.String location)
This method set the tragic exception unless it's already set and closes the writer
if necessary.
|
long |
tryDeleteDocument(IndexReader readerIn,
int docID)
Expert: attempts to delete by document ID, as long as
the provided reader is a near-real-time reader (from
DirectoryReader.open(IndexWriter) ). |
private long |
tryModifyDocument(IndexReader readerIn,
int docID,
IndexWriter.DocModifier toApply) |
long |
tryUpdateDocValue(IndexReader readerIn,
int docID,
Field... fields)
Expert: attempts to update doc values by document ID, as long as
the provided reader is a near-real-time reader (from
DirectoryReader.open(IndexWriter) ). |
long |
updateBinaryDocValue(Term term,
java.lang.String field,
BytesRef value)
|
private long |
updateDocument(DocumentsWriterDeleteQueue.Node<?> delNode,
java.lang.Iterable<? extends IndexableField> doc) |
long |
updateDocument(Term term,
java.lang.Iterable<? extends IndexableField> doc)
Updates a document by first deleting the document(s)
containing
term and then adding the new
document. |
private long |
updateDocuments(DocumentsWriterDeleteQueue.Node<?> delNode,
java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs) |
long |
updateDocuments(Term delTerm,
java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs)
Atomically deletes documents matching the provided
delTerm and adds a block of documents with sequentially
assigned document IDs, such that an external reader
will see all or none of the documents.
|
long |
updateDocValues(Term term,
Field... updates)
Updates documents' DocValues fields to the given values.
|
long |
updateNumericDocValue(Term term,
java.lang.String field,
long value)
|
private boolean |
updatePendingMerges(MergePolicy mergePolicy,
MergeTrigger trigger,
int maxNumSegments) |
private void |
validate(SegmentCommitInfo info) |
private void |
validateIndexSort()
Confirms that the incoming index sort (if any) matches the existing index sort (if any).
|
private void |
validateMergeReader(CodecReader leaf) |
(package private) void |
waitForMerges()
Wait for any currently outstanding merges to finish.
|
private void |
writeReaderPool(boolean writeDeletes)
Ensures that all changes in the reader-pool are written to disk.
|
(package private) void |
writeSomeDocValuesUpdates() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getChildResources
public static final int MAX_DOCS
IllegalArgumentException
.public static final int MAX_POSITION
private static int actualMaxDocs
private final boolean enableTestPoints
static final int UNBOUNDED_MAX_MERGE_SEGMENTS
public static final java.lang.String WRITE_LOCK_NAME
public static final java.lang.String SOURCE
diagnostics
.public static final java.lang.String SOURCE_MERGE
public static final java.lang.String SOURCE_FLUSH
public static final java.lang.String SOURCE_ADDINDEXES_READERS
addIndexes(CodecReader...)
.public static final int MAX_TERM_LENGTH
IllegalArgumentException
is thrown
and a message is printed to infoStream, if set (see IndexWriterConfig.setInfoStream(InfoStream)
).public static final int MAX_STORED_STRING_LENGTH
final java.util.concurrent.atomic.AtomicReference<java.lang.Throwable> tragedy
private final Directory directoryOrig
private final Directory directory
private final Analyzer analyzer
private final java.util.concurrent.atomic.AtomicLong changeCount
private volatile long lastCommitChangeCount
private java.util.List<SegmentCommitInfo> rollbackSegments
volatile SegmentInfos pendingCommit
volatile long pendingSeqNo
volatile long pendingCommitChangeCount
private java.util.Collection<java.lang.String> filesToCommit
private final SegmentInfos segmentInfos
final FieldInfos.FieldNumbers globalFieldNumberMap
final DocumentsWriter docWriter
private final java.util.Queue<IndexWriter.Event> eventQueue
final IndexFileDeleter deleter
private java.util.Map<SegmentCommitInfo,java.lang.Boolean> segmentsToMerge
private int mergeMaxNumSegments
private Lock writeLock
private volatile boolean closed
private volatile boolean closing
final java.util.concurrent.atomic.AtomicBoolean maybeMerge
private java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> commitUserData
java.util.HashSet<SegmentCommitInfo> mergingSegments
private final MergeScheduler mergeScheduler
private java.util.LinkedList<MergePolicy.OneMerge> pendingMerges
private java.util.Set<MergePolicy.OneMerge> runningMerges
private java.util.List<MergePolicy.OneMerge> mergeExceptions
private long mergeGen
private boolean stopMerges
private boolean didMessageState
final java.util.concurrent.atomic.AtomicInteger flushCount
final java.util.concurrent.atomic.AtomicInteger flushDeletesCount
private final ReaderPool readerPool
final BufferedUpdatesStream bufferedUpdatesStream
final java.util.concurrent.atomic.AtomicLong mergeFinishedGen
FrozenBufferedUpdates.apply(org.apache.lucene.index.BufferedUpdatesStream.SegmentState[])
to handle concurrently apply deletes/updates with merges completing.private final LiveIndexWriterConfig config
private long startCommitTime
final java.util.concurrent.atomic.AtomicLong pendingNumDocs
final boolean softDeletesEnabled
private final DocumentsWriter.FlushNotifications flushNotifications
private final java.util.concurrent.atomic.AtomicBoolean writeDocValuesLock
final Codec codec
final InfoStream infoStream
private final java.lang.Object commitLock
private final java.lang.Object fullFlushLock
public IndexWriter(Directory d, IndexWriterConfig conf) throws java.io.IOException
conf
.
If you want to make "live" changes to this writer instance, use
getConfig()
.
NOTE: after ths writer is created, the given configuration instance cannot be passed to another writer.
d
- the index directory. The index is either created or appended
according conf.getOpenMode()
.conf
- the configuration settings according to which IndexWriter should
be initialized.java.io.IOException
- if the directory cannot be read/written to, or if it does not
exist and conf.getOpenMode()
is
OpenMode.APPEND
or if there is any other low-level
IO errorstatic void setMaxDocs(int maxDocs)
static int getActualMaxDocs()
DirectoryReader getReader() throws java.io.IOException
java.io.IOException
DirectoryReader getReader(boolean applyAllDeletes, boolean writeAllDeletes) throws java.io.IOException
commit()
.
Note that this is functionally equivalent to calling
{#flush} and then opening a new reader. But the turnaround time of this
method should be faster since it avoids the potentially
costly commit()
.
You must close the IndexReader
returned by
this method once you are done using it.
It's near real-time because there is no hard guarantee on how quickly you can get a new reader after making changes with IndexWriter. You'll have to experiment in your situation to determine if it's fast enough. As this is a new and experimental feature, please report back on your findings so we can learn, improve and iterate.
The resulting reader supports DirectoryReader.openIfChanged(org.apache.lucene.index.DirectoryReader)
, but that call will simply forward
back to this method (though this may change in the
future).
The very first time this method is called, this writer instance will make every effort to pool the readers that it opens for doing merges, applying deletes, etc. This means additional resources (RAM, file descriptors, CPU time) will be consumed.
For lower latency on reopening a reader, you should
call IndexWriterConfig.setMergedSegmentWarmer(org.apache.lucene.index.IndexWriter.IndexReaderWarmer)
to
pre-warm a newly merged segment before it's committed
to the index. This is important for minimizing
index-to-search delay after a large merge.
If an addIndexes* call is running in another thread, then this reader will only search those segments from the foreign index that have been successfully copied over, so far
.NOTE: Once the writer is closed, any
outstanding readers may continue to be used. However,
if you attempt to reopen any of those readers, you'll
hit an AlreadyClosedException
.
java.io.IOException
- If there is a low-level I/O errorpublic final long ramBytesUsed()
Accountable
ramBytesUsed
in interface Accountable
public final long getFlushingBytes()
final long getReaderPoolRamBytesUsed()
void writeSomeDocValuesUpdates() throws java.io.IOException
java.io.IOException
public int numDeletedDocs(SegmentCommitInfo info)
numDeletedDocs
in interface MergePolicy.MergeContext
protected final void ensureOpen(boolean failIfClosing) throws AlreadyClosedException
AlreadyClosedException
if this
IndexWriter has been closed or is in the process of closing.failIfClosing
- if true, also fail when IndexWriter
is in the process of
closing (closing=true
) but not yet done closing (
closed=false
)AlreadyClosedException
- if this IndexWriter is closed or in the process of closingprotected final void ensureOpen() throws AlreadyClosedException
AlreadyClosedException
if this IndexWriter has been
closed (closed=true
) or is in the process of
closing (closing=true
).
Calls ensureOpen(true)
.
AlreadyClosedException
- if this IndexWriter is closedprivate void validateIndexSort()
static boolean isCongruentSort(Sort indexSort, Sort otherSort)
indexSort
is a prefix of otherSort
.static FieldInfos readFieldInfos(SegmentCommitInfo si) throws java.io.IOException
java.io.IOException
private FieldInfos.FieldNumbers getFieldNumberMap() throws java.io.IOException
SegmentInfos
.
If this SegmentInfos
has no global field number map the returned instance is emptyjava.io.IOException
public LiveIndexWriterConfig getConfig()
LiveIndexWriterConfig
, which can be used to query the IndexWriter
current settings, as well as modify "live" ones.private void messageState()
private void shutdown() throws java.io.IOException
close()
when LiveIndexWriterConfig.commitOnClose
is
true
.java.io.IOException
public void close() throws java.io.IOException
LiveIndexWriterConfig.commitOnClose
is true
,
this will attempt to gracefully shut down by writing any
changes, waiting for any running merges, committing, and closing.
In this case, note that:
IllegalStateException
and the IndexWriter
will not be closed.IndexWriter
will be closed, but changes may have been lost.
Note that this may be a costly
operation, so, try to re-use a single writer instead of
closing and opening a new one. See commit()
for
caveats about write caching done by some IO devices.
NOTE: You must ensure no other threads are still making changes at the same time that this method is invoked.
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
java.io.IOException
private boolean shouldClose(boolean waitForClose)
public Directory getDirectory()
public InfoStream getInfoStream()
MergePolicy.MergeContext
getInfoStream
in interface MergePolicy.MergeContext
public Analyzer getAnalyzer()
public void advanceSegmentInfosVersion(long newVersion)
SegmentInfos.getVersion()
is below newVersion
then update it to this value.public boolean hasDeletions()
public long addDocument(java.lang.Iterable<? extends IndexableField> doc) throws java.io.IOException
Note that if an Exception is hit (for example disk full) then the index will be consistent, but this document may not have been added. Furthermore, it's possible the index will have one segment in non-compound format even when using compound files (when a merge has partially succeeded).
This method periodically flushes pending documents
to the Directory (see above), and
also periodically triggers segment merges in the index
according to the MergePolicy
in use.
Merges temporarily consume space in the
directory. The amount of space required is up to 1X the
size of all segments being merged, when no
readers/searchers are open against the index, and up to
2X the size of all segments being merged when
readers/searchers are open against the index (see
forceMerge(int)
for details). The sequence of
primitive merge operations performed is governed by the
merge policy.
Note that each term in the document can be no longer
than MAX_TERM_LENGTH
in bytes, otherwise an
IllegalArgumentException will be thrown.
Note that it's possible to create an invalid Unicode string in java if a UTF16 surrogate pair is malformed. In this case, the invalid characters are silently replaced with the Unicode replacement character U+FFFD.
CorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorpublic long addDocuments(java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs) throws java.io.IOException
WARNING: the index does not currently record which documents were added as a block. Today this is fine, because merging will preserve a block. The order of documents within a segment will be preserved, even when child documents within a block are deleted. Most search features (like result grouping and block joining) require you to mark documents; when these documents are deleted these search features will not work as expected. Obviously adding documents to an existing block will require you the reindex the entire block.
However it's possible that in the future Lucene may merge more aggressively re-order documents (for example, perhaps to obtain better index compression), in which case you may need to fully re-index your documents at that time.
See addDocument(Iterable)
for details on
index and IndexWriter state after an Exception, and
flushing/merging temporary free space requirements.
NOTE: tools that do offline splitting of an index (for example, IndexSplitter in contrib) or re-sorting of documents (for example, IndexSorter in contrib) are not aware of these atomically added documents and will likely break them up. Use such tools at your own risk!
CorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorpublic long updateDocuments(Term delTerm, java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs) throws java.io.IOException
addDocuments(Iterable)
.CorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorprivate long updateDocuments(DocumentsWriterDeleteQueue.Node<?> delNode, java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs) throws java.io.IOException
java.io.IOException
public long softUpdateDocuments(Term term, java.lang.Iterable<? extends java.lang.Iterable<? extends IndexableField>> docs, Field... softDeletes) throws java.io.IOException
updateDocuments(Term, Iterable)
this method will not delete documents in the index
matching the given term but instead update them with
the given doc-values fields which can be used as a
soft-delete mechanism.
See addDocuments(Iterable)
and updateDocuments(Term, Iterable)
.CorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorpublic long tryDeleteDocument(IndexReader readerIn, int docID) throws java.io.IOException
DirectoryReader.open(IndexWriter)
). If the
provided reader is an NRT reader obtained from this
writer, and its segment has not been merged away, then
the delete succeeds and this method returns a valid (> 0) sequence
number; else, it returns -1 and the caller must then
separately delete by Term or Query.
NOTE: this method can only delete documents
visible to the currently open NRT reader. If you need
to delete documents indexed after opening the NRT
reader you must use deleteDocuments(Term...)
).java.io.IOException
public long tryUpdateDocValue(IndexReader readerIn, int docID, Field... fields) throws java.io.IOException
DirectoryReader.open(IndexWriter)
). If the
provided reader is an NRT reader obtained from this
writer, and its segment has not been merged away, then
the update succeeds and this method returns a valid (> 0) sequence
number; else, it returns -1 and the caller must then
either retry the update and resolve the document again.
If a doc values fields data is null
the existing
value is removed from all documents matching the term. This can be used
to un-delete a soft-deleted document since this method will apply the
field update even if the document is marked as deleted.
NOTE: this method can only updates documents
visible to the currently open NRT reader. If you need
to update documents indexed after opening the NRT
reader you must use updateDocValues(Term, Field...)
.java.io.IOException
private long tryModifyDocument(IndexReader readerIn, int docID, IndexWriter.DocModifier toApply) throws java.io.IOException
java.io.IOException
void dropDeletedSegment(SegmentCommitInfo info) throws java.io.IOException
java.io.IOException
public long deleteDocuments(Term... terms) throws java.io.IOException
terms
- array of terms to identify the documents
to be deletedCorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorpublic long deleteDocuments(Query... queries) throws java.io.IOException
queries
- array of queries to identify the documents
to be deletedCorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorpublic long updateDocument(Term term, java.lang.Iterable<? extends IndexableField> doc) throws java.io.IOException
term
and then adding the new
document. The delete and then add are atomic as seen
by a reader on the same index (flush may happen only after
the add).term
- the term to identify the document(s) to be
deleteddoc
- the document to be addedCorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorprivate long updateDocument(DocumentsWriterDeleteQueue.Node<?> delNode, java.lang.Iterable<? extends IndexableField> doc) throws java.io.IOException
java.io.IOException
public long softUpdateDocument(Term term, java.lang.Iterable<? extends IndexableField> doc, Field... softDeletes) throws java.io.IOException
term
with the given doc-values fields
and then adding the new document. The doc-values update and
then add are atomic as seen by a reader on the same index
(flush may happen only after the add).
One use of this API is to retain older versions of
documents instead of replacing them. The existing
documents can be updated to reflect they are no
longer current while atomically adding new documents
at the same time.
In contrast to updateDocument(Term, Iterable)
this method will not delete documents in the index
matching the given term but instead update them with
the given doc-values fields which can be used as a
soft-delete mechanism.
See addDocuments(Iterable)
and updateDocuments(Term, Iterable)
.CorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorpublic long updateNumericDocValue(Term term, java.lang.String field, long value) throws java.io.IOException
NumericDocValues
for field
to the
given value
. You can only update fields that already exist in
the index, not add new fields through this method.term
- the term to identify the document(s) to be updatedfield
- field name of the NumericDocValues
fieldvalue
- new value for the fieldCorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorpublic long updateBinaryDocValue(Term term, java.lang.String field, BytesRef value) throws java.io.IOException
BinaryDocValues
for field
to the
given value
. You can only update fields that already exist in
the index, not add new fields through this method.
NOTE: this method currently replaces the existing value of all affected documents with the new value.
term
- the term to identify the document(s) to be updatedfield
- field name of the BinaryDocValues
fieldvalue
- new value for the fieldCorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorpublic long updateDocValues(Term term, Field... updates) throws java.io.IOException
Term
to the same value. All updates are atomically applied and
flushed together. If a doc values fields data is null
the existing
value is removed from all documents matching the term.updates
- the updates to applyCorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorprivate DocValuesUpdate[] buildDocValuesUpdate(Term term, Field[] updates)
final int getSegmentCount()
final int getNumBufferedDocuments()
final int maxDoc(int i)
final int getFlushCount()
final int getFlushDeletesCount()
public java.util.Set<java.lang.String> getFieldNames()
updateDocValues(Term, Field...)
is
attempted. We could phase out this method if
updateDocValues(Term, Field...)
could create the non-existent
docValues fields as necessary, instead of throwing
IllegalArgumentException for attempts to update non-existent
docValues fields.final java.lang.String newSegmentName()
public void forceMerge(int maxNumSegments) throws java.io.IOException
<= maxNumSegments
. The actual merges to be
executed are determined by the MergePolicy
.
This is a horribly costly operation, especially when
you pass a small maxNumSegments
; usually you
should only call this if the index is static (will no
longer be changed).
Note that this requires free space that is proportional
to the size of the index in your Directory: 2X if you are
not using compound file format, and 3X if you are.
For example, if your index size is 10 MB then you need
an additional 20 MB free for this to complete (30 MB if
you're using compound file format). This is also affected
by the Codec
that is used to execute the merge,
and may result in even a bigger index. Also, it's best
to call commit()
afterwards, to allow IndexWriter
to free up disk space.
If some but not all readers re-open while merging
is underway, this will cause > 2X
temporary
space to be consumed as those new readers will then
hold open the temporary segments at that time. It is
best not to re-open readers while merging is running.
The actual temporary usage could be much less than these figures (it depends on many factors).
In general, once this completes, the total size of the index will be less than the size of the starting index. It could be quite a bit smaller (if there were many pending deletes) or just slightly smaller.
If an Exception is hit, for example due to disk full, the index will not be corrupted and no documents will be lost. However, it may have been partially merged (some segments were merged but not all), and it's possible that one of the segments in the index will be in non-compound format even when using compound file format. This will occur when the Exception is hit during conversion of the segment into compound format.
This call will merge those segments present in the index when the call started. If other threads are still adding documents and flushing segments, those newly created segments will not be merged unless you call forceMerge again.
maxNumSegments
- maximum number of segments left
in the index after merging finishesCorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorMergePolicy.findMerges(org.apache.lucene.index.MergeTrigger, org.apache.lucene.index.SegmentInfos, org.apache.lucene.index.MergePolicy.MergeContext)
public void forceMerge(int maxNumSegments, boolean doWait) throws java.io.IOException
forceMerge(int)
, except you can
specify whether the call should block until
all merging completes. This is only meaningful with a
MergeScheduler
that is able to run merges in
background threads.java.io.IOException
private boolean maxNumSegmentsMergesPending()
public void forceMergeDeletes(boolean doWait) throws java.io.IOException
forceMergeDeletes()
, except you can
specify whether the call should block until the
operation completes. This is only meaningful with a
MergeScheduler
that is able to run merges in
background threads.java.io.IOException
public void forceMergeDeletes() throws java.io.IOException
MergePolicy
. For example,
the default TieredMergePolicy
will only
pick a segment if the percentage of
deleted docs is over 10%.
This is often a horribly costly operation; rarely is it warranted.
To see how
many deletions you have pending in your index, call
IndexReader.numDeletedDocs()
.
NOTE: this method first flushes a new segment (if there are indexed documents), and applies all buffered deletes.
java.io.IOException
public final void maybeMerge() throws java.io.IOException
MergePolicy
with
MergeTrigger.EXPLICIT
.java.io.IOException
final void maybeMerge(MergePolicy mergePolicy, MergeTrigger trigger, int maxNumSegments) throws java.io.IOException
java.io.IOException
private boolean updatePendingMerges(MergePolicy mergePolicy, MergeTrigger trigger, int maxNumSegments) throws java.io.IOException
java.io.IOException
public java.util.Set<SegmentCommitInfo> getMergingSegments()
MergePolicy
to avoid
selecting merges for segments already being merged.
The returned collection is not cloned, and thus is
only safe to access if you hold IndexWriter's lock
(which you do when IndexWriter invokes the
MergePolicy).
The Set is unmodifiable.
getMergingSegments
in interface MergePolicy.MergeContext
public MergePolicy.OneMerge getNextMerge()
MergeScheduler
calls this method to retrieve the next
merge requested by the MergePolicypublic boolean hasPendingMerges()
public void rollback() throws java.io.IOException
IndexWriter
without committing
any changes that have occurred since the last commit
(or since it was opened, if commit hasn't been called).
This removes any temporary files that had been created,
after which the state of the index will be the same as
it was when commit() was last called or when this
writer was first opened. This also clears a previous
call to prepareCommit()
.rollback
in interface TwoPhaseCommit
java.io.IOException
- if there is a low-level IO errorprivate void rollbackInternal() throws java.io.IOException
java.io.IOException
private void rollbackInternalNoCommit() throws java.io.IOException
java.io.IOException
public long deleteAll() throws java.io.IOException
This method will drop all buffered documents and will remove all segments
from the index. This change will not be visible until a commit()
has been called. This method can be rolled back using rollback()
.
NOTE: this method is much faster than using deleteDocuments( new
MatchAllDocsQuery() ). Yet, this method also has different semantics
compared to deleteDocuments(Query...)
since internal
data-structures are cleared as well as all segment information is
forcefully dropped anti-viral semantics like omitting norms are reset or
doc value types are cleared. Essentially a call to deleteAll()
is
equivalent to creating a new IndexWriter
with
IndexWriterConfig.OpenMode.CREATE
which a delete query only marks documents as
deleted.
NOTE: this method will forcefully abort all merges in progress. If other
threads are running forceMerge(int)
, addIndexes(CodecReader[])
or forceMergeDeletes(boolean)
methods, they may receive
MergePolicy.MergeAbortedException
s.
java.io.IOException
private void abortMerges()
void waitForMerges() throws java.io.IOException
It is guaranteed that any merges started prior to calling this method will have completed once this method completes.
java.io.IOException
void checkpoint() throws java.io.IOException
java.io.IOException
void checkpointNoSIS() throws java.io.IOException
java.io.IOException
void changed()
long publishFrozenUpdates(FrozenBufferedUpdates packet)
private void publishFlushedSegment(SegmentCommitInfo newSegment, FieldInfos fieldInfos, FrozenBufferedUpdates packet, FrozenBufferedUpdates globalPacket, Sorter.DocMap sortMap) throws java.io.IOException
java.io.IOException
private void resetMergeExceptions()
private void noDupDirs(Directory... dirs)
private java.util.List<Lock> acquireWriteLocks(Directory... dirs) throws java.io.IOException
IOUtils.close(java.io.Closeable...)
in a
finally clause.java.io.IOException
public long addIndexes(Directory... dirs) throws java.io.IOException
This may be used to parallelize batch indexing. A large document collection can be broken into sub-collections. Each sub-collection can be indexed in parallel, on a different thread, process or machine. The complete index can then be created by merging sub-collection indexes with this method.
NOTE: this method acquires the write lock in
each directory, to ensure that no IndexWriter
is currently open or tries to open while this is
running.
This method is transactional in how Exceptions are handled: it does not commit a new segments_N file until all indexes are added. This means if an Exception occurs (for example disk full), then either no indexes will have been added or they all will have been.
Note that this requires temporary free space in the
Directory
up to 2X the sum of all input indexes
(including the starting index). If readers/searchers
are open against the starting index, then temporary
free space required will be higher by the size of the
starting index (see forceMerge(int)
for details).
This requires this index not be among those to be added.
All added indexes must have been created by the same Lucene version as this index.
CorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorjava.lang.IllegalArgumentException
- if addIndexes would cause
the index to exceed MAX_DOCS
, or if the indoming
index sort does not match this index's index sortprivate void validateMergeReader(CodecReader leaf)
public long addIndexes(CodecReader... readers) throws java.io.IOException
The provided IndexReaders are not closed.
See addIndexes(org.apache.lucene.store.Directory...)
for details on transactional semantics, temporary
free space required in the Directory, and non-CFS segments on an Exception.
NOTE: empty segments are dropped by this method and not added to this index.
NOTE: this merges all given LeafReader
s in one
merge. If you intend to merge a large number of readers, it may be better
to call this method multiple times, each time with a small set of readers.
In principle, if you use a merge policy with a mergeFactor
or
maxMergeAtOnce
parameter, you should pass that many readers in one
call.
NOTE: this method does not call or make use of the MergeScheduler
,
so any custom bandwidth throttling is at the moment ignored.
CorruptIndexException
- if the index is corruptjava.io.IOException
- if there is a low-level IO errorjava.lang.IllegalArgumentException
- if addIndexes would cause the index to exceed MAX_DOCS
private SegmentCommitInfo copySegmentAsIs(SegmentCommitInfo info, java.lang.String segName, IOContext context) throws java.io.IOException
java.io.IOException
protected void doAfterFlush() throws java.io.IOException
java.io.IOException
protected void doBeforeFlush() throws java.io.IOException
java.io.IOException
public final long prepareCommit() throws java.io.IOException
Expert: prepare for commit. This does the
first phase of 2-phase commit. This method does all
steps necessary to commit changes since this writer
was opened: flushes pending added and deleted docs,
syncs the index files, writes most of next segments_N
file. After calling this you must call either commit()
to finish the commit, or rollback()
to revert the commit and undo all changes
done since the writer was opened.
You can also just call commit()
directly
without prepareCommit first in which case that method
will internally call prepareCommit.
prepareCommit
in interface TwoPhaseCommit
java.io.IOException
public final boolean flushNextBuffer() throws java.io.IOException
Expert: Flushes the next pending writer per thread buffer if available or the largest active
non-pending writer per thread buffer in the calling thread.
This can be used to flush documents to disk outside of an indexing thread. In contrast to flush()
this won't mark all currently active indexing buffers as flush-pending.
Note: this method is best-effort and might not flush any segments to disk. If there is a full flush happening
concurrently multiple segments might have been flushed.
Users of this API can access the IndexWriters current memory consumption via ramBytesUsed()
true
iff this method flushed at least on segment to disk.java.io.IOException
private long prepareCommitInternal() throws java.io.IOException
java.io.IOException
private final void writeReaderPool(boolean writeDeletes) throws java.io.IOException
writeDeletes
- if true
if deletes should be written to disk too.java.io.IOException
public final void setLiveCommitData(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> commitUserData)
committed
even if
there are no other changes this writer. Note that you must call this method
before prepareCommit()
. Otherwise it won't be included in the
follow-on commit()
.
NOTE: the iterator is late-binding: it is only visited once all documents for the commit have been written to their segments, before the next segments_N file is written
public final void setLiveCommitData(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> commitUserData, boolean doIncrementVersion)
SegmentInfos.getVersion()
.setLiveCommitData(Iterable)
public final java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.String>> getLiveCommitData()
setLiveCommitData(Iterable)
, or null if nothing has been set yet.public final long commit() throws java.io.IOException
Commits all pending changes (added and deleted documents, segment merges, added indexes, etc.) to the index, and syncs all referenced index files, such that a reader will see the changes and the index updates will survive an OS or machine crash or power loss. Note that this does not wait for any running background merges to finish. This may be a costly operation, so you should test the cost in your application and do it only when really necessary.
Note that this operation calls Directory.sync on the index files. That call should not return until the file contents and metadata are on stable storage. For FSDirectory, this calls the OS's fsync. But, beware: some hardware devices may in fact cache writes even during fsync, and return before the bits are actually on stable storage, to give the appearance of faster performance. If you have such a device, and it does not have a battery backup (for example) then on power loss it may still lose data. Lucene cannot guarantee consistency on such devices.
If nothing was committed, because there were no pending changes, this returns -1. Otherwise, it returns the sequence number such that all indexing operations prior to this sequence will be included in the commit point, and all other operations will not.
commit
in interface TwoPhaseCommit
java.io.IOException
prepareCommit()
public final boolean hasUncommittedChanges()
commit()
, or a concurrent
merged finished, this method may return true right
after you had just called commit()
.private final long commitInternal(MergePolicy mergePolicy) throws java.io.IOException
java.io.IOException
private final void finishCommit() throws java.io.IOException
java.io.IOException
boolean holdsFullFlushLock()
public final void flush() throws java.io.IOException
Directory
, but does not commit
(fsync) them (call commit()
for that).java.io.IOException
final void flush(boolean triggerMerge, boolean applyAllDeletes) throws java.io.IOException
triggerMerge
- if true, we may merge segments (if
deletes or docs were flushed) if necessaryapplyAllDeletes
- whether pending deletes should alsojava.io.IOException
private boolean doFlush(boolean applyAllDeletes) throws java.io.IOException
java.io.IOException
final void applyAllDeletesAndUpdates() throws java.io.IOException
java.io.IOException
DocumentsWriter getDocsWriter()
public final int numRamDocs()
private void ensureValidMerge(MergePolicy.OneMerge merge)
private void skipDeletedDoc(DocValuesFieldUpdates.Iterator[] updatesIters, int deletedDoc)
private ReadersAndUpdates commitMergedDeletesAndUpdates(MergePolicy.OneMerge merge, MergeState mergeState) throws java.io.IOException
java.io.IOException
private static void carryOverHardDeletes(ReadersAndUpdates mergedReadersAndUpdates, int maxDoc, Bits mergeLiveDocs, Bits prevHardLiveDocs, Bits currentHardLiveDocs, MergeState.DocMap segDocMap, MergeState.DocMap segLeafDocMap) throws java.io.IOException
java.io.IOException
private boolean commitMerge(MergePolicy.OneMerge merge, MergeState mergeState) throws java.io.IOException
java.io.IOException
private final void handleMergeException(java.lang.Throwable t, MergePolicy.OneMerge merge) throws java.io.IOException
java.io.IOException
public void merge(MergePolicy.OneMerge merge) throws java.io.IOException
java.io.IOException
void mergeSuccess(MergePolicy.OneMerge merge)
final boolean registerMerge(MergePolicy.OneMerge merge) throws java.io.IOException
java.io.IOException
final void mergeInit(MergePolicy.OneMerge merge) throws java.io.IOException
java.io.IOException
private void _mergeInit(MergePolicy.OneMerge merge) throws java.io.IOException
java.io.IOException
static void setDiagnostics(SegmentInfo info, java.lang.String source)
private static void setDiagnostics(SegmentInfo info, java.lang.String source, java.util.Map<java.lang.String,java.lang.String> details)
final void mergeFinish(MergePolicy.OneMerge merge)
private void closeMergeReaders(MergePolicy.OneMerge merge, boolean suppressExceptions) throws java.io.IOException
java.io.IOException
private void countSoftDeletes(CodecReader reader, Bits wrappedLiveDocs, Bits hardLiveDocs, Counter softDeleteCounter, Counter hardDeleteCounter) throws java.io.IOException
java.io.IOException
private boolean assertSoftDeletesCount(CodecReader reader, int expectedCount) throws java.io.IOException
java.io.IOException
private int mergeMiddle(MergePolicy.OneMerge merge, MergePolicy mergePolicy) throws java.io.IOException
java.io.IOException
void addMergeException(MergePolicy.OneMerge merge)
final int getBufferedDeleteTermsSize()
final int getNumBufferedDeleteTerms()
SegmentCommitInfo newestSegment()
java.lang.String segString()
java.lang.String segString(java.lang.Iterable<SegmentCommitInfo> infos)
private java.lang.String segString(SegmentCommitInfo info)
private void doWait()
private boolean filesExist(SegmentInfos toSync) throws java.io.IOException
java.io.IOException
SegmentInfos toLiveInfos(SegmentInfos sis)
private void startCommit(SegmentInfos toSync) throws java.io.IOException
java.io.IOException
final void onTragicEvent(java.lang.Throwable tragedy, java.lang.String location)
private void tragicEvent(java.lang.Throwable tragedy, java.lang.String location) throws java.io.IOException
java.io.IOException
private void maybeCloseOnTragicEvent() throws java.io.IOException
java.io.IOException
public java.lang.Throwable getTragicException()
IndexWriter
was closed as a side-effect of a tragic exception,
e.g. disk full while flushing a new segment, this returns the root cause exception.
Otherwise (no tragic exception has occurred) it returns null.public boolean isOpen()
true
if this IndexWriter
is still open.private final void testPoint(java.lang.String message)
boolean nrtIsCurrent(SegmentInfos infos)
boolean isClosed()
public void deleteUnusedFiles() throws java.io.IOException
IndexWriter normally deletes unused files itself, during indexing. However, on Windows, which disallows deletion of open files, if there is a reader open on the index then those files cannot be deleted. This is fine, because IndexWriter will periodically retry the deletion.
However, IndexWriter doesn't try that often: only on open, close, flushing a new segment, and finishing a merge. If you don't do any of these actions with your IndexWriter, you'll see the unused files linger. If that's a problem, call this method to delete them (once you've closed the open readers that were preventing their deletion).
In addition, you can call this method to delete
unreferenced index commits. This might be useful if you
are using an IndexDeletionPolicy
which holds
onto index commits until some criteria are met, but those
commits are no longer needed. Otherwise, those commits will
be deleted the next time commit() is called.
java.io.IOException
static final void createCompoundFile(InfoStream infoStream, TrackingDirectoryWrapper directory, SegmentInfo info, IOContext context, IOUtils.IOConsumer<java.util.Collection<java.lang.String>> deleteFiles) throws java.io.IOException
java.io.IOException
private void deleteNewFiles(java.util.Collection<java.lang.String> files) throws java.io.IOException
files
- the files to deletejava.io.IOException
- if an IOException
occursIndexFileDeleter.deleteNewFiles(Collection)
private final void flushFailed(SegmentInfo info) throws java.io.IOException
java.io.IOException
void publishFlushedSegments(boolean forced) throws java.io.IOException
IW -> BDS
so that the SegmentInfo
's
delete generation is always GlobalPacket_deleteGeneration + 1forced
- if true
this call will block on the ticket queue if the lock is held by another thread.
if false
the call will try to acquire the queue lock and exits if it's held by another thread.java.io.IOException
public void incRefDeleter(SegmentInfos segmentInfos) throws java.io.IOException
SegmentInfos
are still in use.java.io.IOException
public void decRefDeleter(SegmentInfos segmentInfos) throws java.io.IOException
SegmentInfos
are no longer in use. Only call this if you are sure you previously
called incRefDeleter(org.apache.lucene.index.SegmentInfos)
.java.io.IOException
private void processEvents(boolean triggerMerge) throws java.io.IOException
java.io.IOException
private void reserveDocs(long addedNumDocs)
IllegalArgumentException
if it's not allowed.private void testReserveDocs(long addedNumDocs)
java.lang.IllegalArgumentException
- if there would be too many docsprivate void tooManyDocs(long addedNumDocs)
public long getMaxCompletedSequenceNumber()
private long adjustPendingNumDocs(long numDocs)
final boolean isFullyDeleted(ReadersAndUpdates readersAndUpdates) throws java.io.IOException
java.io.IOException
public final int numDeletesToMerge(SegmentCommitInfo info) throws java.io.IOException
numDeletesToMerge
in interface MergePolicy.MergeContext
info
- the segment to get the number of deletes forjava.io.IOException
MergePolicy.numDeletesToMerge(SegmentCommitInfo, int, org.apache.lucene.util.IOSupplier)
void release(ReadersAndUpdates readersAndUpdates) throws java.io.IOException
java.io.IOException
private void release(ReadersAndUpdates readersAndUpdates, boolean assertLiveInfo) throws java.io.IOException
java.io.IOException
ReadersAndUpdates getPooledInstance(SegmentCommitInfo info, boolean create)
void finished(FrozenBufferedUpdates packet)
int getPendingUpdatesCount()
protected boolean isEnableTestPoints()
false
.private void validate(SegmentCommitInfo info)
final boolean segmentCommitInfoExist(SegmentCommitInfo sci)
final java.util.List<SegmentCommitInfo> listOfSegmentCommitInfos()
final SegmentInfos cloneSegmentInfos()
public IndexWriter.DocStats getDocStats()
IndexWriter.DocStats
form this writer. The numDoc for instance can change after maxDoc is fetched
that causes numDocs to be greater than maxDoc which makes it hard to get accurate document stats from IndexWriter.