HBASE-15497 Incorrect javadoc for atomicity guarantee of Increment and Append
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/47697365 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/47697365 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/47697365 Branch: refs/heads/master Commit: 476973654c297198e33405ff7bc588ffe213aae9 Parents: 0a3a9a5 Author: cuijianwei <cuijian...@xiaomi.com> Authored: Sun Apr 10 14:31:31 2016 +0800 Committer: Chia-Ping Tsai <chia7...@gmail.com> Committed: Mon Sep 4 16:20:45 2017 +0800 ---------------------------------------------------------------------- .../java/org/apache/hadoop/hbase/client/Append.java | 7 +++---- .../org/apache/hadoop/hbase/client/Increment.java | 7 +++---- .../java/org/apache/hadoop/hbase/client/Table.java | 14 ++++++-------- 3 files changed, 12 insertions(+), 16 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/47697365/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Append.java ---------------------------------------------------------------------- diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Append.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Append.java index 6947313..56b5c42 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Append.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Append.java @@ -34,10 +34,9 @@ import org.apache.hadoop.hbase.util.Bytes; /** * Performs Append operations on a single row. * <p> - * Note that this operation does not appear atomic to readers. Appends are done - * under a single row lock, so write operations to a row are synchronized, but - * readers do not take row locks so get and scan operations can see this - * operation partially completed. + * This operation ensures atomicty to readers. Appends are done + * under a single row lock, so write operations to a row are synchronized, and + * readers are guaranteed to see this operation fully completed. * <p> * To append to a set of columns of a row, instantiate an Append object with the * row to append to. At least one column to append must be specified using the http://git-wip-us.apache.org/repos/asf/hbase/blob/47697365/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Increment.java ---------------------------------------------------------------------- diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Increment.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Increment.java index c144c87..a5765c3 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Increment.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Increment.java @@ -38,10 +38,9 @@ import org.apache.hadoop.hbase.util.ClassSize; /** * Used to perform Increment operations on a single row. * <p> - * This operation does not appear atomic to readers. Increments are done - * under a single row lock, so write operations to a row are synchronized, but - * readers do not take row locks so get and scan operations can see this - * operation partially completed. + * This operation ensures atomicity to readers. Increments are done + * under a single row lock, so write operations to a row are synchronized, and + * readers are guaranteed to see this operation fully completed. * <p> * To increment columns of a row, instantiate an Increment object with the row * to increment. At least one column to increment must be specified using the http://git-wip-us.apache.org/repos/asf/hbase/blob/47697365/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java ---------------------------------------------------------------------- diff --git a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java index a215903..0aaf6dd 100644 --- a/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java +++ b/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java @@ -326,10 +326,9 @@ public interface Table extends Closeable { /** * Appends values to one or more columns within a single row. * <p> - * This operation does not appear atomic to readers. Appends are done - * under a single row lock, so write operations to a row are synchronized, but - * readers do not take row locks so get and scan operations can see this - * operation partially completed. + * This operation guaranteed atomicity to readers. Appends are done + * under a single row lock, so write operations to a row are synchronized, and + * readers are guaranteed to see this operation fully completed. * * @param append object that specifies the columns and amounts to be used * for the increment operations @@ -341,10 +340,9 @@ public interface Table extends Closeable { /** * Increments one or more columns within a single row. * <p> - * This operation does not appear atomic to readers. Increments are done - * under a single row lock, so write operations to a row are synchronized, but - * readers do not take row locks so get and scan operations can see this - * operation partially completed. + * This operation ensures atomicity to readers. Increments are done + * under a single row lock, so write operations to a row are synchronized, and + * readers are guaranteed to see this operation fully completed. * * @param increment object that specifies the columns and amounts to be used * for the increment operations
