com.agorapulse.micronaut.aws.dynamodb

Interface DynamoDBService<T>

Type Parameters:

T - The type of the DynamoDB entity.

public interface DynamoDBService<T>

The middle-level API for working with DynamoDB tables. Using declarative services using Service is preferred.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BATCH_DELETE_LIMIT
static int	DEFAULT_COUNT_LIMIT
static int	DEFAULT_QUERY_LIMIT
static int	WRITE_BATCH_SIZE

Method Summary

Modifier and Type	Method and Description
default int	count(java.lang.Object hashKey) Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)
default int	count(java.lang.Object hashKey, java.lang.Object rangeKeyValue) Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)
default int	count(java.lang.Object hashKey, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue) Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)
default int	count(java.lang.Object hashKey, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue, com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator) Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)
int	count(java.lang.Object hashKey, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue, com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator, java.util.Map settings) Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)
default int	countByConditions(java.lang.Object hashKey, java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions) Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)
int	countByConditions(java.lang.Object hashKey, java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions, java.util.Map settings) Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)
default int	countByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.util.Date after, java.util.Date before) Deprecated. Consider using the method with java.time.Instant parameter DynamoDBService.countByDates(Object hashKey, String rangeKeyName, Instant after, Instant before)
default int	countByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.util.Date after, java.util.Date before, java.util.Date maxAfterDate) Deprecated. Consider using the method with java.time.Instant parameter DynamoDBService.countByDates(Object hashKey, String rangeKeyName, Instant after, Instant before, Instant maxAfterDate)
default int	countByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.time.Instant after, java.time.Instant before)
default int	countByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.time.Instant after, java.time.Instant before, java.time.Instant maxAfterDate)
default int	countByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.util.Map rangeKeyDates) Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT) - maxAfterDate (default to null)
int	countByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.util.Map rangeKeyDates, java.util.Map settings) Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT) - maxAfterDate (default to null)
default com.amazonaws.services.dynamodbv2.model.CreateTableResult	createTable() Create the DynamoDB table for the given Class.
default com.amazonaws.services.dynamodbv2.model.CreateTableResult	createTable(java.lang.Long readCapacityUnits) Create the DynamoDB table for the given Class.
com.amazonaws.services.dynamodbv2.model.CreateTableResult	createTable(java.lang.Long readCapacityUnits, java.lang.Long writeCapacityUnits) Create the DynamoDB table for the given Class.
default java.lang.Integer	decrement(java.lang.Object hashKey, java.lang.Object rangeKey, java.lang.String attributeName) Decrement a count with an atomic operation
default java.lang.Integer	decrement(java.lang.Object hashKey, java.lang.Object rangeKey, java.lang.String attributeName, int attributeIncrement) Decrement a count with an atomic operation
default java.lang.Integer	decrement(java.lang.Object hashKey, java.lang.String attributeName) Decrement a count with an atomic operation
default void	delete(java.lang.Object hashKey, java.lang.Object rangeKey) Delete item by IDs.
void	delete(java.lang.Object hashKey, java.lang.Object rangeKey, java.util.Map settings) Delete item by IDs.
default void	delete(T item) Delete item from Java object
default void	delete(T item, java.util.Map settings) Delete item from Java object
default void	deleteAll(java.util.List<T> itemsToDelete) Delete a list of items from DynamoDB.
void	deleteAll(java.util.List<T> itemsToDelete, java.util.Map settings) Delete a list of items from DynamoDB.
default int	deleteAll(java.lang.Object hashKey) Delete all items for a given hashKey
default int	deleteAll(java.lang.Object hashKey, java.util.Map settings) Delete all items for a given hashKey
default int	deleteAll(java.lang.Object hashKey, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue) Delete all items for a given hashKey and a rangeKey condition
default int	deleteAll(java.lang.Object hashKey, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue, com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator) Delete all items for a given hashKey and a rangeKey condition
int	deleteAll(java.lang.Object hashKey, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue, com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator, java.util.Map settings) Delete all items for a given hashKey and a rangeKey condition
int	deleteAllByConditions(com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBQueryExpression query, java.util.Map settings)
default int	deleteAllByConditions(java.lang.Object hashKey, java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions)
default int	deleteAllByConditions(java.lang.Object hashKey, java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions, java.util.Map settings)
int	deleteAllByConditions(java.lang.Object hashKey, java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions, java.util.Map settings, java.lang.String indexName)
default void	deleteByHash(java.lang.Object id) Delete item from Java object
com.amazonaws.services.dynamodbv2.model.UpdateItemResult	deleteItemAttribute(java.lang.Object hashKey, java.lang.Object rangeKey, java.lang.String attributeName) Delete a single item attribute
default com.amazonaws.services.dynamodbv2.model.UpdateItemResult	deleteItemAttribute(java.lang.Object hashKey, java.lang.String attributeName)
default T	get(java.lang.Object hashKey) Load an item
T	get(java.lang.Object hashKey, java.lang.Object rangeKey) Load an item
default java.util.List<T>	getAll(java.lang.Object hashKey, java.util.List rangeKeys) Retrieve batched items corresponding to a list of item IDs, in the same order.
java.util.List<T>	getAll(java.lang.Object hashKey, java.util.List rangeKeys, java.util.Map settings) Retrieve batched items corresponding to a list of item IDs, in the same order.
java.lang.Class<?>	getHashKeyClass()
java.lang.String	getHashKeyName()
T	getNewInstance()
java.lang.Class<?>	getRangeKeyClass()
java.lang.String	getRangeKeyName()
default java.lang.Integer	increment(java.lang.Object hashKey, java.lang.Object rangeKey, java.lang.String attributeName) Increment a count with an atomic operation
java.lang.Integer	increment(java.lang.Object hashKey, java.lang.Object rangeKey, java.lang.String attributeName, int attributeIncrement) Increment a count with an atomic operation
default java.lang.Integer	increment(java.lang.Object hashKey, java.lang.String attributeName) Increment a count with an atomic operation
boolean	isIndexRangeKey(java.lang.String rangeName)
com.amazonaws.services.dynamodbv2.datamodeling.PaginatedQueryList<T>	query(com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBQueryExpression queryExpression)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	query(java.lang.Object hashKey) Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	query(java.lang.Object hashKey, java.util.Map settings) Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	query(java.lang.Object hashKey, java.lang.Object rangeKeyValue)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	query(java.lang.Object hashKey, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue) Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	query(java.lang.Object hashKey, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue, com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator) Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)
com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	query(java.lang.Object hashKey, java.lang.String rangeKeyName, java.lang.Object rangeKeyValue, com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator, java.util.Map settings) Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	queryByConditions(java.lang.Object hashKey, java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions) Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false) - throttle insert sleeps during execution to avoid reaching provisioned read throughput (default to false)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	queryByConditions(java.lang.Object hashKey, java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions, java.util.Map settings) Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false) - throttle insert sleeps during execution to avoid reaching provisioned read throughput (default to false)
com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	queryByConditions(java.lang.Object hashKey, java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions, java.util.Map settings, java.lang.String indexName) Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false) - throttle insert sleeps during execution to avoid reaching provisioned read throughput (default to false)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	queryByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.util.Date after, java.util.Date before) Deprecated. Consider using the method with java.time.Instant parameter DynamoDBService.queryByDates(Object hashKey, String rangeKeyName, Instant after, Instant before)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	queryByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.util.Date after, java.util.Date before, java.util.Date maxAfterDate) Deprecated. Consider using the method with java.time.Instant parameter DynamoDBService.queryByDates(Object hashKey, String rangeKeyName, Instant after, Instant before, Instant maxAfterDate)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	queryByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.time.Instant after, java.time.Instant before)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	queryByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.time.Instant after, java.time.Instant before, java.time.Instant maxAfterDate)
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	queryByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.util.Map rangeKeyDates) Query by dates with 'after' and/or 'before' range value 1) After a certain date : [after: new Date()] 2) Before a certain date : [before: new Date()] 3) Between provided dates : [after: new Date() + 1, before: new Date()]
com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T>	queryByDates(java.lang.Object hashKey, java.lang.String rangeKeyName, java.util.Map rangeKeyDates, java.util.Map settings) Query by dates with 'after' and/or 'before' range value 1) After a certain date : [after: new Date()] 2) Before a certain date : [before: new Date()] 3) Between provided dates : [after: new Date() + 1, before: new Date()]
default T	save(T item) Save an item.
default T	save(T item, java.util.Map settings) Save an item.
default java.util.List<T>	saveAll(java.util.List<T> itemsToSave) Save a list of objects in DynamoDB.
java.util.List<T>	saveAll(java.util.List<T> itemsToSave, java.util.Map settings) Save a list of objects in DynamoDB.
default java.util.List<T>	saveAll(T... itemsToSave) Save a list of objects in DynamoDB.
default com.amazonaws.services.dynamodbv2.model.UpdateItemResult	updateItemAttribute(java.lang.Object hashKey, java.lang.Object rangeKey, java.lang.String attributeName, java.lang.Object attributeValue) Update a single item attribute
com.amazonaws.services.dynamodbv2.model.UpdateItemResult	updateItemAttribute(java.lang.Object hashKey, java.lang.Object rangeKey, java.lang.String attributeName, java.lang.Object attributeValue, com.amazonaws.services.dynamodbv2.model.AttributeAction action) Update a single item attribute

