You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by nd...@apache.org on 2014/01/17 23:19:02 UTC
svn commit: r1559269 -
/hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html
Author: ndimiduk
Date: Fri Jan 17 22:19:02 2014
New Revision: 1559269
URL: http://svn.apache.org/r1559269
Log:
HBASE-10346 Add Documentation for stateless scanner ADDENDUM (Vandana Ayyalasomayajula)
Modified:
hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html
Modified: hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html
URL: http://svn.apache.org/viewvc/hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html?rev=1559269&r1=1559268&r2=1559269&view=diff
==============================================================================
--- hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html (original)
+++ hbase/trunk/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html Fri Jan 17 22:19:02 2014
@@ -1192,8 +1192,9 @@ Content-Length: 0<br>
GET /<table>/<optional_row_prefix>*?<scan_parameters>
</pre>
<p align="justify">
- The current scanner API expects clients to restart scans if there is a REST server failure in the midst. The stateless
- does not store any state related to scan operation and all the parameters are specified as query parameters.
+ The current scanner API expects clients to restart scans if there is a REST server failure in the
+ midst. The stateless does not store any state related to scan operation and all the parameters
+ are specified as query parameters.
<p>
<p>
The following are the scan parameters
@@ -1201,7 +1202,8 @@ Content-Length: 0<br>
<li>startrow - The start row for the scan.</li>
<li>endrow - The end row for the scan.</li>
<li>columns - The columns to scan.</li>
- <li>starttime, endtime - To only retrieve columns within a specific range of version timestamps,both start and end time must be specified.</li>
+ <li>starttime, endtime - To only retrieve columns within a specific range of version timestamps,
+ both start and end time must be specified.</li>
<li>maxversions - To limit the number of versions of each column to be returned.</li>
<li>batchsize - To limit the maximum number of values returned for each call to next().</li>
<li>limit - The number of rows to return in the scan operation.</li>
@@ -1211,13 +1213,17 @@ Content-Length: 0<br>
More on start row, end row and limit parameters.
<ol>
<li>If start row, end row and limit not specified, then the whole table will be scanned.</li>
- <li>If start row and limit (say N) is specified, then the scan operation will return N rows from the start row specified.</li>
- <li>If only limit parameter is specified, then the scan operation will return N rows from the start of the table.</li>
- <li>If limit and end row are specified, then the scan operation will return N rows from start of table till the end row. If the end
- row is reached before N rows ( say M and M < N ), then M rows will be returned to the user.</li>
- <li>If start row, end row and limit (say N ) are specified and N < number of rows between start row and end row, then N rows from
- start row will be returned to the user. If N > (number of rows between start row and end row (say M), then M number of rows
- will be returned to the user.</li>
+ <li>If start row and limit (say N) is specified, then the scan operation will return N rows from
+ the start row specified.</li>
+ <li>If only limit parameter is specified, then the scan operation will return N rows from the
+ start of the table.</li>
+ <li>If limit and end row are specified, then the scan operation will return N rows from start
+ of table till the end row. If the end row is reached before N rows ( say M and M < N ),
+ then M rows will be returned to the user.</li>
+ <li>If start row, end row and limit (say N ) are specified and N < number of rows between
+ start row and end row, then N rows from start row will be returned to the user. If N >
+ (number of rows between start row and end row (say M), then M number of rows will be returned
+ to the user.</li>
</ol>
<p>
<p><b>Examples</b><p>
@@ -1244,12 +1250,12 @@ curl -H "Accept: application/json" https
</pre>
<p>
<tt>
-{"Row":[{"key":"dGVzdHJvdzE=","Cell":[{"column":"YTox","timestamp":1389900769772,"$":"dGVzdHZhbHVlLWEx"},<br>
-{"column":"Yjox","timestamp":1389900780536,"$":"dGVzdHZhbHVlLWIx"}]},{"key":"dGVzdHJvdzI=","Cell":[{"column":<br>
-"YTox","timestamp":1389900823877,"$":"dGVzdHZhbHVlLWEy"}{"column":"Yjox",<br>
-"timestamp":1389900818233,"$":"dGVzdHZhbHVlLWIy"}]},{"key":"dGVzdHJvdzM=","Cell":[{"column":"YTox",<br>
-"timestamp":1389900847336,"$":"dGVzdHZhbHVlLWEz"},{"column":"Yjox","timestamp":1389900856845,"$":"dGVzdHZhbHVlLWIz"}]}]}<br>
-<br>
+{"Row":[{"key":"dGVzdHJvdzE=","Cell":[{"column":"YTox","timestamp":1389900769772,<br>
+"$":"dGVzdHZhbHVlLWEx"},{"column":"Yjox","timestamp":1389900780536,"$":"dGVzdHZhbHVlLWIx"}]},<br>
+{"key":"dGVzdHJvdzI=","Cell":[{"column":"YTox","timestamp":1389900823877,"$":"dGVzdHZhbHVlLWEy"}<br>
+{"column":"Yjox","timestamp":1389900818233,"$":"dGVzdHZhbHVlLWIy"}]},{"key":"dGVzdHJvdzM=",<br>
+"Cell":[{"column":"YTox","timestamp":1389900847336,"$":"dGVzdHZhbHVlLWEz"},{"column":"Yjox",<br>
+"timestamp":1389900856845,"$":"dGVzdHZhbHVlLWIz"}]}]}<br>
</tt>
<p>
</li>
@@ -1261,13 +1267,14 @@ curl -H "Content-Type: text/xml" https:/
</pre>
<p>
<tt>
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><br>
-<Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"<br>
-timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><<br>
-Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"<br>
-timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell></Row><Row key="dGVzdHJvdzM="><<br>
-Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"<br>
-timestamp="1389900856845">dGVzdHZhbHVlLWIz</Cell></Row></CellSet><br>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><<br>
+Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<<br>
+/Cell><Cell column="Yjox"timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell><<br>
+/Row><Row key="dGVzdHJvdzI="><Cell column="YTox" timestamp="1389900823877"><br>
+dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"timestamp="1389900818233">dGVzdHZhbHVlLWIy<<br>
+/Cell></Row><Row key="dGVzdHJvdzM="><Cell column="YTox" timestamp="1389900847336<br>
+">dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"timestamp="1389900856845"><br>
+dGVzdHZhbHVlLWIz</Cell></Row></CellSet><br>
</tt>
<p>
</li>
@@ -1294,9 +1301,10 @@ curl -H "Content-Type: text/xml" https:/
</pre>
<p>
<tt>
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><br>
-<Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"<br>
-timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row></CellSet><br>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><<br>
+Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772"><br>
+dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"timestamp="1389900780536"><br>
+dGVzdHZhbHVlLWIx</Cell></Row></CellSet><br>
</tt>
<p>
</li>
@@ -1308,10 +1316,12 @@ curl -H "Content-Type: text/xml" https:/
</pre>
<p>
<tt>
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><br>
-<Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell></Row><Row key="dGVzdHJvdzI="><<br>
-Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell></Row><Row key="dGVzdHJvdzM="><<br>
-Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell></Row></CellSet><br>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><<br>
+Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<<br>
+/Cell></Row><Row key="dGVzdHJvdzI="><Cell column="YTox" timestamp=<br>
+"1389900823877">dGVzdHZhbHVlLWEy</Cell></Row><Row key="dGVzdHJvdzM="><<br>
+Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><<br>
+/Row></CellSet><br>
</tt>
<p>
</li>
@@ -1323,13 +1333,15 @@ curl -H "Content-Type: text/xml" https:/
</pre>
<p>
<tt>
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><<br>
-Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"<br>
-timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><<br>
-Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"<br>
-timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell></Row><Row key="dGVzdHJvdzM="><<br>
-Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"<br>
-timestamp="1389900856845">dGVzdHZhbHVlLWIz</Cell></Row></CellSet><br>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><<br>
+Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772"><br>
+dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"timestamp="1389900780536"><br>
+dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><<br>
+Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><<br>
+Cell column="Yjox"timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell><<br>
+/Row><Row key="dGVzdHJvdzM="><Cell column="YTox" timestamp="1389900847336"><br>
+dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"timestamp="1389900856845"><br>
+dGVzdHZhbHVlLWIz</Cell></Row></CellSet><br>
</tt>
<p>
</li>
@@ -1341,10 +1353,11 @@ curl -H "Content-Type: text/xml" https:/
</pre>
<p>
<tt>
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><<br>
-Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"<br>
-timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><<br>
-Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"<br>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><<br>
+Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<<br>
+/Cell><Cell column="Yjox"timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell><<br>
+/Row><Row key="dGVzdHJvdzI="><Cell column="YTox" timestamp="1389900823877"><br>
+dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"<br>
timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell></Row></CellSet><br>
</tt>
<p>
@@ -1357,9 +1370,10 @@ curl -H "Content-Type: text/xml" https:/
</pre>
<p>
<tt>
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><<br>
-Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"<br>
-timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row></CellSet><br>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><<br>
+Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<<br>
+/Cell><Cell column="Yjox"timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell><<br>
+/Row></CellSet><br>
</tt>
<p>
</li>
@@ -1371,13 +1385,15 @@ curl -H "Content-Type: text/xml" https:/
</pre>
<p>
<tt>
-<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><br>
-<Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"<br>
-timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><<br>
-Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"<br>
-timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell></Row><Row key="dGVzdHJvdzM="><<br>
-Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"<br>
-timestamp="1389900856845">dGVzdHZhbHVlLWIz</Cell></Row></CellSet><br>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><<br>
+Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<<br>
+/Cell><Cell column="Yjox"timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell><<br>
+/Row><Row key="dGVzdHJvdzI="><Cell column="YTox" timestamp="1389900823877"><br>
+dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"timestamp="1389900818233"><br>
+dGVzdHZhbHVlLWIy</Cell></Row><Row key="dGVzdHJvdzM="><<br>
+Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><<br>
+Cell column="Yjox"timestamp="1389900856845">dGVzdHZhbHVlLWIz</Cell><<br>
+/Row></CellSet><br>
</tt>
<p>
</li>