org.infinispan.loaders.hbase

Class HBaseFacade

java.lang.Object

org.infinispan.loaders.hbase.HBaseFacade

public class HBaseFacade
extends Object

Adapter class for HBase. Provides a logical abstraction on top of the basic HBase API that makes it easier to use.

Since:

5.2

Author:

Justin Hayes

Constructor Summary

Constructors

Constructor and Description
HBaseFacade() Create a new HBaseService.
HBaseFacade(Map<String,String> props) Create a new HBaseService.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRow(String tableName, String key, Map<String,Map<String,byte[]>> dataMap) Adds a row to a HBase table.
void	createTable(String name, List<String> columnFamilies) Creates a new HBase table.
void	createTable(String name, List<String> columnFamilies, int maxVersions) Creates a new HBase table.
void	deleteTable(String name) Deletes a HBase table.
Map<String,Map<String,byte[]>>	readRow(String tableName, String key, List<String> columnFamilies) Reads the values in a row from a table.
Map<String,Map<String,Map<String,byte[]>>>	readRows(String tableName, String keyPrefix, long ts, String columnFamily, String qualifier) Reads the values from multiple rows from a table, using a key prefix and a timestamp.
boolean	removeRow(String tableName, String key) Removes a row from a table.
void	removeRows(String tableName, Set<Object> keys) Removes rows from a table.
Map<String,byte[]>	scan(String tableName, int numEntries, String columnFamily, String qualifier) Scans an entire table, returning the values from the given column family and field for each row.
Map<String,byte[]>	scan(String tableName, String columnFamily, String qualifier) Scans an entire table, returning the values from the given column family and field for each row.
Set<Object>	scanForKeys(String tableName) Returns a set of all unique keys for a given table.
boolean	tableExists(String name) Checks to see if a table exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HBaseFacade

public HBaseFacade()

Create a new HBaseService.

HBaseFacade

public HBaseFacade(Map<String,String> props)

Create a new HBaseService.

Method Detail

createTable

public void createTable(String name,
               List<String> columnFamilies)
                 throws HBaseException

Creates a new HBase table.

Parameters:

name - the name of the table

columnFamilies - a list of column family names to use

Throws:

HBaseException

createTable

public void createTable(String name,
               List<String> columnFamilies,
               int maxVersions)
                 throws HBaseException

Creates a new HBase table.

Parameters:

name - the name of the table

columnFamilies - a list of column family names to create

maxVersions - the max number of versions to maintain for the column families

Throws:

HBaseException

deleteTable

public void deleteTable(String name)
                 throws HBaseException

Deletes a HBase table.

Parameters:

name - the name of the table

Throws:

HBaseException

tableExists

public boolean tableExists(String name)
                    throws HBaseException

Checks to see if a table exists.

Parameters:

name - the name of the table

Throws:

HBaseException

addRow

public void addRow(String tableName,
          String key,
          Map<String,Map<String,byte[]>> dataMap)
            throws HBaseException

Adds a row to a HBase table.

Parameters:

tableName - the table to add to

key - the unique key for the row

dataMap - the data to add, where the outer map's keys are column family name and values are maps that contain the fields and values to add into that column family.

Throws:

HBaseException

readRow

public Map<String,Map<String,byte[]>> readRow(String tableName,
                                     String key,
                                     List<String> columnFamilies)
                                       throws HBaseException

Reads the values in a row from a table.

Parameters:

tableName - the table to read from

key - the key for the row

columnFamilies - which column families to return

Returns:

a nested map where the outer map's keys are column family name and values are maps that contain the fields and values from that column family.

Throws:

HBaseException

readRows

public Map<String,Map<String,Map<String,byte[]>>> readRows(String tableName,
                                                  String keyPrefix,
                                                  long ts,
                                                  String columnFamily,
                                                  String qualifier)
                                                    throws HBaseException

Reads the values from multiple rows from a table, using a key prefix and a timestamp. For example, if rows were added with keys: key1 key2 key3 key4 Then readRows("myTable", "key", 3, ...) would return the data for rows with key1, key1, and key3.

Parameters:

tableName - the table to read from

keyPrefix - the key prefix to use for the query

ts - timestamp before which rows should be returned

columnFamily - which column family to return

qualifier - which qualifier (ie field) to return

Returns:

a nested map where the outermost map's keys are row keys and values are map whose keys are column family name and values are maps that contain the fields and values from that column family for that row.

Throws:

HBaseException

removeRow

public boolean removeRow(String tableName,
                String key)
                  throws HBaseException

Removes a row from a table.

Parameters:

tableName - the table to remove from

key - the key for the row to remove

Returns:

true if the row existed and was deleted; false if it didn't exist.

Throws:

HBaseException

removeRows

public void removeRows(String tableName,
              Set<Object> keys)
                throws HBaseException

Removes rows from a table.

Parameters:

tableName - the table to remove from

keys - a list of keys for the row to remove

Throws:

HBaseException

scan

public Map<String,byte[]> scan(String tableName,
                      String columnFamily,
                      String qualifier)
                        throws HBaseException

Scans an entire table, returning the values from the given column family and field for each row. TODO - maybe update to accept multiple column families and fields and return a Map>>

Parameters:

tableName - the table to scan

columnFamily - the column family of the field to return

qualifier - the field to return

Returns:

map mapping row keys to values for all rows

Throws:

HBaseException

scan

public Map<String,byte[]> scan(String tableName,
                      int numEntries,
                      String columnFamily,
                      String qualifier)
                        throws HBaseException

Scans an entire table, returning the values from the given column family and field for each row. TODO - maybe update to accept multiple column families and fields and return a Map>>

Parameters:

tableName - the table to scan

numEntries - the max number of entries to return; if < 0, defaults to Integer.MAX_VALUE

columnFamily - the column family of the field to return

qualifier - the field to return

Returns:

map mapping row keys to values for all rows

Throws:

HBaseException

scanForKeys

public Set<Object> scanForKeys(String tableName)
                        throws HBaseException

Returns a set of all unique keys for a given table.

Parameters:

tableName - the table to return the keys for

Returns:

Throws:

HBaseException