Document document size limit for CompressingStoredFieldsFormat.

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1404156 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Adrien Grand 2012-10-31 14:16:07 +00:00
parent d404fc7ad3
commit b607097f35
1 changed files with 6 additions and 1 deletions

View File

@ -32,7 +32,12 @@ import org.apache.lucene.store.IOContext;
/**
* A {@link StoredFieldsFormat} that is very similar to
* {@link Lucene40StoredFieldsFormat} but compresses documents in chunks in
* order to improve compression ratio.
* order to improve the compression ratio.
* <p>
* For a chunk size of <tt>chunkSize</tt> bytes, this {@link StoredFieldsFormat}
* does not support documents larger than (<tt>2<sup>31</sup> - chunkSize</tt>)
* bytes. In case this is a problem, you should use another format, such as
* {@link Lucene40StoredFieldsFormat}.
* <p>
* For optimal performance, you should use a {@link MergePolicy} that returns
* segments that have the biggest byte size first.