com.amazonaws.mobileconnectors.dynamodbv2.document

Class Table

java.lang.Object

com.amazonaws.mobileconnectors.dynamodbv2.document.Table

public class Table
extends java.lang.Object

The Table class is the starting object when using the Document API. It is used to Get documents from the DynamnoDB table and write documents back to the DynamoDB table.

Constructor Summary

Constructors

Constructor and Description
Table(com.amazonaws.services.dynamodbv2.AmazonDynamoDB client, java.lang.String tableName) Constructor.
Table(com.amazonaws.services.dynamodbv2.AmazonDynamoDB client, java.lang.String tableName, com.amazonaws.services.dynamodbv2.model.TableDescription tableDescription) Constructor.

Method Summary

Modifier and Type	Method and Description
protected static <X extends com.amazonaws.AmazonWebServiceRequest> X	appendDynamoDBDocumentUserAgentString(X request)
Document	deleteItem(Primitive hashKey) Delete a document in DynamoDB.
Document	deleteItem(Primitive hashKey, DeleteItemOperationConfig config) Delete a document in DynamoDB.
Document	deleteItem(Primitive hashKey, Primitive rangeKey) Delete a document in DynamoDB.
Document	deleteItem(Primitive hashKey, Primitive rangeKey, DeleteItemOperationConfig config) Delete a document in DynamoDB.
java.util.List<com.amazonaws.services.dynamodbv2.model.AttributeDefinition>	getAttributes()
protected com.amazonaws.services.dynamodbv2.AmazonDynamoDB	getClient()
java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription>	getGlobalSecondaryIndexes()
java.util.List<java.lang.String>	getGlobalSecondaryIndexNames()
java.util.List<java.lang.String>	getHashKeys()
Document	getItem(Primitive hashKey) Gets a document from DynamoDB by hash primary key.
Document	getItem(Primitive hashKey, GetItemOperationConfig config) Gets a document from DynamoDB by hash primary key, using specified configs.
Document	getItem(Primitive hashKey, Primitive rangeKey) Gets a document from DynamoDB by hash-and-range primary key.
Document	getItem(Primitive hashKey, Primitive rangeKey, GetItemOperationConfig config) Gets a document from DynamoDB by hash-and-range primary key, using specified configs.
java.util.Map<java.lang.String,KeyDescription>	getKeys()
java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription>	getLocalSecondaryIndexes()
java.util.List<java.lang.String>	getLocalSecondaryIndexNames()
java.util.List<java.lang.String>	getRangeKeys()
com.amazonaws.services.dynamodbv2.model.TableDescription	getTableDescription()
java.lang.String	getTableName()
static Table	loadTable(com.amazonaws.services.dynamodbv2.AmazonDynamoDB client, java.lang.String tableName) Load table configuration.
void	loadTableDescription() Load table description.
Document	putItem(Document document) Puts a document into DynamoDB.
Document	putItem(Document document, PutItemOperationConfig config) Puts a document into DynamoDB.
Search	query(Primitive hashKey) Initiates a Search object to Query a DynamoDB table, with the specified hash primary key.
Search	query(Primitive hashKey, Expression filterExpression) Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and filterExpression.
Search	query(Primitive hashKey, QueryFilter filter) Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and filter.
Search	query(QueryFilter filter) Initiates a Search object to Query a DynamoDB table, with the specified query filter.
Search	query(QueryOperationConfig config) Initiates a Search object to Query a DynamoDB table, with the specified query operation config.
Search	scan(Expression filterExpression) Initiates a Search object to Scan a DynamoDB table, with the specified expression.
Search	scan(ScanFilter filter) Initiates a Search object to Scan a DynamoDB table, with the specified filter.
Search	scan(ScanOperationConfig config) Initiates a Search object to Query a DynamoDB table, with the specified config.
protected void	setAttributes(java.util.List<com.amazonaws.services.dynamodbv2.model.AttributeDefinition> attributes)
protected void	setGlobalSecondaryIndexes(java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription> globalSecondaryIndexes)
protected void	setGlobalSecondaryIndexNames(java.util.List<java.lang.String> globalSecondaryIndexNames)
protected void	setHashKeys(java.util.List<java.lang.String> hashKeys)
protected void	setKeys(java.util.Map<java.lang.String,KeyDescription> keys)
protected void	setLocalSecondaryIndexes(java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription> localSecondaryIndexes)
protected void	setLocalSecondaryIndexNames(java.util.List<java.lang.String> localSecondaryIndexNames)
protected void	setRangeKeys(java.util.List<java.lang.String> rangeKeys)
protected void	setTableDescription(com.amazonaws.services.dynamodbv2.model.TableDescription tableDescription)
Document	updateItem(Document doc, Primitive hashKey, Primitive rangeKey, UpdateItemOperationConfig config) Update a document in DynamoDB.
Document	updateItem(Document doc, Primitive hashKey, UpdateItemOperationConfig config) Update a document in DynamoDB.
Document	updateItem(Document doc, UpdateItemOperationConfig config) Update a document in DynamoDB.

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