Field Detail

DEFAULT_QUERY_LIMIT

static final int DEFAULT_QUERY_LIMIT

See Also:

Constant Field Values

DEFAULT_COUNT_LIMIT

static final int DEFAULT_COUNT_LIMIT

See Also:

Constant Field Values

BATCH_DELETE_LIMIT

static final int BATCH_DELETE_LIMIT

See Also:

Constant Field Values

WRITE_BATCH_SIZE

static final int WRITE_BATCH_SIZE

See Also:

Constant Field Values

Method Detail

count

int count(java.lang.Object hashKey,
          java.lang.String rangeKeyName,
          java.lang.Object rangeKeyValue,
          com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator,
          java.util.Map settings)

Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)

Parameters:

hashKey -

rangeKeyName -

rangeKeyValue -

operator -

settings -

Returns:

count

default int count(java.lang.Object hashKey,
                  java.lang.String rangeKeyName,
                  java.lang.Object rangeKeyValue,
                  com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator)

Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)

Parameters:

hashKey -

rangeKeyName -

rangeKeyValue -

operator -

Returns:

count

default int count(java.lang.Object hashKey,
                  java.lang.String rangeKeyName,
                  java.lang.Object rangeKeyValue)

Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)

Parameters:

hashKey -

rangeKeyName -

