Examples HBase

The examples below illustrate the set of basic operations with HBase instance using Stargate REST API.
Use following link to get more more details about HBase/Stargate API: http://wiki.apache.org/hadoop/Hbase/Stargate.

Assumptions

This document assumes a few things about your environment in order to simplify the examples.

The JVM is executable as simply java.
The Apache Knox Gateway is installed and functional.
The example commands are executed within the context of the GATEWAY_HOME current directory. The GATEWAY_HOME directory is the directory within the Apache Knox Gateway installation that contains the README file and the bin, conf and deployments directories.
A few examples optionally require the use of commands from a standard Groovy installation. These examples are optional but to try them you will need Groovy installed.

HBase Stargate Setup

Launch Stargate

The command below launches the Stargate daemon on port 60080

sudo /usr/lib/hbase/bin/hbase-daemon.sh start rest -p 60080

Configure Sandbox port mapping for VirtualBox

Select the VM
Select menu Machine>Settings...
Select tab Network
Select Adapter 1
Press Port Forwarding button
Press Plus button to insert new rule: Name=Stargate, Host Port=60080, Guest Port=60080
Press OK to close the rule window
Press OK to Network window save the changes

Client DSL Examples

This example illustrates sequence of all basic HBase operations:

get system version
get cluster version
get cluster status
create the table
get list of tables
get table schema
update table schema
insert single row into table
query row by id
query all rows
delete cell from row
delete entire column family from row
get table regions
create scanner
fetch values using scanner
drop scanner
drop the table

There are several ways to do this depending upon your preference.

You can use the Groovy interpreter provided with the distribution.

java -jar bin/shell.jar samples/ExampleHBaseUseCase.groovy

You can manually type in the KnoxShell DSL script into the interactive Groovy interpreter provided with the distribution.

java -jar bin/shell.jar

Each line from the file below will need to be typed or copied into the interactive shell.

"samples/ExampleHBaseUseCase.groovy"

/**
 * 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.
 */
package org.apache.hadoop.gateway.shell.hbase

import org.apache.hadoop.gateway.shell.Hadoop

import static java.util.concurrent.TimeUnit.SECONDS

gateway = "https://localhost:8443/gateway/sample"
username = "bob"
password = "bob-password"
tableName = "test_table"

session = Hadoop.login(gateway, username, password)

println "System version : " + HBase.session(session).systemVersion().now().string

println "Cluster version : " + HBase.session(session).clusterVersion().now().string

println "Status : " + HBase.session(session).status().now().string

println "Creating table '" + tableName + "'..."

HBase.session(session).table(tableName).create()  \
    .attribute("tb_attr1", "value1")  \
    .attribute("tb_attr2", "value2")  \
    .family("family1")  \
        .attribute("fm_attr1", "value3")  \
        .attribute("fm_attr2", "value4")  \
    .endFamilyDef()  \
    .family("family2")  \
    .family("family3")  \
    .endFamilyDef()  \
    .attribute("tb_attr3", "value5")  \
    .now()

println "Done"

println "Table List : " + HBase.session(session).table().list().now().string

println "Schema for table '" + tableName + "' : " + HBase.session(session)  \
    .table(tableName)  \
    .schema()  \
    .now().string

println "Updating schema of table '" + tableName + "'..."

HBase.session(session).table(tableName).update()  \
    .family("family1")  \
        .attribute("fm_attr1", "new_value3")  \
    .endFamilyDef()  \
    .family("family4")  \
        .attribute("fm_attr3", "value6")  \
    .endFamilyDef()  \
    .now()

println "Done"

println "Schema for table '" + tableName + "' : " + HBase.session(session)  \
    .table(tableName)  \
    .schema()  \
    .now().string

println "Inserting data into table..."

HBase.session(session).table(tableName).row("row_id_1").store()  \
    .column("family1", "col1", "col_value1")  \
    .column("family1", "col2", "col_value2", 1234567890l)  \
    .column("family2", null, "fam_value1")  \
    .now()

HBase.session(session).table(tableName).row("row_id_2").store()  \
    .column("family1", "row2_col1", "row2_col_value1")  \
    .now()

println "Done"

println "Querying row by id..."

println HBase.session(session).table(tableName).row("row_id_1")  \
    .query()  \
    .now().string

println "Querying all rows..."

println HBase.session(session).table(tableName).row().query().now().string

println "Querying row by id with extended settings..."

println HBase.session(session).table(tableName).row().query()  \
    .column("family1", "row2_col1")  \
    .column("family2")  \
    .times(0, Long.MAX_VALUE)  \
    .numVersions(1)  \
    .now().string

println "Deleting cell..."

HBase.session(session).table(tableName).row("row_id_1")  \
    .delete()  \
    .column("family1", "col1")  \
    .now()

println "Rows after delete:"

println HBase.session(session).table(tableName).row().query().now().string

println "Extended cell delete"

HBase.session(session).table(tableName).row("row_id_1")  \
    .delete()  \
    .column("family2")  \
    .time(Long.MAX_VALUE)  \
    .now()

println "Rows after delete:"

println HBase.session(session).table(tableName).row().query().now().string

println "Table regions : " + HBase.session(session).table(tableName)  \
    .regions()  \
    .now().string

println "Creating scanner..."

scannerId = HBase.session(session).table(tableName).scanner().create()  \
    .column("family1", "col2")  \
    .column("family2")  \
    .startRow("row_id_1")  \
    .endRow("row_id_2")  \
    .batch(1)  \
    .startTime(0)  \
    .endTime(Long.MAX_VALUE)  \
    .filter("")  \
    .maxVersions(100)  \
    .now().scannerId