public Table(com.amazonaws.services.dynamodbv2.AmazonDynamoDB client,
             java.lang.String tableName)

Constructor.

Parameters:

client - the dynamodb client.

tableName - the table name.

Table

public Table(com.amazonaws.services.dynamodbv2.AmazonDynamoDB client,
             java.lang.String tableName,
             com.amazonaws.services.dynamodbv2.model.TableDescription tableDescription)

Constructor.

Parameters:

client - the dynamodb client.

tableName - the table name.

tableDescription - the table description.

Method Detail

appendDynamoDBDocumentUserAgentString

protected static <X extends com.amazonaws.AmazonWebServiceRequest> X appendDynamoDBDocumentUserAgentString(X request)

loadTable

public static Table loadTable(com.amazonaws.services.dynamodbv2.AmazonDynamoDB client,
                              java.lang.String tableName)

Load table configuration.

Parameters:

client - the dynamodb client.

tableName - the tablename.

Returns:

a table object.

loadTableDescription

public void loadTableDescription()

Load table description.

getTableName

public java.lang.String getTableName()

getTableDescription

public com.amazonaws.services.dynamodbv2.model.TableDescription getTableDescription()

getKeys

public java.util.Map<java.lang.String,KeyDescription> getKeys()

getGlobalSecondaryIndexes

public java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription> getGlobalSecondaryIndexes()

getLocalSecondaryIndexes

public java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription> getLocalSecondaryIndexes()

getLocalSecondaryIndexNames

public java.util.List<java.lang.String> getLocalSecondaryIndexNames()

getGlobalSecondaryIndexNames

public java.util.List<java.lang.String> getGlobalSecondaryIndexNames()

getHashKeys

public java.util.List<java.lang.String> getHashKeys()

getRangeKeys

public java.util.List<java.lang.String> getRangeKeys()

getAttributes

public java.util.List<com.amazonaws.services.dynamodbv2.model.AttributeDefinition> getAttributes()

setKeys

protected void setKeys(java.util.Map<java.lang.String,KeyDescription> keys)

setGlobalSecondaryIndexes

protected void setGlobalSecondaryIndexes(java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription> globalSecondaryIndexes)

setLocalSecondaryIndexes

protected void setLocalSecondaryIndexes(java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription> localSecondaryIndexes)

setLocalSecondaryIndexNames

protected void setLocalSecondaryIndexNames(java.util.List<java.lang.String> localSecondaryIndexNames)

setGlobalSecondaryIndexNames

protected void setGlobalSecondaryIndexNames(java.util.List<java.lang.String> globalSecondaryIndexNames)

setHashKeys

protected void setHashKeys(java.util.List<java.lang.String> hashKeys)

setRangeKeys

protected void setRangeKeys(java.util.List<java.lang.String> rangeKeys)

setAttributes

protected void setAttributes(java.util.List<com.amazonaws.services.dynamodbv2.model.AttributeDefinition> attributes)

putItem

public Document putItem(Document document)

Puts a document into DynamoDB.

Parameters:

document - the Document.

Returns:

the Document that was put in the table.

putItem

public Document putItem(Document document,
                        PutItemOperationConfig config)

Puts a document into DynamoDB.

Parameters:

document - the Document.

config - PutItemOperationConfig.

Returns:

the dynamodb Document.

getItem

public Document getItem(Primitive hashKey)

Gets a document from DynamoDB by hash primary key.

Parameters:

hashKey - the hash key.

Returns:

the dynamodb Document.

getItem

public Document getItem(Primitive hashKey,
                        Primitive rangeKey)

Gets a document from DynamoDB by hash-and-range primary key.

Parameters:

hashKey - the hash key.

rangeKey - the range key.

Returns:

the dynamodb Document.

getItem

public Document getItem(Primitive hashKey,
                        GetItemOperationConfig config)

Gets a document from DynamoDB by hash primary key, using specified configs.