rangeKeyValue -

Returns:

count

default int count(java.lang.Object hashKey,
                  java.lang.Object rangeKeyValue)

Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)

Parameters:

hashKey -

rangeKeyValue -

Returns:

count

default int count(java.lang.Object hashKey)

Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)

Parameters:

hashKey -

Returns:

countByDates

@Deprecated
default int countByDates(java.lang.Object hashKey,
                                     java.lang.String rangeKeyName,
                                     java.util.Date after,
                                     java.util.Date before,
                                     java.util.Date maxAfterDate)

Deprecated. Consider using the method with java.time.Instant parameter DynamoDBService.countByDates(Object hashKey, String rangeKeyName, Instant after, Instant before, Instant maxAfterDate)

countByDates

@Deprecated
default int countByDates(java.lang.Object hashKey,
                                     java.lang.String rangeKeyName,
                                     java.util.Date after,
                                     java.util.Date before)

Deprecated. Consider using the method with java.time.Instant parameter DynamoDBService.countByDates(Object hashKey, String rangeKeyName, Instant after, Instant before)

countByDates

default int countByDates(java.lang.Object hashKey,
                         java.lang.String rangeKeyName,
                         java.time.Instant after,
                         java.time.Instant before,
                         java.time.Instant maxAfterDate)

countByDates

