Package software.amazon.awssdk.services.dynamodb.datamodeling

Interface IDynamoDbMapper

All Known Implementing Classes:

AbstractDynamoDbMapper, DynamoDbMapper

public interface IDynamoDbMapper

Interface for DynamoDBMapper.

Note: Do not implement this interface, extend from AbstractDynamoDbMapper instead.

See Also:

DynamoDbMapper, AbstractDynamoDbMapper

Method Summary

Modifier and Type	Method	Description
List<DynamoDbMapper.FailedBatch>	batchDelete(Iterable<? extends Object> objectsToDelete)	Deletes the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.
List<DynamoDbMapper.FailedBatch>	batchDelete(Object... objectsToDelete)	Deletes the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.
Map<String,List<Object>>	batchLoad(Iterable<? extends Object> itemsToGet)	Retrieves multiple items from multiple tables using their primary keys.
Map<String,List<Object>>	batchLoad(Iterable<? extends Object> itemsToGet, DynamoDbMapperConfig config)	Retrieves multiple items from multiple tables using their primary keys.
Map<String,List<Object>>	batchLoad(Map<Class<?>,List<KeyPair>> itemsToGet)	Retrieves the attributes for multiple items from multiple tables using their primary keys.
Map<String,List<Object>>	batchLoad(Map<Class<?>,List<KeyPair>> itemsToGet, DynamoDbMapperConfig config)	Retrieves multiple items from multiple tables using their primary keys.
List<DynamoDbMapper.FailedBatch>	batchSave(Iterable<? extends Object> objectsToSave)	Saves the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.
List<DynamoDbMapper.FailedBatch>	batchSave(Object... objectsToSave)	Saves the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.
List<DynamoDbMapper.FailedBatch>	batchWrite(Iterable<? extends Object> objectsToWrite, Iterable<? extends Object> objectsToDelete)	Saves and deletes the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.
List<DynamoDbMapper.FailedBatch>	batchWrite(Iterable<? extends Object> objectsToWrite, Iterable<? extends Object> objectsToDelete, DynamoDbMapperConfig config)	Saves and deletes the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.
int	count(Class<?> clazz, DynamoDbScanExpression scanExpression)	Evaluates the specified scan expression and returns the count of matching items, without returning any of the actual item data, using the default configuration.
int	count(Class<?> clazz, DynamoDbScanExpression scanExpression, DynamoDbMapperConfig config)	Evaluates the specified scan expression and returns the count of matching items, without returning any of the actual item data.
<T> int	count(Class<T> clazz, DynamoDbQueryExpression<T> queryExpression)	Evaluates the specified query expression and returns the count of matching items, without returning any of the actual item data, using the default configuration.
<T> int	count(Class<T> clazz, DynamoDbQueryExpression<T> queryExpression, DynamoDbMapperConfig config)	Evaluates the specified query expression and returns the count of matching items, without returning any of the actual item data.
S3Link	createS3Link(String bucketName, String key)	Creates an S3Link with the specified bucket name and key using the default S3 region.
S3Link	createS3Link(String s3region, String bucketName, String key)	Creates an S3Link with the specified region, bucket name and key.
S3Link	createS3Link(Region s3region, String bucketName, String key)	Creates an S3Link with the specified region, bucket name and key.
void	delete(Object object)	Deletes the given object from its DynamoDB table using the default configuration.
void	delete(Object object, DynamoDbDeleteExpression deleteExpression)	Deletes the given object from its DynamoDB table using the specified deleteExpression and default configuration.
void	delete(Object object, DynamoDbMapperConfig config)	Deletes the given object from its DynamoDB table using the specified configuration.
<T> void	delete(T object, DynamoDbDeleteExpression deleteExpression, DynamoDbMapperConfig config)	Deletes the given object from its DynamoDB table using the provided deleteExpression and provided configuration.
CreateTableRequest	generateCreateTableRequest(Class<?> clazz)	Parse the given POJO class and return the CreateTableRequest for the DynamoDB table it represents.
DeleteTableRequest	generateDeleteTableRequest(Class<?> clazz)	Parse the given POJO class and return the DeleteTableRequest for the DynamoDB table it represents.
<T> DynamoDbMapperTableModel<T>	getTableModel(Class<T> clazz)	Get the table model for the class, using the default configuration.
<T> DynamoDbMapperTableModel<T>	getTableModel(Class<T> clazz, DynamoDbMapperConfig config)	Get the table model for the class using the provided configuration override.
<T> T	load(Class<T> clazz, Object hashKey)	Loads an object with the hash key given, using the default configuration.
<T> T	load(Class<T> clazz, Object hashKey, Object rangeKey)	Loads an object with a hash and range key, using the default configuration.
<T> T	load(Class<T> clazz, Object hashKey, Object rangeKey, DynamoDbMapperConfig config)	Returns an object with the given hash key, or null if no such object exists.
<T> T	load(Class<T> clazz, Object hashKey, DynamoDbMapperConfig config)	Loads an object with the hash key given and a configuration override.
<T> T	load(T keyObject)	Returns an object whose keys match those of the prototype key object given, or null if no such item exists.
<T> T	load(T keyObject, DynamoDbMapperConfig config)	Returns an object whose keys match those of the prototype key object given, or null if no such item exists.
<T> T	marshallIntoObject(Class<T> clazz, Map<String,AttributeValue> itemAttributes)	Creates and fills in the attributes on an instance of the class given with the attributes given.
<T> List<T>	marshallIntoObjects(Class<T> clazz, List<Map<String,AttributeValue>> itemAttributes)	Unmarshalls the list of item attributes into objects of type clazz.
<T> PaginatedParallelScanList<T>	parallelScan(Class<T> clazz, DynamoDbScanExpression scanExpression, int totalSegments)	Scans through an Amazon DynamoDB table on logically partitioned segments in parallel and returns the matching results in one unmodifiable list of instantiated objects, using the default configuration.
<T> PaginatedParallelScanList<T>	parallelScan(Class<T> clazz, DynamoDbScanExpression scanExpression, int totalSegments, DynamoDbMapperConfig config)	Scans through an Amazon DynamoDB table on logically partitioned segments in parallel.
<T> PaginatedQueryList<T>	query(Class<T> clazz, DynamoDbQueryExpression<T> queryExpression)	Queries an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects, using the default configuration.
<T> PaginatedQueryList<T>	query(Class<T> clazz, DynamoDbQueryExpression<T> queryExpression, DynamoDbMapperConfig config)	Queries an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects.
<T> QueryResultPage<T>	queryPage(Class<T> clazz, DynamoDbQueryExpression<T> queryExpression)	Queries an Amazon DynamoDB table and returns a single page of matching results.
<T> QueryResultPage<T>	queryPage(Class<T> clazz, DynamoDbQueryExpression<T> queryExpression, DynamoDbMapperConfig config)	Queries an Amazon DynamoDB table and returns a single page of matching results.
S3ClientCache	s3ClientCache()	Returns the underlying S3ClientCache for accessing S3.
<T> void	save(T object)	Saves the object given into DynamoDB, using the default configuration.
<T> void	save(T object, DynamoDbMapperConfig config)	Saves the object given into DynamoDB, using the specified configuration.
<T> void	save(T object, DynamoDbSaveExpression saveExpression)	Saves the object given into DynamoDB, using the default configuration and the specified saveExpression.
<T> void	save(T object, DynamoDbSaveExpression saveExpression, DynamoDbMapperConfig config)	Saves an item in DynamoDB.
<T> PaginatedScanList<T>	scan(Class<T> clazz, DynamoDbScanExpression scanExpression)	Scans through an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects, using the default configuration.
<T> PaginatedScanList<T>	scan(Class<T> clazz, DynamoDbScanExpression scanExpression, DynamoDbMapperConfig config)	Scans through an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects.
<T> ScanResultPage<T>	scanPage(Class<T> clazz, DynamoDbScanExpression scanExpression)	Scans through an Amazon DynamoDB table and returns a single page of matching results.
<T> ScanResultPage<T>	scanPage(Class<T> clazz, DynamoDbScanExpression scanExpression, DynamoDbMapperConfig config)	Scans through an Amazon DynamoDB table and returns a single page of matching results.

