org.apache.gora.hbase.store

Class HBaseStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

java.lang.Object

org.apache.gora.store.impl.DataStoreBase<K,T>

org.apache.gora.hbase.store.HBaseStore<K,T>

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.gora.store.DataStore<K,T>, org.apache.hadoop.conf.Configurable, org.apache.hadoop.io.Writable

public class HBaseStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>
extends org.apache.gora.store.impl.DataStoreBase<K,T>
implements org.apache.hadoop.conf.Configurable

DataStore for HBase. Thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MAPPING_FILE
static org.slf4j.Logger	LOG
static String	PARSE_MAPPING_FILE_KEY

Fields inherited from class org.apache.gora.store.impl.DataStoreBase

beanFactory, conf, datumReader, datumWriter, fieldMap, keyClass, persistentClass, properties, schema

Constructor Summary

Constructors

Constructor and Description
HBaseStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
org.apache.hadoop.hbase.client.ResultScanner	createScanner(org.apache.gora.query.Query<K,T> query)
void	createSchema()
boolean	delete(K key) Deletes the object with the given key.
void	delete(T obj)
long	deleteByQuery(org.apache.gora.query.Query<K,T> query)
void	deleteSchema()
org.apache.gora.query.Result<K,T>	execute(org.apache.gora.query.Query<K,T> query)
void	flush()
T	get(K key, String[] fields)
org.apache.hadoop.conf.Configuration	getConf()
HBaseMapping	getMapping()
List<org.apache.gora.query.PartitionQuery<K,T>>	getPartitions(org.apache.gora.query.Query<K,T> query)
int	getScannerCaching() Gets the Scanner Caching optimization value
String	getSchemaName()
void	initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties)
T	newInstance(org.apache.hadoop.hbase.client.Result result, String[] fields) Creates a new Persistent instance with the values in 'result' for the fields listed.
org.apache.gora.query.Query<K,T>	newQuery()
void	put(K key, T persistent) Serializes the Persistent data and saves in HBase.
boolean	schemaExists()
void	setConf(org.apache.hadoop.conf.Configuration conf)
HBaseStore<K,T>	setScannerCaching(int numRows) Sets the value for Scanner Caching optimization

Methods inherited from class org.apache.gora.store.impl.DataStoreBase

equals, get, getBeanFactory, getFields, getFieldsToQuery, getKeyClass, getOrCreateConf, getPersistentClass, getSchemaName, newKey, newPersistent, readFields, setBeanFactory, setKeyClass, setPersistentClass, truncateSchema, write

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

PARSE_MAPPING_FILE_KEY

public static final String PARSE_MAPPING_FILE_KEY

See Also:

Constant Field Values

DEFAULT_MAPPING_FILE

public static final String DEFAULT_MAPPING_FILE

See Also:

Constant Field Values

Constructor Detail

HBaseStore

public HBaseStore()

Method Detail

initialize

public void initialize(Class<K> keyClass,
              Class<T> persistentClass,
              Properties properties)

Specified by:

initialize in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

Overrides:

initialize in class org.apache.gora.store.impl.DataStoreBase<K,T extends org.apache.gora.persistency.impl.PersistentBase>

getSchemaName

public String getSchemaName()

Specified by:

getSchemaName in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

getMapping

public HBaseMapping getMapping()

createSchema

public void createSchema()

Specified by:

createSchema in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

deleteSchema

public void deleteSchema()

Specified by:

deleteSchema in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

schemaExists

public boolean schemaExists()

Specified by:

schemaExists in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

get

public T get(K key,
    String[] fields)

Specified by:

get in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

put

public void put(K key,
       T persistent)

Serializes the Persistent data and saves in HBase. Topmost fields of the record are persisted in "raw" format (not avro serialized). This behavior happens in maps and arrays too. ["null","type"] type (a.k.a. optional field) is persisted like as if it is ["type"], but the column get deleted if value==null (so value read after will be null).

Specified by:

put in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

Parameters:

persistent - Record to be persisted in HBase

delete

public void delete(T obj)

delete

public boolean delete(K key)

Deletes the object with the given key.

Specified by:

delete in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

Returns:

always true

deleteByQuery

public long deleteByQuery(org.apache.gora.query.Query<K,T> query)

Specified by:

deleteByQuery in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

flush

public void flush()

Specified by:

flush in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

newQuery

public org.apache.gora.query.Query<K,T> newQuery()

Specified by:

newQuery in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

getPartitions

public List<org.apache.gora.query.PartitionQuery<K,T>> getPartitions(org.apache.gora.query.Query<K,T> query)
                                                                                                                      throws IOException

Specified by:

getPartitions in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

Throws:

IOException

execute

public org.apache.gora.query.Result<K,T> execute(org.apache.gora.query.Query<K,T> query)

Specified by:

execute in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

createScanner

public org.apache.hadoop.hbase.client.ResultScanner createScanner(org.apache.gora.query.Query<K,T> query)
                                                           throws IOException

Throws:

IOException

newInstance

public T newInstance(org.apache.hadoop.hbase.client.Result result,
            String[] fields)
                                                                      throws IOException

Creates a new Persistent instance with the values in 'result' for the fields listed.

Parameters:

result - result form a HTable#get()

fields - List of fields queried, or null for all

Returns:

A new instance with default values for not listed fields null if 'result' is null.

Throws:

IOException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.impl.PersistentBase>

getConf

public org.apache.hadoop.conf.Configuration getConf()

Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

Overrides:

getConf in class org.apache.gora.store.impl.DataStoreBase<K,T extends org.apache.gora.persistency.impl.PersistentBase>

setConf

public void setConf(org.apache.hadoop.conf.Configuration conf)

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

Overrides:

setConf in class org.apache.gora.store.impl.DataStoreBase<K,T extends org.apache.gora.persistency.impl.PersistentBase>

getScannerCaching

public int getScannerCaching()

Gets the Scanner Caching optimization value

Returns:

The value used internally in Scan.setCaching(int)

setScannerCaching

public HBaseStore<K,T> setScannerCaching(int numRows)

Sets the value for Scanner Caching optimization

Parameters:

numRows - the number of rows for caching >= 0

Returns:

<<Fluent interface>>

See Also:

Scan.setCaching(int)