default int countByDates(java.lang.Object hashKey,
                         java.lang.String rangeKeyName,
                         java.time.Instant after,
                         java.time.Instant before)

countByDates

int countByDates(java.lang.Object hashKey,
                 java.lang.String rangeKeyName,
                 java.util.Map rangeKeyDates,
                 java.util.Map settings)

Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT) - maxAfterDate (default to null)

Parameters:

hashKey -

rangeKeyName -

rangeKeyDates -

settings -

Returns:

countByDates

default int countByDates(java.lang.Object hashKey,
                         java.lang.String rangeKeyName,
                         java.util.Map rangeKeyDates)

Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT) - maxAfterDate (default to null)

Parameters:

hashKey -

rangeKeyName -

rangeKeyDates -

Returns:

countByConditions

int countByConditions(java.lang.Object hashKey,
                      java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions,
                      java.util.Map settings)

Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)

Parameters:

hashKey -

rangeKeyConditions -

settings -

Returns:

countByConditions

default int countByConditions(java.lang.Object hashKey,
                              java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions)

Optional settings: - consistentRead (default to false) - limit (default to DEFAULT_COUNT_LIMIT)

Parameters:

hashKey -

rangeKeyConditions -

Returns:

createTable

com.amazonaws.services.dynamodbv2.model.CreateTableResult createTable(java.lang.Long readCapacityUnits,
                                                                      java.lang.Long writeCapacityUnits)

Create the DynamoDB table for the given Class.

createTable

default com.amazonaws.services.dynamodbv2.model.CreateTableResult createTable(java.lang.Long readCapacityUnits)

Create the DynamoDB table for the given Class.

createTable

default com.amazonaws.services.dynamodbv2.model.CreateTableResult createTable()

Create the DynamoDB table for the given Class.

decrement

default java.lang.Integer decrement(java.lang.Object hashKey,
                                    java.lang.Object rangeKey,
                                    java.lang.String attributeName,
                                    int attributeIncrement)

Decrement a count with an atomic operation

Parameters:

hashKey -

rangeKey -

attributeName -

attributeIncrement -

Returns:

decrement

default java.lang.Integer decrement(java.lang.Object hashKey,
                                    java.lang.Object rangeKey,
                                    java.lang.String attributeName)

Decrement a count with an atomic operation

Parameters:

hashKey -

rangeKey -

attributeName -

Returns:

decrement

default java.lang.Integer decrement(java.lang.Object hashKey,
                                    java.lang.String attributeName)

Decrement a count with an atomic operation

Parameters:

hashKey -

attributeName -

Returns:

delete

void delete(java.lang.Object hashKey,
            java.lang.Object rangeKey,
            java.util.Map settings)

Delete item by IDs.

Parameters:

hashKey - hash key of the item to delete

rangeKey - range key of the item to delete

settings - settings

delete

default void delete(java.lang.Object hashKey,
                    java.lang.Object rangeKey)

Delete item by IDs.

Parameters:

hashKey - hash key of the item to delete

rangeKey - range key of the item to delete

delete

default void delete(T item,
                    java.util.Map settings)

Delete item from Java object

Parameters:

item -

settings -

delete

default void delete(T item)

Delete item from Java object

Parameters:

item -

deleteByHash

default void deleteByHash(java.lang.Object id)

Delete item from Java object

Parameters:

id -

deleteAll

void deleteAll(java.util.List<T> itemsToDelete,
               java.util.Map settings)

Delete a list of items from DynamoDB.

Parameters:

itemsToDelete - a list of objects to delete

settings - settings

deleteAll

default void deleteAll(java.util.List<T> itemsToDelete)

Delete a list of items from DynamoDB.

Parameters:

itemsToDelete - a list of objects to delete

deleteAll

default int deleteAll(java.lang.Object hashKey,
                      java.util.Map settings)