Method Detail

getTableModel

<T> DynamoDbMapperTableModel<T> getTableModel(Class<T> clazz)

Get the table model for the class, using the default configuration.

See Also:

DynamoDbMapper.getTableModel(Class, DynamoDbMapperConfig)

getTableModel

<T> DynamoDbMapperTableModel<T> getTableModel(Class<T> clazz,
                                              DynamoDbMapperConfig config)

Get the table model for the class using the provided configuration override.

load

<T> T load(Class<T> clazz,
           Object hashKey,
           DynamoDbMapperConfig config)

Loads an object with the hash key given and a configuration override. This configuration overrides the default provided at object construction.

See Also:

DynamoDbMapper.load(Class, Object, Object, DynamoDbMapperConfig)

load

<T> T load(Class<T> clazz,
           Object hashKey)

Loads an object with the hash key given, using the default configuration.

See Also:

DynamoDbMapper.load(Class, Object, Object, DynamoDbMapperConfig)

load

<T> T load(Class<T> clazz,
           Object hashKey,
           Object rangeKey)

Loads an object with a hash and range key, using the default configuration.

See Also:

DynamoDbMapper.load(Class, Object, Object, DynamoDbMapperConfig)

load

<T> T load(T keyObject)

Returns an object whose keys match those of the prototype key object given, or null if no such item exists.

