You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by mi...@apache.org on 2014/12/12 04:38:43 UTC
hbase git commit: HBASE-9763 Scan javadoc doesn't fully capture
semantics of start and stop row (Gabriel Reid)
Repository: hbase
Updated Branches:
refs/heads/master bb540c840 -> 7d10af125
HBASE-9763 Scan javadoc doesn't fully capture semantics of start and stop row (Gabriel Reid)
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo
Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/7d10af12
Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/7d10af12
Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/7d10af12
Branch: refs/heads/master
Commit: 7d10af1254fe6f0b861d6979da8d8e653fee2708
Parents: bb540c8
Author: Misty Stanley-Jones <ms...@cloudera.com>
Authored: Fri Dec 12 13:39:16 2014 +1000
Committer: Misty Stanley-Jones <ms...@cloudera.com>
Committed: Fri Dec 12 13:39:16 2014 +1000
----------------------------------------------------------------------
.../main/java/org/apache/hadoop/hbase/client/Scan.java | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/hbase/blob/7d10af12/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 e4323bf..d2dd770 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
@@ -338,8 +338,10 @@ public class Scan extends Query {
/**
* Set the start row of the scan.
- * @param startRow row to start scan on (inclusive)
- * Note: In order to make startRow exclusive add a trailing 0 byte
+ * <p>
+ * If the specified row does not exist, the Scanner will start from the
+ * next closest row after the specified row.
+ * @param startRow row to start scanner at or after
* @return this
*/
public Scan setStartRow(byte [] startRow) {
@@ -348,9 +350,11 @@ public class Scan extends Query {
}
/**
- * Set the stop row.
+ * Set the stop row of the scan.
* @param stopRow row to end at (exclusive)
- * <p><b>Note:</b> In order to make stopRow inclusive add a trailing 0 byte</p>
+ * <p>
+ * The scan will include rows that are lexicographically less than
+ * the provided stopRow.
* <p><b>Note:</b> When doing a filter for a rowKey <u>Prefix</u>
* use {@link #setRowPrefixFilter(byte[])}.
* The 'trailing 0' will not yield the desired result.</p>