Delete all items for a given hashKey

Parameters:

hashKey -

settings -

Returns:

deleteAll

default int deleteAll(java.lang.Object hashKey)

Delete all items for a given hashKey

Parameters:

hashKey -

Returns:

deleteAll

int deleteAll(java.lang.Object hashKey,
              java.lang.String rangeKeyName,
              java.lang.Object rangeKeyValue,
              com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator,
              java.util.Map settings)

Delete all items for a given hashKey and a rangeKey condition

Parameters:

hashKey -

rangeKeyName -

rangeKeyValue -

operator -

settings -

Returns:

deleteAll

default int deleteAll(java.lang.Object hashKey,
                      java.lang.String rangeKeyName,
                      java.lang.Object rangeKeyValue,
                      com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator)

Delete all items for a given hashKey and a rangeKey condition

Parameters:

hashKey -

rangeKeyName -

rangeKeyValue -

operator -

Returns:

deleteAll

default int deleteAll(java.lang.Object hashKey,
                      java.lang.String rangeKeyName,
                      java.lang.Object rangeKeyValue)

Delete all items for a given hashKey and a rangeKey condition

Parameters:

hashKey -

rangeKeyName -

rangeKeyValue -

Returns:

deleteAllByConditions

int deleteAllByConditions(java.lang.Object hashKey,
                          java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions,
                          java.util.Map settings,
                          java.lang.String indexName)

Parameters:

hashKey -

rangeKeyConditions -

settings -

indexName -

Returns:

deleteAllByConditions

int deleteAllByConditions(com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBQueryExpression query,
                          java.util.Map settings)

deleteAllByConditions

default int deleteAllByConditions(java.lang.Object hashKey,
                                  java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions,
                                  java.util.Map settings)

Parameters:

hashKey -

rangeKeyConditions -

settings -

Returns:

deleteAllByConditions

default int deleteAllByConditions(java.lang.Object hashKey,
                                  java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions)

Parameters:

hashKey -

rangeKeyConditions -

Returns:

get

T get(java.lang.Object hashKey,
      java.lang.Object rangeKey)

Load an item

Parameters:

hashKey -

rangeKey -

Returns:

get

default T get(java.lang.Object hashKey)

Load an item

Parameters:

hashKey -

Returns:

getAll

java.util.List<T> getAll(java.lang.Object hashKey,
                         java.util.List rangeKeys,
                         java.util.Map settings)

Retrieve batched items corresponding to a list of item IDs, in the same order. Example: items = twitterItemDBService.getAll(1, [1, 2]).

Parameters:

hashKey - Hash Key of the items to retrieve

settings - only used for setting throttle/readCapacityUnit when getting large sets

Returns:

a list of DynamoDBItem

getAll

default java.util.List<T> getAll(java.lang.Object hashKey,
                                 java.util.List rangeKeys)

Retrieve batched items corresponding to a list of item IDs, in the same order. Example: items = twitterItemDBService.getAll(1, [1, 2]).

Parameters:

hashKey - Hash Key of the items to retrieve

Returns:

a list of DynamoDBItem

increment

java.lang.Integer increment(java.lang.Object hashKey,
                            java.lang.Object rangeKey,
                            java.lang.String attributeName,
                            int attributeIncrement)

Increment a count with an atomic operation

Parameters:

hashKey -

rangeKey -

attributeName -

attributeIncrement -

Returns:

increment

default java.lang.Integer increment(java.lang.Object hashKey,
                                    java.lang.Object rangeKey,
                                    java.lang.String attributeName)

Increment a count with an atomic operation

Parameters:

hashKey -

rangeKey -

attributeName -

Returns:

increment

default java.lang.Integer increment(java.lang.Object hashKey,
                                    java.lang.String attributeName)

Increment a count with an atomic operation

Parameters:

hashKey -

attributeName -

Returns:

getNewInstance

T getNewInstance()

query

