From 697c0fec38b9cedd8c895c57e3f618468b7cf194 Mon Sep 17 00:00:00 2001 From: ndimiduk Date: Fri, 17 Jan 2014 22:19:02 +0000 Subject: [PATCH] HBASE-10346 Add Documentation for stateless scanner ADDENDUM (Vandana Ayyalasomayajula) git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1559269 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/hadoop/hbase/rest/package.html | 118 ++++++++++-------- 1 file changed, 67 insertions(+), 51 deletions(-) diff --git a/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html b/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html index 947616bf6ea..c21e129770c 100644 --- a/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html +++ b/hbase-server/src/main/java/org/apache/hadoop/hbase/rest/package.html @@ -1192,8 +1192,9 @@ Content-Length: 0
GET /<table>/<optional_row_prefix>*?<scan_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. + 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 following are the scan parameters @@ -1201,7 +1202,8 @@ Content-Length: 0

  • startrow - The start row for the scan.
  • endrow - The end row for the scan.
  • columns - The columns to scan.
    • -
  • starttime, endtime - To only retrieve columns within a specific range of version timestamps,both start and end time must be specified.
    • +
  • starttime, endtime - To only retrieve columns within a specific range of version timestamps, + both start and end time must be specified.
  • maxversions - To limit the number of versions of each column to be returned.
  • batchsize - To limit the maximum number of values returned for each call to next().
  • limit - The number of rows to return in the scan operation.
    • @@ -1211,13 +1213,17 @@ Content-Length: 0
    More on start row, end row and limit parameters.
    1. If start row, end row and limit not specified, then the whole table will be scanned.
      2. -
    2. If start row and limit (say N) is specified, then the scan operation will return N rows from the start row specified.
      3. -
    3. If only limit parameter is specified, then the scan operation will return N rows from the start of the table.
      4. -
    4. 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.
      5. -
    5. 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.
      6. +
    6. If start row and limit (say N) is specified, then the scan operation will return N rows from + the start row specified.
      7. +
    7. If only limit parameter is specified, then the scan operation will return N rows from the + start of the table.
      8. +
    8. 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.
      9. +
    9. 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.

    Examples

    @@ -1244,12 +1250,12 @@ curl -H "Accept: application/json" https://localhost:8080/ExampleScanner/*

    -{"Row":[{"key":"dGVzdHJvdzE=","Cell":[{"column":"YTox","timestamp":1389900769772,"$":"dGVzdHZhbHVlLWEx"},
    -{"column":"Yjox","timestamp":1389900780536,"$":"dGVzdHZhbHVlLWIx"}]},{"key":"dGVzdHJvdzI=","Cell":[{"column":
    -"YTox","timestamp":1389900823877,"$":"dGVzdHZhbHVlLWEy"}{"column":"Yjox",
    -"timestamp":1389900818233,"$":"dGVzdHZhbHVlLWIy"}]},{"key":"dGVzdHJvdzM=","Cell":[{"column":"YTox",
    -"timestamp":1389900847336,"$":"dGVzdHZhbHVlLWEz"},{"column":"Yjox","timestamp":1389900856845,"$":"dGVzdHZhbHVlLWIz"}]}]}
    -
    +{"Row":[{"key":"dGVzdHJvdzE=","Cell":[{"column":"YTox","timestamp":1389900769772,
    +"$":"dGVzdHZhbHVlLWEx"},{"column":"Yjox","timestamp":1389900780536,"$":"dGVzdHZhbHVlLWIx"}]},
    +{"key":"dGVzdHJvdzI=","Cell":[{"column":"YTox","timestamp":1389900823877,"$":"dGVzdHZhbHVlLWEy"}
    +{"column":"Yjox","timestamp":1389900818233,"$":"dGVzdHZhbHVlLWIy"}]},{"key":"dGVzdHJvdzM=",
    +"Cell":[{"column":"YTox","timestamp":1389900847336,"$":"dGVzdHZhbHVlLWEz"},{"column":"Yjox",
    +"timestamp":1389900856845,"$":"dGVzdHZhbHVlLWIz"}]}]}

    @@ -1261,13 +1267,14 @@ curl -H "Content-Type: text/xml" https://localhost:8080/ExampleScanner/*

    -<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE=">
    -<Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"
    -timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><
    -Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"
    -timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell></Row><Row key="dGVzdHJvdzM="><
    -Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"
    -timestamp="1389900856845">dGVzdHZhbHVlLWIz</Cell></Row></CellSet>
    +<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><
    +Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<
    +/Cell><Cell column="Yjox"timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell><
    +/Row><Row key="dGVzdHJvdzI="><Cell column="YTox" timestamp="1389900823877">
    +dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"timestamp="1389900818233">dGVzdHZhbHVlLWIy<
    +/Cell></Row><Row key="dGVzdHJvdzM="><Cell column="YTox" timestamp="1389900847336
    +">dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"timestamp="1389900856845">
    +dGVzdHZhbHVlLWIz</Cell></Row></CellSet>

    @@ -1294,9 +1301,10 @@ curl -H "Content-Type: text/xml" https://localhost:8080/ExampleScanner/*?limit=1

    -<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE=">
    -<Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"
    -timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row></CellSet>
    +<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><
    +Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">
    +dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"timestamp="1389900780536">
    +dGVzdHZhbHVlLWIx</Cell></Row></CellSet>

    @@ -1308,10 +1316,12 @@ curl -H "Content-Type: text/xml" https://localhost:8080/ExampleScanner/*?columns

    -<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE=">
    -<Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell></Row><Row key="dGVzdHJvdzI="><
    -Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell></Row><Row key="dGVzdHJvdzM="><
    -Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell></Row></CellSet>
    +<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><
    +Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<
    +/Cell></Row><Row key="dGVzdHJvdzI="><Cell column="YTox" timestamp=
    +"1389900823877">dGVzdHZhbHVlLWEy</Cell></Row><Row key="dGVzdHJvdzM="><
    +Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><
    +/Row></CellSet>

    @@ -1323,13 +1333,15 @@ curl -H "Content-Type: text/xml" https://localhost:8080/ExampleScanner/*?columns

    -<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><
    -Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"
    -timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><
    -Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"
    -timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell></Row><Row key="dGVzdHJvdzM="><
    -Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"
    -timestamp="1389900856845">dGVzdHZhbHVlLWIz</Cell></Row></CellSet>
    +<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><
    +Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">
    +dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"timestamp="1389900780536">
    +dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><
    +Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><
    +Cell column="Yjox"timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell><
    +/Row><Row key="dGVzdHJvdzM="><Cell column="YTox" timestamp="1389900847336">
    +dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"timestamp="1389900856845">
    +dGVzdHZhbHVlLWIz</Cell></Row></CellSet>

    @@ -1341,10 +1353,11 @@ curl -H "Content-Type: text/xml" https://localhost:8080/ExampleScanner/*?startro

    -<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><
    -Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"
    -timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><
    -Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"
    +<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><
    +Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<
    +/Cell><Cell column="Yjox"timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell><
    +/Row><Row key="dGVzdHJvdzI="><Cell column="YTox" timestamp="1389900823877">
    +dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"
    timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell></Row></CellSet>

    @@ -1357,9 +1370,10 @@ curl -H "Content-Type: text/xml" https://localhost:8080/ExampleScanner/*?startti

    -<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE="><
    -Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"
    -timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row></CellSet>
    +<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><
    +Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<
    +/Cell><Cell column="Yjox"timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell><
    +/Row></CellSet>

    @@ -1371,13 +1385,15 @@ curl -H "Content-Type: text/xml" https://localhost:8080/ExampleScanner/test*

    -<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="dGVzdHJvdzE=">
    -<Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx</Cell><Cell column="Yjox"
    -timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell></Row><Row key="dGVzdHJvdzI="><
    -Cell column="YTox" timestamp="1389900823877">dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"
    -timestamp="1389900818233">dGVzdHZhbHVlLWIy</Cell></Row><Row key="dGVzdHJvdzM="><
    -Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><Cell column="Yjox"
    -timestamp="1389900856845">dGVzdHZhbHVlLWIz</Cell></Row></CellSet>
    +<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><
    +Row key="dGVzdHJvdzE="><Cell column="YTox" timestamp="1389900769772">dGVzdHZhbHVlLWEx<
    +/Cell><Cell column="Yjox"timestamp="1389900780536">dGVzdHZhbHVlLWIx</Cell><
    +/Row><Row key="dGVzdHJvdzI="><Cell column="YTox" timestamp="1389900823877">
    +dGVzdHZhbHVlLWEy</Cell><Cell column="Yjox"timestamp="1389900818233">
    +dGVzdHZhbHVlLWIy</Cell></Row><Row key="dGVzdHJvdzM="><
    +Cell column="YTox" timestamp="1389900847336">dGVzdHZhbHVlLWEz</Cell><
    +Cell column="Yjox"timestamp="1389900856845">dGVzdHZhbHVlLWIz</Cell><
    +/Row></CellSet>