Parameters:

keyObject - An object of the class to load with the keys values to match.

See Also:

DynamoDbMapper.load(Object, DynamoDbMapperConfig)

load

<T> T load(T keyObject,
           DynamoDbMapperConfig config)

Returns an object whose keys match those of the prototype key object given, or null if no such item exists.

Parameters:

keyObject - An object of the class to load with the keys values to match.

config - Configuration for the service call to retrieve the object from DynamoDB. This configuration overrides the default given at construction.

load

<T> T load(Class<T> clazz,
           Object hashKey,
           Object rangeKey,
           DynamoDbMapperConfig config)

Returns an object with the given hash key, or null if no such object exists.

Parameters:

clazz - The class to load, corresponding to a DynamoDB table.

hashKey - The key of the object.

rangeKey - The range key of the object, or null for tables without a range key.

config - Configuration for the service call to retrieve the object from DynamoDB. This configuration overrides the default given at construction.

marshallIntoObject

<T> T marshallIntoObject(Class<T> clazz,
                         Map<String,AttributeValue> itemAttributes)

Creates and fills in the attributes on an instance of the class given with the attributes given.

This is accomplished by looking for getter methods annotated with an appropriate annotation, then looking for matching attribute names in the item attribute map.

This method is no longer called by load/scan/query methods. If you are overriding this method, please switch to using an AttributeTransformer

Parameters:

clazz - The class to instantiate and hydrate

itemAttributes - The set of item attributes, keyed by attribute name.

marshallIntoObjects

<T> List<T> marshallIntoObjects(Class<T> clazz,
                                List<Map<String,AttributeValue>> itemAttributes)

Unmarshalls the list of item attributes into objects of type clazz.

This method is no longer called by load/scan/query methods. If you are overriding this method, please switch to using an AttributeTransformer

See Also:

AbstractDynamoDbMapper.marshallIntoObject(Class, Map)

save

<T> void save(T object)

Saves the object given into DynamoDB, using the default configuration.

See Also:

DynamoDbMapper.save(Object, DynamoDbSaveExpression, DynamoDbMapperConfig)

save

<T> void save(T object,
              DynamoDbSaveExpression saveExpression)

Saves the object given into DynamoDB, using the default configuration and the specified saveExpression.

See Also:

DynamoDbMapper.save(Object, DynamoDbSaveExpression, DynamoDbMapperConfig)

save

<T> void save(T object,
              DynamoDbMapperConfig config)