com.amazonaws.services.dynamodbv2.datamodeling.PaginatedQueryList<T> query(com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBQueryExpression queryExpression)

query

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> query(java.lang.Object hashKey,
                                                                                java.util.Map settings)

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)

Parameters:

hashKey -

settings -

Returns:

query

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> query(java.lang.Object hashKey)

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)

Parameters:

hashKey -

Returns:

query

com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> query(java.lang.Object hashKey,
                                                                        java.lang.String rangeKeyName,
                                                                        java.lang.Object rangeKeyValue,
                                                                        com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator,
                                                                        java.util.Map settings)

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)

Parameters:

hashKey -

rangeKeyName -

rangeKeyValue -

operator -

settings -

Returns:

query

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> query(java.lang.Object hashKey,
                                                                                java.lang.String rangeKeyName,
                                                                                java.lang.Object rangeKeyValue,
                                                                                com.amazonaws.services.dynamodbv2.model.ComparisonOperator operator)

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)

Parameters:

hashKey -

rangeKeyName -

rangeKeyValue -

operator -

Returns:

query

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> query(java.lang.Object hashKey,
                                                                                java.lang.Object rangeKeyValue)

query

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> query(java.lang.Object hashKey,
                                                                                java.lang.String rangeKeyName,
                                                                                java.lang.Object rangeKeyValue)

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false)

Parameters:

hashKey -

rangeKeyName -

rangeKeyValue -

Returns:

queryByConditions

com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> queryByConditions(java.lang.Object hashKey,
                                                                                    java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions,
                                                                                    java.util.Map settings,
                                                                                    java.lang.String indexName)

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false) - throttle insert sleeps during execution to avoid reaching provisioned read throughput (default to false)

Parameters:

hashKey -

rangeKeyConditions -

settings -

Returns:

queryByConditions

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> queryByConditions(java.lang.Object hashKey,
                                                                                            java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions,
                                                                                            java.util.Map settings)

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false) - throttle insert sleeps during execution to avoid reaching provisioned read throughput (default to false)

Parameters:

hashKey -

rangeKeyConditions -

settings -

Returns:

queryByConditions

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> queryByConditions(java.lang.Object hashKey,
                                                                                            java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.Condition> rangeKeyConditions)

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - returnAll disable paging to return all items, WARNING: can be expensive in terms of throughput (default to false) - scanIndexForward (default to false) - throttle insert sleeps during execution to avoid reaching provisioned read throughput (default to false)

Parameters:

hashKey -

rangeKeyConditions -

Returns:

queryByDates

com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> queryByDates(java.lang.Object hashKey,
                                                                               java.lang.String rangeKeyName,
                                                                               java.util.Map rangeKeyDates,
                                                                               java.util.Map settings)

Query by dates with 'after' and/or 'before' range value 1) After a certain date : [after: new Date()] 2) Before a certain date : [before: new Date()] 3) Between provided dates : [after: new Date() + 1, before: new Date()]

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - maxAfterDate (default to null) - scanIndexForward (default to false)

Parameters:

hashKey -

rangeKeyName -

rangeKeyDates -

settings -

Returns:

queryByDates

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> queryByDates(java.lang.Object hashKey,
                                                                                       java.lang.String rangeKeyName,
                                                                                       java.util.Map rangeKeyDates)

Query by dates with 'after' and/or 'before' range value 1) After a certain date : [after: new Date()] 2) Before a certain date : [before: new Date()] 3) Between provided dates : [after: new Date() + 1, before: new Date()]

Optional settings: - batchGetDisabled (only when secondary indexes are used, useful for count when all item attributes are not required) - consistentRead (default to false) - exclusiveStartKey a map with the rangeKey (ex: [id: 2555]), with optional indexRangeKey when using LSI (ex.: [id: 2555, totalCount: 45]) - limit - maxAfterDate (default to null) - scanIndexForward (default to false)

Parameters:

hashKey -

rangeKeyName -

rangeKeyDates -

Returns:

queryByDates