println "Scanner id=" + scannerId

println "Scanner get next..."

println HBase.session(session).table(tableName).scanner(scannerId)  \
    .getNext()  \
    .now().string

println "Dropping scanner with id=" + scannerId

HBase.session(session).table(tableName).scanner(scannerId).delete().now()

println "Done"

println "Dropping table '" + tableName + "'..."

HBase.session(session).table(tableName).delete().now()

println "Done"

session.shutdown(10, SECONDS)

cURL Examples

Get software version

Set Accept Header to "text/plain", "text/xml", "application/json" or "application/x-protobuf"

%  curl -i -k -u bob:bob-password\
 -H "Accept:  application/json"\
 -X GET 'https://localhost:8443/gateway/sample/hbase/api/v1/version'

Get version information regarding the HBase cluster backing the Stargate instance

Set Accept Header to "text/plain", "text/xml" or "application/x-protobuf"

%  curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X GET 'https://localhost:8443/gateway/sample/hbase/api/v1/version/cluster'

Get detailed status on the HBase cluster backing the Stargate instance.

Set Accept Header to "text/plain", "text/xml", "application/json" or "application/x-protobuf"

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X GET 'https://localhost:8443/gateway/sample/hbase/api/v1/status/cluster'

Get the list of available tables.

Set Accept Header to "text/plain", "text/xml", "application/json" or "application/x-protobuf"

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X GET 'https://localhost:8443/gateway/sample/hbase/api/v1'

Create table with two column families using xml input

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"   -H "Content-Type: text/xml"\
 -d '<?xml version="1.0" encoding="UTF-8"?><TableSchema name="table1"><ColumnSchema name="family1"/><ColumnSchema name="family2"/></TableSchema>'\
 -X PUT 'https://localhost:8443/gateway/sample/hbase/api/v1/table1/schema'

Create table "table2" with column families "family3" and "family4" using JSON input

% curl -i -k -u bob:bob-password\
 -H "Accept: application/json"  -H "Content-Type: application/json"\
 -d '{"name":"table2","ColumnSchema":[{"name":"family3"},{"name":"family4"}]}'\
 -X PUT 'https://localhost:8443/gateway/sample/hbase/api/v1/table2/schema'

Get table metadata

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X GET 'https://localhost:8443/gateway/sample/hbase/api/v1/table1/regions'

Insert single row table

% curl -i -k -u bob:bob-password\
 -H "Content-Type: text/xml"\
 -H "Accept: text/xml"\
 -d '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="cm93MQ=="><Cell column="ZmFtaWx5MTpjb2wx" >dGVzdA==</Cell></Row></CellSet>'\
 -X POST 'https://localhost:8443/gateway/sample/hbase/api/v1/table1/row1'

Insert multiple rows into table

% curl -i -k -u bob:bob-password\
 -H "Content-Type: text/xml"\
 -H "Accept: text/xml"\
 -d '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><CellSet><Row key="cm93MA=="><Cell column=" ZmFtaWx5Mzpjb2x1bW4x" >dGVzdA==</Cell></Row><Row key="cm93MQ=="><Cell column=" ZmFtaWx5NDpjb2x1bW4x" >dGVzdA==</Cell></Row></CellSet>'\
 -X POST 'https://localhost:8443/gateway/sample/hbase/api/v1/table2/false-row-key'

Get all data from table

Set Accept Header to "text/plain", "text/xml", "application/json" or "application/x-protobuf"

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X GET 'https://localhost:8443/gateway/sample/hbase/api/v1/table1/*'

Execute cell or row query

Set Accept Header to "text/plain", "text/xml", "application/json" or "application/x-protobuf"

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X GET 'https://localhost:8443/gateway/sample/hbase/api/v1/table1/row1/family1:col1'

Delete entire row from table

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X DELETE 'https://localhost:8443/gateway/sample/hbase/api/v1/table2/row0'

Delete column family from row

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X DELETE 'https://localhost:8443/gateway/sample/hbase/api/v1/table2/row0/family3'

Delete specific column from row

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X DELETE 'https://localhost:8443/gateway/sample/hbase/api/v1/table2/row0/family3'

Create scanner

Scanner URL will be in Location response header

% curl -i -k -u bob:bob-password\
 -H "Content-Type: text/xml"\
 -d '<Scanner batch="1"/>'\
 -X PUT 'https://localhost:8443/gateway/sample/hbase/api/v1/table1/scanner'

Get the values of the next cells found by the scanner

% curl -i -k -u bob:bob-password\
 -H "Accept: application/json"\
 -X GET 'https://localhost:8443/gateway/sample/hbase/api/v1/table1/scanner/13705290446328cff5ed'

Delete scanner

% curl -i -k -u bob:bob-password\
 -H "Accept: text/xml"\
 -X DELETE 'https://localhost:8443/gateway/sample/hbase/api/v1/table1/scanner/13705290446328cff5ed'

Space shortcuts

Child pages

Assumptions

HBase Stargate Setup

Launch Stargate

Configure Sandbox port mapping for VirtualBox

Client DSL Examples

cURL Examples

Get software version

Get version information regarding the HBase cluster backing the Stargate instance

Get detailed status on the HBase cluster backing the Stargate instance.

Get the list of available tables.

Create table with two column families using xml input

Create table "table2" with column families "family3" and "family4" using JSON input

Get table metadata

Insert single row table

Insert multiple rows into table

Get all data from table

Execute cell or row query

Delete entire row from table

Delete column family from row

Delete specific column from row

Create scanner

Get the values of the next cells found by the scanner

Delete scanner