HBASE-1029 REST wiki documentation incorrect
git-svn-id: https://svn.apache.org/repos/asf/hadoop/hbase/trunk@723384 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack
parent
58208a275a
commit
7314c974a7
|
|
@ -90,13 +90,13 @@ Release 0.19.0 - Unreleased
|
|||
HBASE-1041 Migration throwing NPE
|
||||
HBASE-1042 OOME but we don't abort; two part commit.
|
||||
HBASE-927 We don't recover if HRS hosting -ROOT-/.META. goes down
|
||||
HBASE-1029 REST wiki documentation incorrect
|
||||
HBASE-1043 Removing @Override attributes where they are no longer needed.
|
||||
(Ryan Smith via Jim Kellerman)
|
||||
HBASE-927 We don't recover if HRS hosting -ROOT-/.META. goes down -
|
||||
(fix bug in createTable which caused tests to fail)
|
||||
HBASE-1039 Compaction fails if bloomfilters are enabled
|
||||
|
||||
|
||||
IMPROVEMENTS
|
||||
HBASE-901 Add a limit to key length, check key and value length on client side
|
||||
HBASE-890 Alter table operation and also related changes in REST interface
|
||||
|
|
|
|||
|
|
@ -487,7 +487,7 @@ public class HTable {
|
|||
* at a specified timestamp
|
||||
*
|
||||
* @param row row key
|
||||
* @param ts timestamp
|
||||
* @param timestamp timestamp
|
||||
* @param numVersions number of versions to return
|
||||
* @return RowResult is empty if row does not exist.
|
||||
* @throws IOException
|
||||
|
|
|
|||
|
|
@ -0,0 +1,112 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
||||
<html>
|
||||
|
||||
<!--
|
||||
Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
contributor license agreements. See the NOTICE file distributed with
|
||||
this work for additional information regarding copyright ownership.
|
||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
(the "License"); you may not use this file except in compliance with
|
||||
the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
|
||||
<head/>
|
||||
|
||||
<body bgcolor="white">
|
||||
Provides an HBase
|
||||
<a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">
|
||||
REST</a> service.
|
||||
|
||||
This directory contains a REST service implementation for an Hbase RPC
|
||||
service.
|
||||
|
||||
<h2><a name="description">Description</a></h2>
|
||||
<p>
|
||||
By default, an instance of the REST servlet runs in the master UI; just browse
|
||||
to [WWW] http://MASTER_HOST:MASTER_PORT/api/ (Results are returned as xml by
|
||||
default so you may have to look at source to see results).
|
||||
|
||||
If you intend to use the hbase REST API heavily, to run an instance of the RES
|
||||
T server outside of the master, do the following:
|
||||
<pre>
|
||||
cd $HBASE_HOME
|
||||
bin/hbase rest start
|
||||
</pre>
|
||||
The default port is 60050.
|
||||
</p>
|
||||
|
||||
<h2><a name="uri">URI</a></h2>
|
||||
<h3><a name="uri#meta">System Operation</a></h3>
|
||||
<ul>
|
||||
<li>GET / : Retrieve a list of all the tables in HBase.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="uri#table">Table Operation</a></h3>
|
||||
<ul>
|
||||
<li>POST / : Create a table</li>
|
||||
|
||||
<li>GET /[table_name] : Retrieve metadata about the table</li>
|
||||
|
||||
<li>PUT /[table_name] : Update the table schema</li>
|
||||
|
||||
<li>DELETE /[table_name] : Delete the table</li>
|
||||
|
||||
<li>POST /[table_name]/disable : Disable the table</li>
|
||||
|
||||
<li>POST /[table_name]/enable : Enable the table</li>
|
||||
|
||||
<li>GET /[table_name]/regions : Retrieve a list of the regions for this table
|
||||
so that you can efficiently split up the work</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="uri#row">Row Operation</a></h3>
|
||||
<ul>
|
||||
<li>GET /[table_name]/row/[row_key]/timestamps : Retrieve a list of all the
|
||||
timestamps available for this row key (Not supported by native hbase yet)</li>
|
||||
|
||||
<li>GET /[table_name]/row/[row_key] : Retrieve data from a
|
||||
row. If column not specified, return all columns</li>
|
||||
|
||||
<li>GET /[table_name]/row/[row_key]/[timestamp] : Retrieve
|
||||
data from a row, constrained by the timestamp value. If column not specified,
|
||||
return all columns</li>
|
||||
|
||||
<li>POST/PUT /[table_name]/row/[row_key] : Set the value of one or more
|
||||
columns for a given row key</li>
|
||||
|
||||
<li>POST/PUT /[table_name]/row/[row_key]/[timestamp] : Set the value of one
|
||||
or more columns for a given row key with an optional timestamp</li>
|
||||
|
||||
<li>DELETE /[table_name]/row/[row_key]/ : Delete the specified columns from
|
||||
the row. If there are no columns specified, then it will delete ALL columns</li>
|
||||
|
||||
<li>DELETE /[table_name]/row/[row_key]/[timestamp] : Delete the specified
|
||||
columns from the row constrained by the timestamp. If there are no columns
|
||||
specified, then it will delete ALL columns. Not supported yet.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a name="uri#scanner">Scanner Operation</a></h3>
|
||||
<ul>
|
||||
<li>POST/PUT /[table_name]/scanner : Request that a scanner be created with
|
||||
the specified options. Returns a scanner ID that can be used to iterate over
|
||||
the results of the scanner</li>
|
||||
|
||||
<li>POST /[table_name]/scanner/[scanner_id] : Return the current item in the
|
||||
scanner and advance to the next one. Think of it as a queue dequeue operation</li>
|
||||
|
||||
<li>DELETE /[table_name]/scanner/[scanner_id] : Close a scanner</li>
|
||||
</ul>
|
||||
<p>
|
||||
For examples and more details, please visit
|
||||
<a href="http://wiki.apache.org/hadoop/Hbase/HbaseRest">HBaseRest Wiki</a> page.
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Reference in New Issue