Saves the object given into DynamoDB, using the specified configuration.

See Also:

DynamoDbMapper.save(Object, DynamoDbSaveExpression, DynamoDbMapperConfig)

save

<T> void save(T object,
              DynamoDbSaveExpression saveExpression,
              DynamoDbMapperConfig config)

Saves an item in DynamoDB. The service method used is determined by the DynamoDbMapperConfig.saveBehavior() value, to use either DynamoDBClient.putItem(PutItemRequest) or DynamoDBClient.updateItem(UpdateItemRequest):

• UPDATE (default) : UPDATE will not affect unmodeled attributes on a save operation and a null value for the modeled attribute will remove it from that item in DynamoDB. Because of the limitation of updateItem request, the implementation of UPDATE will send a putItem request when a key-only object is being saved, and it will send another updateItem request if the given key(s) already exists in the table.
• UPDATE_SKIP_NULL_ATTRIBUTES : Similar to UPDATE except that it ignores any null value attribute(s) and will NOT remove them from that item in DynamoDB. It also guarantees to send only one single updateItem request, no matter the object is key-only or not.
• CLOBBER : CLOBBER will clear and replace all attributes, included unmodeled ones, (delete and recreate) on save. Versioned field constraints will also be disregarded.

Any options specified in the saveExpression parameter will be overlaid on any constraints due to versioned attributes.

Parameters:

object - The object to save into DynamoDB

saveExpression - The options to apply to this save request

config - The configuration to use, which overrides the default provided at object construction.

See Also:

DynamoDbMapperConfig.SaveBehavior

delete

void delete(Object object)

Deletes the given object from its DynamoDB table using the default configuration.

delete

void delete(Object object,
            DynamoDbDeleteExpression deleteExpression)

Deletes the given object from its DynamoDB table using the specified deleteExpression and default configuration.

delete

void delete(Object object,
            DynamoDbMapperConfig config)

Deletes the given object from its DynamoDB table using the specified configuration.

delete

<T> void delete(T object,
                DynamoDbDeleteExpression deleteExpression,
                DynamoDbMapperConfig config)

Deletes the given object from its DynamoDB table using the provided deleteExpression and provided configuration. Any options specified in the deleteExpression parameter will be overlaid on any constraints due to versioned attributes.

Parameters:

deleteExpression - The options to apply to this delete request

config - Config override object. If DynamoDbMapperConfig.SaveBehavior.CLOBBER is supplied, version fields will not be considered when deleting the object.

batchDelete

List<DynamoDbMapper.FailedBatch> batchDelete(Iterable<? extends Object> objectsToDelete)

Deletes the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API. No version checks are performed, as required by the API.

See Also:

AbstractDynamoDbMapper.batchWrite(Iterable, Iterable)

batchDelete

List<DynamoDbMapper.FailedBatch> batchDelete(Object... objectsToDelete)

Deletes the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API. No version checks are performed, as required by the API.

See Also:

AbstractDynamoDbMapper.batchWrite(Iterable, Iterable)

batchSave

List<DynamoDbMapper.FailedBatch> batchSave(Iterable<? extends Object> objectsToSave)

Saves the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API. No version checks are performed, as required by the API.

This method ignores any SaveBehavior set on the mapper, and always behaves as if SaveBehavior.CLOBBER was specified, as the DynamoDBClient.batchWriteItem() request does not support updating existing items.

This method fails to save the batch if the size of an individual object in the batch exceeds 400 KB. For more information on batch restrictions see, http://docs.aws.amazon .com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html

See Also:

AbstractDynamoDbMapper.batchWrite(Iterable, Iterable)

batchSave

List<DynamoDbMapper.FailedBatch> batchSave(Object... objectsToSave)

Saves the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API. No version checks are performed, as required by the API.

This method ignores any SaveBehavior set on the mapper, and always behaves as if SaveBehavior.CLOBBER was specified, as the DynamoDBClient.batchWriteItem() request does not support updating existing items. *