Parameters:

hashKey - the hash key.

config - the GetItemOperationConfig.

Returns:

the dynamodb Document.

getItem

public Document getItem(Primitive hashKey,
                        Primitive rangeKey,
                        GetItemOperationConfig config)

Gets a document from DynamoDB by hash-and-range primary key, using specified configs.

Parameters:

hashKey - the hash key.

rangeKey - the range key

config - the GetItemOperationConfig.

Returns:

the dynamodb Document.

deleteItem

public Document deleteItem(Primitive hashKey)

Delete a document in DynamoDB.

Parameters:

hashKey - the hash key.

Returns:

the dynamodb document that was deleted.

deleteItem

public Document deleteItem(Primitive hashKey,
                           Primitive rangeKey)

Delete a document in DynamoDB.

Parameters:

hashKey - the hash key.

rangeKey - the range key.

Returns:

the dynamodb document that was deleted.

deleteItem

public Document deleteItem(Primitive hashKey,
                           DeleteItemOperationConfig config)

Delete a document in DynamoDB.

Parameters:

hashKey - the hash key.

config - the DeleteItemOperationConfig.

Returns:

the dynamodb document that was deleted.

deleteItem

public Document deleteItem(Primitive hashKey,
                           Primitive rangeKey,
                           DeleteItemOperationConfig config)

Delete a document in DynamoDB.

Parameters:

hashKey - the hash key.

rangeKey - the range key.

config - the DeleteItemOperationConfig.

Returns:

the dynamodb document that was deleted.

updateItem

public Document updateItem(Document doc,
                           UpdateItemOperationConfig config)

Update a document in DynamoDB.

Parameters:

doc - Document to update.

config - the UpdateItemOperationConfig.

Returns:

the updated Document.

updateItem

public Document updateItem(Document doc,
                           Primitive hashKey,
                           UpdateItemOperationConfig config)

Update a document in DynamoDB.

Parameters:

doc - Document to update.

hashKey - the hash key.

config - the UpdateItemOperationConfig.

Returns:

the updated Document.

updateItem

public Document updateItem(Document doc,
                           Primitive hashKey,
                           Primitive rangeKey,
                           UpdateItemOperationConfig config)

Update a document in DynamoDB.

Parameters:

doc - Document to update.

hashKey - the hash key.

rangeKey - the range key.

config - the UpdateItemOperationConfig.

Returns:

the updated Document.

query

public Search query(Primitive hashKey,
                    QueryFilter filter)

Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and filter. No calls are made until the Search object is used.

Parameters:

hashKey - the hash key to query against.

filter - the QueryFilter.

Returns:

the Search object.

query

public Search query(Primitive hashKey,
                    Expression filterExpression)

Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and filterExpression. No calls are made until the Search object is used.

Parameters:

hashKey - the hash Key

filterExpression - the filter Expression.

Returns:

the search object.

query

public Search query(Primitive hashKey)

Initiates a Search object to Query a DynamoDB table, with the specified hash primary key. No calls are made until the Search object is used.

Parameters:

hashKey - the hash key to query against.

Returns:

the Search object.

query

public Search query(QueryFilter filter)

Initiates a Search object to Query a DynamoDB table, with the specified query filter. No calls are made until the Search object is used.

Parameters:

filter - the QueryFilter.

Returns:

the Search object.

query

public Search query(QueryOperationConfig config)

Initiates a Search object to Query a DynamoDB table, with the specified query operation config. No calls are made until the Search object is used.

Parameters:

config - the QueryOperationConfig.

Returns:

the Search object.

scan

public Search scan(ScanFilter filter)

Initiates a Search object to Scan a DynamoDB table, with the specified filter. No calls are made until the Search object is used.

Parameters:

filter - Filter to apply to the scan.

Returns:

Resultant Search container.

scan

public Search scan(Expression filterExpression)

Initiates a Search object to Scan a DynamoDB table, with the specified expression. No calls are made until the Search object is used.

Parameters:

filterExpression - Expression to apply to the scan.

Returns:

Resultant Search container.

scan

public Search scan(ScanOperationConfig config)

Initiates a Search object to Query a DynamoDB table, with the specified config. No calls are made until the Search object is used.

Parameters:

config - Configuration to use.

Returns:

Resultant Search container.

getClient

protected com.amazonaws.services.dynamodbv2.AmazonDynamoDB getClient()

setTableDescription

protected void setTableDescription(com.amazonaws.services.dynamodbv2.model.TableDescription tableDescription)