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

HBASE-1689 Fix javadoc warnings and add overview on client classes to client package 

git-svn-id: https://svn.apache.org/repos/asf/hadoop/hbase/trunk@796938 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2009-07-23 03:53:13 +00:00
parent e03f2c2ffc
commit 91abbb4793
2 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES.txt
View File

@ -278,6 +278,8 @@ Release 0.20.0 - Unreleased
lists (Clint Morgan via Stack)
HBASE-1359 After a large truncating table HBase becomes unresponsive
HBASE-1215 0.19.0 -> 0.20.0 migration (hfile, HCD changes, HSK changes)
HBASE-1689 Fix javadoc warnings and add overview on client classes to
client package
IMPROVEMENTS
HBASE-1089 Add count of regions on filesystem to master UI; add percentage

24
src/java/org/apache/hadoop/hbase/client/package-info.java
View File

@ -27,7 +27,29 @@ Provides HBase Client
</ul>
<h2><a name="overview">Overview</a></h2>
<p>
<p>To administer HBase, create and drop tables, list and alter tables,
use {@link org.apache.hadoop.hbase.client.HBaseAdmin}. Once created, table access is via an instance
of {@link org.apache.hadoop.hbase.client.HTable}. You add content to a table a row at a time. To insert,
create an instance of a {@link org.apache.hadoop.hbase.client.Put} object and after setting it appropriately,
commit your update using {@link org.apache.hadoop.hbase.client.HTable#put(Put)}.
To fetch your inserted
value, use {@link org.apache.hadoop.hbase.client.Get}. The Get can be specified to be broad -- get all
on a particular row -- or narrow; return only a single cell value.
When finished with your Get settings, invoke {@link org.apache.hadoop.hbase.client.HTable#get(Get)}. Use
{@link org.apache.hadoop.hbase.client.Scan} to set up a scanner -- a Cursor-like access. After
configuring your Scan instance, call {@link org.apache.hadoop.hbase.client.HTable#getScanner(Scan)} and then
invoke next on the returned object. Both {@link org.apache.hadoop.hbase.client.HTable#get(Get)} and
{@link org.apache.hadoop.hbase.client.HTable#getScanner(Scan)} return a
{@link org.apache.hadoop.hbase.client.Result}.
A Result is a List of {@link org.apache.hadoop.hbase.KeyValue}s. It has facility for packaging the return
in different formats.
Use {@link org.apache.hadoop.hbase.client.Delete} to remove content.
You can remove individual cells or entire families, etc. Pass it to
{@link org.apache.hadoop.hbase.client.HTable#delete(Delete)} to execute.
</p>
<p>Client code accessing a cluster finds the cluster by querying ZooKeeper.
This means that the ZooKeeper quorum to use must be on the client CLASSPATH.
Usually this means make sure the client can find your <code>hbase-site.xml</code>.
</p>
<h2><a name="client_example">Example API Usage</a></h2>