This method fails to save the batch if the size of an individual object in the batch exceeds 400 KB. For more information on batch restrictions see, http://docs.aws.amazon .com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html

See Also:

AbstractDynamoDbMapper.batchWrite(Iterable, Iterable)

batchWrite

List<DynamoDbMapper.FailedBatch> batchWrite(Iterable<? extends Object> objectsToWrite,
                                            Iterable<? extends Object> objectsToDelete)

Saves and deletes the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API. No version checks are performed, as required by the API.

This method ignores any SaveBehavior set on the mapper, and always behaves as if SaveBehavior.CLOBBER was specified, as the DynamoDBClient.batchWriteItem() request does not support updating existing items.

This method fails to save the batch if the size of an individual object in the batch exceeds 400 KB. For more information on batch restrictions see, http://docs.aws.amazon .com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html

If one of the write requests is for a table that is not present, this method does not throw a ResourceNotFoundException but returns a FailedBatch which includes this exception and the unprocessed items.

See Also:

AbstractDynamoDbMapper.batchWrite(Iterable, Iterable)

batchWrite

List<DynamoDbMapper.FailedBatch> batchWrite(Iterable<? extends Object> objectsToWrite,
                                            Iterable<? extends Object> objectsToDelete,
                                            DynamoDbMapperConfig config)

Saves and deletes the objects given using one or more calls to the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API. Use mapper config to control the retry strategy when UnprocessedItems are returned by the BatchWriteItem API

This method fails to save the batch if the size of an individual object in the batch exceeds 400 KB. For more information on batch restrictions see, http://docs.aws.amazon .com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html

If one of the write requests is for a table that is not present, this method does not throw a ResourceNotFoundException but returns a FailedBatch which includes this exception and the unprocessed items.

Parameters:

objectsToWrite - A list of objects to save to DynamoDB. No version checks are performed, as required by the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.

objectsToDelete - A list of objects to delete from DynamoDB. No version checks are performed, as required by the DynamoDBClient.batchWriteItem(BatchWriteItemRequest) API.

config - Only DynamoDbMapperConfig.getTableNameOverride() and DynamoDbMapperConfig.batchWriteRetryStrategy() are considered. If TableNameOverride is specified, all objects in the two parameter lists will be considered to belong to the given table override. In particular, this method always acts as if SaveBehavior.CLOBBER was specified regardless of the value of the config parameter.

Returns:

A list of failed batches which includes the unprocessed items and the exceptions causing the failure.

See Also:

DynamoDbMapperConfig.getTableNameOverride(), DynamoDbMapperConfig.batchWriteRetryStrategy()

batchLoad

Map<String,List<Object>> batchLoad(Iterable<? extends Object> itemsToGet)

Retrieves multiple items from multiple tables using their primary keys.

Returns:

A map of the loaded objects. Each key in the map is the name of a DynamoDB table. Each value in the map is a list of objects that have been loaded from that table. All objects for each table can be cast to the associated user defined type that is annotated as mapping that table.

Throws:

DynamoDbMapper.BatchGetItemException - if all the requested items are not processed within the maximum number of retries.

See Also:

DynamoDbMapper#batchLoad(List, DynamoDbMapperConfig)

batchLoad

Map<String,List<Object>> batchLoad(Iterable<? extends Object> itemsToGet,
                                   DynamoDbMapperConfig config)

Retrieves multiple items from multiple tables using their primary keys.

Parameters:

itemsToGet - Key objects, corresponding to the class to fetch, with their primary key values set.

config - Only DynamoDbMapperConfig.getTableNameOverride() and DynamoDbMapperConfig.getConsistentReads() are considered.

Returns:

A map of the loaded objects. Each key in the map is the name of a DynamoDB table. Each value in the map is a list of objects that have been loaded from that table. All objects for each table can be cast to the associated user defined type that is annotated as mapping that table.

Throws:

DynamoDbMapper.BatchGetItemException - if all the requested items are not processed within the maximum number of retries.

batchLoad

Map<String,List<Object>> batchLoad(Map<Class<?>,List<KeyPair>> itemsToGet)

