Author: stack
Date: Tue Aug 16 16:27:16 2011
New Revision: 1158355
URL: http://svn.apache.org/viewvc?rev=1158355&view=rev
Log:
HBASE-4205 Enhance HTable javadoc
Modified:
hbase/branches/0.90/CHANGES.txt
hbase/branches/0.90/src/main/java/org/apache/hadoop/hbase/client/HTable.java
Modified: hbase/branches/0.90/CHANGES.txt
URL:
http://svn.apache.org/viewvc/hbase/branches/0.90/CHANGES.txt?rev=1158355&r1=1158354&r2=1158355&view=diff
==============================================================================
--- hbase/branches/0.90/CHANGES.txt (original)
+++ hbase/branches/0.90/CHANGES.txt Tue Aug 16 16:27:16 2011
@@ -12,6 +12,9 @@ Release 0.90.5 - Unreleased
HBASE-4148 HFileOutputFormat doesn't fill in TIMERANGE_KEY metadata
(Jonathan Hsieh)
HBASE-4159 HBaseServer - IPC Reader threads are not daemons (Douglas
Campbell)
+
+ IMPROVEMENT
+ HBASE-4205 Enhance HTable javadoc (Eric Charles)
Release 0.90.4 - August 10, 2011
BUG FIXES
Modified:
hbase/branches/0.90/src/main/java/org/apache/hadoop/hbase/client/HTable.java
URL:
http://svn.apache.org/viewvc/hbase/branches/0.90/src/main/java/org/apache/hadoop/hbase/client/HTable.java?rev=1158355&r1=1158354&r2=1158355&view=diff
==============================================================================
---
hbase/branches/0.90/src/main/java/org/apache/hadoop/hbase/client/HTable.java
(original)
+++
hbase/branches/0.90/src/main/java/org/apache/hadoop/hbase/client/HTable.java
Tue Aug 16 16:27:16 2011
@@ -58,10 +58,18 @@ import org.apache.hadoop.hbase.zookeeper
import org.apache.zookeeper.KeeperException;
/**
- * Used to communicate with a single HBase table.
+ * <p>Used to communicate with a single HBase table.
*
- * This class is not thread safe for updates; the underlying write buffer can
+ * <p>This class is not thread safe for reads nor write.
+ *
+ * <p>In case of writes (Put, Delete), the underlying write buffer can
* be corrupted if multiple threads contend over a single HTable instance.
+ *
+ * <p>In case of reads, some fields used by a Scan are shared among all
threads.
+ * The HTable implementation can either not contract to be safe in case of a
Get
+ *
+ * <p>To access a table in a multi threaded environment, please consider
+ * using the {@link HTablePool} class to create your HTable instances.
*
* <p>Instances of HTable passed the same {@link Configuration} instance will
* share connections to servers out on the cluster and to the zookeeper
ensemble
