Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HBASE-4205 Enhance HTable javadoc 

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1158353 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2011-08-16 16:26:13 +00:00
parent 74f1d81fe2
commit 9686b3d4ba
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES.txt
View File

@ -440,6 +440,9 @@ Release 0.90.5 - Unreleased
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

15
src/main/java/org/apache/hadoop/hbase/client/HTable.java
View File

@ -65,10 +65,18 @@ import org.apache.hadoop.hbase.util.Pair;
import org.apache.hadoop.hbase.util.Writables;
/**
* 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
@ -90,7 +98,8 @@ import org.apache.hadoop.hbase.util.Writables;
*
* <p>Note that this class implements the {@link Closeable} interface. When a
* HTable instance is no longer required, it *should* be closed in order to ensure
* that the underlying resources are promptly released.
* that the underlying resources are promptly released. Please note that the close
* method can throw java.io.IOException that must be handled.
*
* @see HBaseAdmin for create, drop, list, enable and disable of tables.
* @see HConnection