Retrieves the attributes for multiple items from multiple tables using their primary keys. DynamoDBClient.batchGetItem(BatchGetItemRequest) API.

Returns:

A map of the loaded objects. Each key in the map is the name of a DynamoDB table. Each value in the map is a list of objects that have been loaded from that table. All objects for each table can be cast to the associated user defined type that is annotated as mapping that table.

Throws:

DynamoDbMapper.BatchGetItemException - if all the requested items are not processed within the maximum number of retries.

See Also:

#batchLoad(List, DynamoDbMapperConfig), batchLoad(Map, DynamoDbMapperConfig)

batchLoad

Map<String,List<Object>> batchLoad(Map<Class<?>,List<KeyPair>> itemsToGet,
                                   DynamoDbMapperConfig config)

Retrieves multiple items from multiple tables using their primary keys. Valid only for tables with a single hash key, or a single hash and range key. For other schemas, use DynamoDbMapper#batchLoad(List, DynamoDbMapperConfig)

Parameters:

itemsToGet - Map from class to load to list of primary key attributes.

config - Only DynamoDbMapperConfig.getTableNameOverride() and DynamoDbMapperConfig.getConsistentReads() are considered.

Returns:

A map of the loaded objects. Each key in the map is the name of a DynamoDB table. Each value in the map is a list of objects that have been loaded from that table. All objects for each table can be cast to the associated user defined type that is annotated as mapping that table.

Throws:

DynamoDbMapper.BatchGetItemException - if all the requested items are not processed within the maximum number of retries.

scan

<T> PaginatedScanList<T> scan(Class<T> clazz,
                              DynamoDbScanExpression scanExpression)

Scans through an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects, using the default configuration.

See Also:

DynamoDbMapper.scan(Class, DynamoDbScanExpression, DynamoDbMapperConfig)

scan

<T> PaginatedScanList<T> scan(Class<T> clazz,
                              DynamoDbScanExpression scanExpression,
                              DynamoDbMapperConfig config)

Scans through an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects. The table to scan is determined by looking at the annotations on the specified class, which declares where to store the object data in Amazon DynamoDB, and the scan expression parameter allows the caller to filter results and control how the scan is executed.

Callers should be aware that the returned list is unmodifiable, and any attempts to modify the list will result in an UnsupportedOperationException.

You can specify the pagination loading strategy for this scan operation. By default, the list returned is lazily loaded when possible.

Type Parameters:

T - The type of the objects being returned.

Parameters:

clazz - The class annotated with DynamoDB annotations describing how to store the object data in Amazon DynamoDB.

scanExpression - Details on how to run the scan, including any filters to apply to limit results.

config - The configuration to use for this scan, which overrides the default provided at object construction.

Returns:

An unmodifiable list of the objects constructed from the results of the scan operation.

See Also:

PaginatedScanList, DynamoDbMapperConfig.PaginationLoadingStrategy

parallelScan

<T> PaginatedParallelScanList<T> parallelScan(Class<T> clazz,
                                              DynamoDbScanExpression scanExpression,
                                              int totalSegments)

Scans through an Amazon DynamoDB table on logically partitioned segments in parallel and returns the matching results in one unmodifiable list of instantiated objects, using the default configuration.

See Also:

DynamoDbMapper.parallelScan(Class, DynamoDbScanExpression, int, DynamoDbMapperConfig)

parallelScan

<T> PaginatedParallelScanList<T> parallelScan(Class<T> clazz,
                                              DynamoDbScanExpression scanExpression,
                                              int totalSegments,
                                              DynamoDbMapperConfig config)

Scans through an Amazon DynamoDB table on logically partitioned segments in parallel. This method will create a thread pool of the specified size, and each thread will issue scan requests for its assigned segment, following the returned continuation token, until the end of its segment. Callers should be responsible for setting the appropriate number of total segments. More scan segments would result in better performance but more consumed capacity of the table. The results are returned in one unmodifiable list of instantiated objects. The table to scan is determined by looking at the annotations on the specified class, which declares where to store the object data in Amazon DynamoDB, and the scan expression parameter allows the caller to filter results and control how the scan is executed.

