Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improve NRT javadocs 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@824498 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2009-10-12 21:06:21 +00:00
parent ef1af60efe
commit b9e6831f3c
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/java/org/apache/lucene/index/IndexWriter.java
View File

@ -312,13 +312,20 @@ public class IndexWriter {
private volatile boolean poolReaders;
/**
* Returns a readonly reader containing all
* current updates. Flush is called automatically. This
* Returns a readonly reader, covering all committed as
* well as un-committed changes to the index. This
* provides "near real-time" searching, in that changes
* made during an IndexWriter session can be made
* available for searching without closing the writer.
* made during an IndexWriter session can be quickly made
* available for searching without closing the writer nor
* calling {@link #commit}.
*
* <p>It's near real-time because there is no hard
* <p>Note that this is functionally equivalent to calling
* {#commit} and then using {@link IndexReader#open} to
* open a new reader. But the turarnound time of this
* method should be faster since it avoids the potentially
* costly {@link #commit}.<p>
*
* <p>It's <i>near</i> 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