org.apache.gora.dynamodb.store

Class DynamoDBStore<K,T extends org.apache.gora.persistency.Persistent>

java.lang.Object

org.apache.gora.dynamodb.store.DynamoDBStore<K,T>

Type Parameters:

K -

T -

All Implemented Interfaces:

org.apache.gora.store.DataStore<K,T>

public class DynamoDBStore<K,T extends org.apache.gora.persistency.Persistent>
extends Object
implements org.apache.gora.store.DataStore<K,T>

Class for using DynamoDBStores

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG Helper to write useful information into the logs.

Constructor Summary

Constructors

Constructor and Description
DynamoDBStore()

Method Summary

Modifier and Type	Method and Description
void	close()
void	createSchema() Creates the table within the data store for a preferred schema or for a group of schemas defined within the mapping file
boolean	delete(K key)
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	executeDeleteTableRequest(String pTableName) Executes a delete table request using the DynamoDB client
void	flush()
T	get(K key)
T	get(K key, String[] fields)
org.apache.gora.persistency.BeanFactory<K,T>	getBeanFactory()
String	getConsistency()
boolean	getConsistencyReads() Gets consistency level for reads
com.amazonaws.services.dynamodbv2.AmazonDynamoDB	getDynamoDbClient() Gets DynamoDBClient.
com.amazonaws.services.dynamodbv2.AmazonDynamoDB	getDynamoDBClient()
DynamoDBMapping	getDynamoDbMapping()
Class<K>	getKeyClass()
List<org.apache.gora.query.PartitionQuery<K,T>>	getPartitions(org.apache.gora.query.Query<K,T> arg0)
Class<T>	getPersistentClass()
String	getPreferredSchema()
String	getSchemaName()
Map<String,String>	getTableAttributes(String tableName) Returns a table attribues.
ArrayList<com.amazonaws.services.dynamodbv2.model.KeySchemaElement>	getTableKeySchema(String tableName) Gets a specific table key schema.
com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput	getTableProvisionedThroughput(String tableName) Gets the provisioned throughput for a specific table.
void	initialize(Class<K> keyClass, Class<T> persistentClass, Properties properties) Initialize the data store by reading the credentials, setting the client's properties up and reading the mapping file.
K	newKey()
T	newPersistent()
org.apache.gora.query.Query<K,T>	newQuery()
void	put(K key, T value)
boolean	schemaExists() Verifies if the specified schemas exist
void	setBeanFactory(org.apache.gora.persistency.BeanFactory<K,T> arg0)
void	setConsistency(String consistency)
void	setDynamoDBClient(com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient)
void	setDynamoDbMapping(DynamoDBMapping mapping)
void	setDynamoDbStore(IDynamoDB<K,T> iDynamoDB) Set DynamoDBStore to be used.
void	setKeyClass(Class<K> arg0)
void	setPersistentClass(Class<T> arg0)
void	setPreferredSchema(String preferredSchema)
void	truncateSchema()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Helper to write useful information into the logs.

Constructor Detail

DynamoDBStore

public DynamoDBStore()

Method Detail

close

public void close()

Specified by:

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

createSchema

public void createSchema()

Creates the table within the data store for a preferred schema or for a group of schemas defined within the mapping file

Specified by:

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

delete

public boolean delete(K key)

Specified by:

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

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.Persistent>

deleteSchema

public void deleteSchema()

Specified by:

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

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.Persistent>

flush

public void flush()

Specified by:

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

get

public T get(K key)

Specified by:

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

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.Persistent>

getBeanFactory

public org.apache.gora.persistency.BeanFactory<K,T> getBeanFactory()

Specified by:

getBeanFactory in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.Persistent>

getKeyClass

public Class<K> getKeyClass()

Specified by:

getKeyClass in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.Persistent>

getPartitions

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

Specified by:

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

Throws:

IOException

getPersistentClass

public Class<T> getPersistentClass()

Specified by:

getPersistentClass in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.Persistent>

getSchemaName

public String getSchemaName()

Specified by:

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

initialize

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

Initialize the data store by reading the credentials, setting the client's properties up and reading the mapping file. Initialize is called when then the call to DataStoreFactory.createDataStore(java.lang.Class<D>, java.lang.Class<K>, java.lang.Class<T>, org.apache.hadoop.conf.Configuration) is made.

Specified by:

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

Parameters:

keyClass -

persistentClass -

properties -

newKey

public K newKey()

Specified by:

newKey in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.Persistent>

newPersistent

public T newPersistent()

Specified by:

newPersistent in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.Persistent>

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.Persistent>

put

public void put(K key,
                T value)

Specified by:

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

schemaExists

public boolean schemaExists()

Verifies if the specified schemas exist

Specified by:

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

Returns:

setBeanFactory

public void setBeanFactory(org.apache.gora.persistency.BeanFactory<K,T> arg0)

Specified by:

setBeanFactory in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.Persistent>

setKeyClass

public void setKeyClass(Class<K> arg0)

Specified by:

setKeyClass in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.Persistent>

setPersistentClass

public void setPersistentClass(Class<T> arg0)

Specified by:

setPersistentClass in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.Persistent>

truncateSchema

public void truncateSchema()

Specified by:

truncateSchema in interface org.apache.gora.store.DataStore<K,T extends org.apache.gora.persistency.Persistent>

executeDeleteTableRequest

public void executeDeleteTableRequest(String pTableName)

Executes a delete table request using the DynamoDB client

Parameters:

pTableName -

getTableKeySchema

public ArrayList<com.amazonaws.services.dynamodbv2.model.KeySchemaElement> getTableKeySchema(String tableName)

Gets a specific table key schema.

Parameters:

tableName - from which key schema is to be obtained.

Returns:

KeySchema from table.

getTableProvisionedThroughput

public com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput getTableProvisionedThroughput(String tableName)

Gets the provisioned throughput for a specific table.

Parameters:

tableName - to get the ProvisionedThroughput.

Returns:

ProvisionedThroughput for a specific table

getTableAttributes

public Map<String,String> getTableAttributes(String tableName)

Returns a table attribues.

Parameters:

tableName -

Returns:

getConsistencyReads

public boolean getConsistencyReads()

Gets consistency level for reads

Returns:

True for strong consistency or false for eventual consistent reads

setDynamoDbStore

public void setDynamoDbStore(IDynamoDB<K,T> iDynamoDB)

Set DynamoDBStore to be used.

Parameters:

iDynamoDB -

getPreferredSchema

public String getPreferredSchema()

Returns:

the preferredSchema

setPreferredSchema

public void setPreferredSchema(String preferredSchema)

Parameters:

preferredSchema - the preferredSchema to set

getDynamoDbClient

public com.amazonaws.services.dynamodbv2.AmazonDynamoDB getDynamoDbClient()

Gets DynamoDBClient.

Returns:

getDynamoDbMapping

public DynamoDBMapping getDynamoDbMapping()

Returns:

the mapping

setDynamoDbMapping

public void setDynamoDbMapping(DynamoDBMapping mapping)

Parameters:

mapping - the mapping to set

getConsistency

public String getConsistency()

Returns:

the consistency

setConsistency

public void setConsistency(String consistency)

Parameters:

consistency - the consistency to set

getDynamoDBClient

public com.amazonaws.services.dynamodbv2.AmazonDynamoDB getDynamoDBClient()

Returns:

the dynamoDBClient

setDynamoDBClient

public void setDynamoDBClient(com.amazonaws.services.dynamodbv2.AmazonDynamoDB dynamoDBClient)

Parameters:

dynamoDBClient - the dynamoDBClient to set