Callers should be aware that the returned list is unmodifiable, and any attempts to modify the list will result in an UnsupportedOperationException.

You can specify the pagination loading strategy for this parallel scan operation. By default, the list returned is lazily loaded when possible.

Type Parameters:

T - The type of the objects being returned.

Parameters:

clazz - The class annotated with DynamoDB annotations describing how to store the object data in Amazon DynamoDB.

scanExpression - Details on how to run the scan, including any filters to apply to limit results.

totalSegments - Number of total parallel scan segments. Range: 1 - 4096

config - The configuration to use for this scan, which overrides the default provided at object construction.

Returns:

An unmodifiable list of the objects constructed from the results of the scan operation.

See Also:

PaginatedParallelScanList, DynamoDbMapperConfig.PaginationLoadingStrategy

scanPage

<T> ScanResultPage<T> scanPage(Class<T> clazz,
                               DynamoDbScanExpression scanExpression,
                               DynamoDbMapperConfig config)

Scans through an Amazon DynamoDB table and returns a single page of matching results. The table to scan is determined by looking at the annotations on the specified class, which declares where to store the object data in AWS DynamoDB, and the scan expression parameter allows the caller to filter results and control how the scan is executed.

Type Parameters:

T - The type of the objects being returned.

Parameters:

clazz - The class annotated with DynamoDB annotations describing how to store the object data in Amazon DynamoDB.

scanExpression - Details on how to run the scan, including any filters to apply to limit results.

config - The configuration to use for this scan, which overrides the default provided at object construction.

scanPage

<T> ScanResultPage<T> scanPage(Class<T> clazz,
                               DynamoDbScanExpression scanExpression)

Scans through an Amazon DynamoDB table and returns a single page of matching results.

See Also:

DynamoDbMapper.scanPage(Class, DynamoDbScanExpression, DynamoDbMapperConfig)

query

<T> PaginatedQueryList<T> query(Class<T> clazz,
                                DynamoDbQueryExpression<T> queryExpression)

Queries an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects, using the default configuration.

See Also:

DynamoDbMapper.query(Class, DynamoDbQueryExpression, DynamoDbMapperConfig)

query

<T> PaginatedQueryList<T> query(Class<T> clazz,
                                DynamoDbQueryExpression<T> queryExpression,
                                DynamoDbMapperConfig config)

Queries an Amazon DynamoDB table and returns the matching results as an unmodifiable list of instantiated objects. The table to query is determined by looking at the annotations on the specified class, which declares where to store the object data in Amazon DynamoDB, and the query expression parameter allows the caller to filter results and control how the query is executed.

When the query is on any local/global secondary index, callers should be aware that the returned object(s) will only contain item attributes that are projected into the index. All the other unprojected attributes will be saved as type default values.

Callers should also be aware that the returned list is unmodifiable, and any attempts to modify the list will result in an UnsupportedOperationException.

You can specify the pagination loading strategy for this query operation. By default, the list returned is lazily loaded when possible.

Type Parameters:

T - The type of the objects being returned.

Parameters:

clazz - The class annotated with DynamoDB annotations describing how to store the object data in Amazon DynamoDB.

queryExpression - Details on how to run the query, including any conditions on the key values

config - The configuration to use for this query, which overrides the default provided at object construction.

Returns:

An unmodifiable list of the objects constructed from the results of the query operation.

See Also:

PaginatedQueryList, DynamoDbMapperConfig.PaginationLoadingStrategy

queryPage

<T> QueryResultPage<T> queryPage(Class<T> clazz,
                                 DynamoDbQueryExpression<T> queryExpression)

Queries an Amazon DynamoDB table and returns a single page of matching results. The table to query is determined by looking at the annotations on the specified class, which declares where to store the object data in Amazon DynamoDB, and the query expression parameter allows the caller to filter results and control how the query is executed.

See Also:

DynamoDbMapper.queryPage(Class, DynamoDbQueryExpression, DynamoDbMapperConfig)

