HBASE-16376 Scan#setBatch(int) javadoc update WRT partial results Signed-off-by: Enis Soztutar <e...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/c64c0e85 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/c64c0e85 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/c64c0e85 Branch: refs/heads/branch-1 Commit: c64c0e85c0fe1b8f0c210ff41dbaf4e6b56afa8d Parents: de2f653 Author: Josh Elser <els...@apache.org> Authored: Sun Aug 21 22:40:42 2016 -0400 Committer: Enis Soztutar <e...@apache.org> Committed: Wed Aug 24 05:13:00 2016 -0700 ---------------------------------------------------------------------- .../src/main/java/org/apache/hadoop/hbase/client/Scan.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/c64c0e85/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java ---------------------------------------------------------------------- diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java index b13837d..1d9b130 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java @@ -466,7 +466,13 @@ public class Scan extends Query { } /** - * Set the maximum number of values to return for each call to next() + * Set the maximum number of values to return for each call to next(). + * Callers should be aware that invoking this method with any value + * is equivalent to calling {@link #setAllowPartialResults(boolean)} + * with a value of {@code true}; partial results may be returned if + * this method is called. Use {@link #setMaxResultSize(long)}} to + * limit the size of a Scan's Results instead. + * * @param batch the maximum number of values */ public Scan setBatch(int batch) {