@Deprecated
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> queryByDates(java.lang.Object hashKey,
                                                                                                   java.lang.String rangeKeyName,
                                                                                                   java.util.Date after,
                                                                                                   java.util.Date before)

Deprecated. Consider using the method with java.time.Instant parameter DynamoDBService.queryByDates(Object hashKey, String rangeKeyName, Instant after, Instant before)

queryByDates

@Deprecated
default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> queryByDates(java.lang.Object hashKey,
                                                                                                   java.lang.String rangeKeyName,
                                                                                                   java.util.Date after,
                                                                                                   java.util.Date before,
                                                                                                   java.util.Date maxAfterDate)

Deprecated. Consider using the method with java.time.Instant parameter DynamoDBService.queryByDates(Object hashKey, String rangeKeyName, Instant after, Instant before, Instant maxAfterDate)

queryByDates

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> queryByDates(java.lang.Object hashKey,
                                                                                       java.lang.String rangeKeyName,
                                                                                       java.time.Instant after,
                                                                                       java.time.Instant before)

queryByDates

default com.amazonaws.services.dynamodbv2.datamodeling.QueryResultPage<T> queryByDates(java.lang.Object hashKey,
                                                                                       java.lang.String rangeKeyName,
                                                                                       java.time.Instant after,
                                                                                       java.time.Instant before,
                                                                                       java.time.Instant maxAfterDate)

save

default T save(T item,
               java.util.Map settings)

Save an item.

Parameters:

item - the item to save

settings - settings

Returns:

the Item after it's been saved

save

default T save(T item)

Save an item.

Parameters:

item - the item to save

Returns:

the Item after it's been saved

saveAll

java.util.List<T> saveAll(java.util.List<T> itemsToSave,
                          java.util.Map settings)

Save a list of objects in DynamoDB.

Parameters:

itemsToSave - a list of objects to save

settings - settings

saveAll

default java.util.List<T> saveAll(java.util.List<T> itemsToSave)

Save a list of objects in DynamoDB.

Parameters:

itemsToSave - a list of objects to save

saveAll

default java.util.List<T> saveAll(T... itemsToSave)

Save a list of objects in DynamoDB.

Parameters:

itemsToSave - a list of objects to save

deleteItemAttribute

com.amazonaws.services.dynamodbv2.model.UpdateItemResult deleteItemAttribute(java.lang.Object hashKey,
                                                                             java.lang.Object rangeKey,
                                                                             java.lang.String attributeName)

Delete a single item attribute

Parameters:

hashKey -

rangeKey -

attributeName -

Returns:

deleteItemAttribute

default com.amazonaws.services.dynamodbv2.model.UpdateItemResult deleteItemAttribute(java.lang.Object hashKey,
                                                                                     java.lang.String attributeName)

updateItemAttribute

com.amazonaws.services.dynamodbv2.model.UpdateItemResult updateItemAttribute(java.lang.Object hashKey,
                                                                             java.lang.Object rangeKey,
                                                                             java.lang.String attributeName,
                                                                             java.lang.Object attributeValue,
                                                                             com.amazonaws.services.dynamodbv2.model.AttributeAction action)

Update a single item attribute

Parameters:

hashKey -

rangeKey -

attributeName -

attributeValue -

action -

Returns:

updateItemAttribute

default com.amazonaws.services.dynamodbv2.model.UpdateItemResult updateItemAttribute(java.lang.Object hashKey,
                                                                                     java.lang.Object rangeKey,
                                                                                     java.lang.String attributeName,
                                                                                     java.lang.Object attributeValue)

Update a single item attribute

Parameters:

hashKey -

rangeKey -

attributeName -

attributeValue -

Returns:

isIndexRangeKey

boolean isIndexRangeKey(java.lang.String rangeName)

getHashKeyName

java.lang.String getHashKeyName()

getHashKeyClass

java.lang.Class<?> getHashKeyClass()

getRangeKeyName

java.lang.String getRangeKeyName()

getRangeKeyClass

java.lang.Class<?> getRangeKeyClass()