queryPage

<T> QueryResultPage<T> queryPage(Class<T> clazz,
                                 DynamoDbQueryExpression<T> queryExpression,
                                 DynamoDbMapperConfig config)

Queries an Amazon DynamoDB table and returns a single page of matching results. The table to query is determined by looking at the annotations on the specified class, which declares where to store the object data in Amazon DynamoDB, and the query expression parameter allows the caller to filter results and control how the query is executed.

Type Parameters:

T - The type of the objects being returned.

Parameters:

clazz - The class annotated with DynamoDB annotations describing how to store the object data in AWS DynamoDB.

queryExpression - Details on how to run the query, including any conditions on the key values

config - The configuration to use for this query, which overrides the default provided at object construction.

count

int count(Class<?> clazz,
          DynamoDbScanExpression scanExpression)

Evaluates the specified scan expression and returns the count of matching items, without returning any of the actual item data, using the default configuration.

See Also:

DynamoDbMapper.count(Class, DynamoDbScanExpression, DynamoDbMapperConfig)

count

int count(Class<?> clazz,
          DynamoDbScanExpression scanExpression,
          DynamoDbMapperConfig config)

Evaluates the specified scan expression and returns the count of matching items, without returning any of the actual item data.

This operation will scan your entire table, and can therefore be very expensive. Use with caution.

Parameters:

clazz - The class mapped to a DynamoDB table.

scanExpression - The parameters for running the scan.

config - The configuration to use for this scan, which overrides the default provided at object construction.

Returns:

The count of matching items, without returning any of the actual item data.

count

<T> int count(Class<T> clazz,
              DynamoDbQueryExpression<T> queryExpression)

Evaluates the specified query expression and returns the count of matching items, without returning any of the actual item data, using the default configuration.

See Also:

DynamoDbMapper.count(Class, DynamoDbQueryExpression, DynamoDbMapperConfig)

count

<T> int count(Class<T> clazz,
              DynamoDbQueryExpression<T> queryExpression,
              DynamoDbMapperConfig config)

Evaluates the specified query expression and returns the count of matching items, without returning any of the actual item data.

Parameters:

clazz - The class mapped to a DynamoDB table.

queryExpression - The parameters for running the scan.

config - The mapper configuration to use for the query, which overrides the default provided at object construction.

Returns:

The count of matching items, without returning any of the actual item data.

s3ClientCache

S3ClientCache s3ClientCache()

Returns the underlying S3ClientCache for accessing S3.

createS3Link

S3Link createS3Link(String bucketName,
                    String key)

Creates an S3Link with the specified bucket name and key using the default S3 region. This method requires the mapper to have been initialized with the necessary credentials for accessing S3.

Throws:

IllegalStateException - if the mapper has not been constructed with the necessary S3 AWS credentials.

createS3Link

S3Link createS3Link(Region s3region,
                    String bucketName,
                    String key)

Creates an S3Link with the specified region, bucket name and key. This method requires the mapper to have been initialized with the necessary credentials for accessing S3.

Throws:

IllegalStateException - if the mapper has not been constructed with the necessary S3 AWS credentials.

createS3Link

S3Link createS3Link(String s3region,
                    String bucketName,
                    String key)

Creates an S3Link with the specified region, bucket name and key. This method requires the mapper to have been initialized with the necessary credentials for accessing S3.

Throws:

IllegalStateException - if the mapper has not been constructed with the necessary S3 AWS credentials.

generateCreateTableRequest

CreateTableRequest generateCreateTableRequest(Class<?> clazz)

Parse the given POJO class and return the CreateTableRequest for the DynamoDB table it represents. Note that the returned request does not include the required ProvisionedThroughput parameters for the primary table and the GSIs, and that all secondary indexes are initialized with the default projection type - KEY_ONLY.

generateDeleteTableRequest

DeleteTableRequest generateDeleteTableRequest(Class<?> clazz)

Parse the given POJO class and return the DeleteTableRequest for the DynamoDB table it represents.