Added javadoc on how Scan caching value interacts with HTable setting

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1028527 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2010-10-28 22:52:44 +00:00
parent 3523b66eec
commit ddbc879f93
1 changed files with 5 additions and 0 deletions

View File

@ -49,6 +49,8 @@ import java.util.TreeSet;
* To scan everything for each row, instantiate a Scan object.
* <p>
* To modify scanner caching for just this scan, use {@link #setCaching(int) setCaching}.
* If caching is NOT set, we will use the caching value of the hosting
* {@link HTable}. See {@link HTable#setScannerCaching(int)}.
* <p>
* To further define the scope of what to get when scanning, perform additional
* methods as outlined below.
@ -82,6 +84,9 @@ public class Scan implements Writable {
private byte [] stopRow = HConstants.EMPTY_END_ROW;
private int maxVersions = 1;
private int batch = -1;
/*
* -1 means no caching
*/
private int caching = -1;
private boolean cacheBlocks = true;
private Filter filter = null;