Class DynamoDbTemplate

java.lang.Object

io.awspring.spring.data.dynamodb.core.DynamoDbAccessor

io.awspring.spring.data.dynamodb.core.DynamoDbTemplate

All Implemented Interfaces:

DynamoDbOperations, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware

public class DynamoDbTemplate
extends DynamoDbAccessor
implements DynamoDbOperations, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware

Default DynamoDbOperations implementation backed by an AWS SDK DynamoDbClient.

Since:

1.0.0

Author:

Matej Nedic

Constructor Summary

Constructors

Constructor	Description
DynamoDbTemplate(software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient, DynamoDbConverter converter)	Creates a template.

Method Summary

Modifier and Type	Method	Description
<T> long	count(Class<T> entityClass)	Counts every item visible through the entity mapping.
<T> long	count(Class<T> entityClass, DynamoDbQueryRequest queryRequest)	Counts items matching a query request.
<T> long	count(Class<T> entityClass, DynamoDbScanRequest scanRequest)	Counts items matching a scan request.
<T> void	delete(Class<T> entityClass, Object primaryKey, @Nullable Object sortKey)	Deletes an item by partition and optional sort key.
<T> void	delete(Class<T> entityClass, Object primaryKey, @Nullable Object sortKey, DynamoDbConditionRequest dynamoDBConditionRequest)	Deletes an item by key when the condition succeeds.
void	delete(Object entity)	Deletes the supplied entity.
<T> EntityReadResult<List<T>>	executeStatement(String statement, String nextToken, Class<T> entityClass)	Executes a PartiQL statement without positional values.
<T> EntityReadResult<List<T>>	executeStatement(String statement, String nextToken, Class<T> entityClass, List<Object> values)	Executes a PartiQL statement with positional values.
<T> EntityReadResult<List<T>>	executeStatement(String statement, String nextToken, Class<T> entityClass, List<Object> values, Boolean consistentRead)	Executes a PartiQL statement with positional values and explicit read consistency.
<T> boolean	exists(Class<T> entityClass, DynamoDbQueryRequest queryRequest)	Checks whether a query has at least one match.
<T> boolean	exists(Class<T> entityClass, DynamoDbScanRequest scanRequest)	Checks whether a scan has at least one match.
<T> boolean	existsById(Object partitionKey, @Nullable Object sortKey, Class<T> entityClass)	Checks whether an item exists without converting it.
<T> List<T>	findAll(Class<T> entityClass)	Reads all items visible through the entity mapping.
<T> @Nullable T	findById(Object partitionKey, @Nullable Object sortKey, Class<T> entityClass)	Finds an item by its partition and optional sort key.
<T> @Nullable T	findById(Object partitionKey, @Nullable Object sortKey, Class<T> entityClass, Boolean consistentRead)	Finds an item by both keys with explicit read consistency.
<T> @Nullable T	findById(Object id, Class<T> entityClass)	Finds an item by its partition key.
<T> @Nullable T	findById(Object id, Class<T> entityClass, Boolean consistentRead)	Finds an item by its partition key with explicit read consistency.
DynamoDbConverter	getConverter()
protected EntityOperations	getEntityOperations()
String	getTableName(Class<?> entityClass)
<T> EntityWriteResult<T>	insert(T entity)	Inserts an entity and fails if its key already exists.
protected <T> T	maybeCallAfterConvert(T object, String tableName)
protected <T> T	maybeCallAfterSave(T object, String tableName)
protected <T> T	maybeCallBeforeConvert(T object, String tableName)
protected <T> T	maybeCallBeforeSave(T object, String tableName)
protected <E extends DynamoDbMappingEvent<T>, T> void	maybeEmitEvent(E event)
<T> EntityQueryResult<List<T>>	query(Class<T> entityClass, DynamoDbQueryRequest qr, DynamoDbPageRequest dynamoDBPageRequest)	Executes one DynamoDB query page.
<T> IndexQueryBuilder<T>	query(Class<T> entityClass, String indexName)	Starts a typed query against the named index.
<A> EntityQueryResult<A>	queryItemCollection(Class<A> viewClass, DynamoDbQueryRequest dynamoDbRequest, DynamoDbPageRequest dynamoDBPageRequest)	Queries and folds one DynamoDB page into an item-collection view.
<T> EntityWriteResult<T>	save(T entity)	Saves an entity with PutItem.
<T> EntityWriteResult<T>	save(T entity, DynamoDbConditionRequest dynamoDBConditionRequest)	Saves an entity with a conditional PutItem.
<T> Iterable<T>	saveAll(Iterable<? extends T> entities)	Saves entities with chunked BatchWriteItem requests.
<T> EntityQueryResult<List<T>>	scan(Class<T> entityClass, DynamoDbScanRequest scanRequest)	Executes one DynamoDB scan page.
<T> EntityQueryResult<List<T>>	searchVectors(Class<T> entityClass, DynamoDbVectorSearchRequest request)	Executes one DynamoDB vector similarity search, most similar result first.
void	setApplicationContext(@Nullable org.springframework.context.ApplicationContext applicationContext)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setBatchWriteBackOff(org.springframework.util.backoff.BackOff batchWriteBackOff)
void	setEntityCallbacks(@Nullable EntityCallbacks entityCallbacks)
<T> EntityWriteResult<T>	update(Object partitionKey, @Nullable Object sortKey, DynamoDbUpdateExpressionRequestInterface builderInterface, Class<T> entityClass)	Updates an item with a fluent update-expression callback.
<T> EntityWriteResult<T>	update(Object partitionKey, @Nullable Object sortKey, DynamoDbUpdateExpressionRequest dynamoDBUpdateExpressionRequest, Class<T> entityClass)	Updates an item with an explicit update request.
<T> EntityWriteResult<T>	update(T entity)	Updates an item from the supplied entity state.
protected void	waitBeforeRetry(long millis)

Methods inherited from class DynamoDbAccessor

afterPropertiesSet, getDynamoDbClient, getExceptionTranslator, setDynamoDbClient, setExceptionTranslator, translate

Methods inherited from class Object

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

Constructor Details

DynamoDbTemplate

public DynamoDbTemplate(software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient,
 DynamoDbConverter converter)

Creates a template.

Parameters:

dynamoDbClient - AWS SDK client

converter - entity converter

Method Details

setApplicationContext

public void setApplicationContext(@Nullable org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

setApplicationEventPublisher

public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface org.springframework.context.ApplicationEventPublisherAware

setEntityCallbacks

public void setEntityCallbacks(@Nullable EntityCallbacks entityCallbacks)

maybeEmitEvent

protected <E extends DynamoDbMappingEvent<T>, T>
void maybeEmitEvent(E event)

setBatchWriteBackOff

public void setBatchWriteBackOff(org.springframework.util.backoff.BackOff batchWriteBackOff)

saveAll

public <T> Iterable<T> saveAll(Iterable<? extends T> entities)

Description copied from interface: DynamoDbOperations

Saves entities with chunked BatchWriteItem requests.

Specified by:

saveAll in interface DynamoDbOperations

waitBeforeRetry

protected void waitBeforeRetry(long millis)

findById

public <T> @Nullable T findById(Object id,
 Class<T> entityClass)

Description copied from interface: DynamoDbOperations

Finds an item by its partition key.

Specified by:

findById in interface DynamoDbOperations

findById

public <T> @Nullable T findById(Object partitionKey,
 @Nullable Object sortKey,
 Class<T> entityClass)

Description copied from interface: DynamoDbOperations

Finds an item by its partition and optional sort key.

Specified by:

findById in interface DynamoDbOperations

findById

public <T> @Nullable T findById(Object partitionKey,
 @Nullable Object sortKey,
 Class<T> entityClass,
 Boolean consistentRead)

Description copied from interface: DynamoDbOperations

Finds an item by both keys with explicit read consistency.

Specified by:

findById in interface DynamoDbOperations

findById

public <T> @Nullable T findById(Object id,
 Class<T> entityClass,
 Boolean consistentRead)

Description copied from interface: DynamoDbOperations

Finds an item by its partition key with explicit read consistency.

Specified by:

findById in interface DynamoDbOperations

existsById

public <T> boolean existsById(Object partitionKey,
 @Nullable Object sortKey,
 Class<T> entityClass)

Description copied from interface: DynamoDbOperations

Checks whether an item exists without converting it.

Specified by:

existsById in interface DynamoDbOperations

save

public <T> EntityWriteResult<T> save(T entity)

Description copied from interface: DynamoDbOperations

Saves an entity with PutItem.

Specified by:

save in interface DynamoDbOperations

save

public <T> EntityWriteResult<T> save(T entity,
 DynamoDbConditionRequest dynamoDBConditionRequest)

Description copied from interface: DynamoDbOperations

Saves an entity with a conditional PutItem.

Specified by:

save in interface DynamoDbOperations

insert

public <T> EntityWriteResult<T> insert(T entity)

Description copied from interface: DynamoDbOperations

Inserts an entity and fails if its key already exists.

Specified by:

insert in interface DynamoDbOperations

delete

public void delete(Object entity)

Description copied from interface: DynamoDbOperations

Deletes the supplied entity.

Specified by:

delete in interface DynamoDbOperations

delete

public <T> void delete(Class<T> entityClass,
 Object primaryKey,
 @Nullable Object sortKey)

Description copied from interface: DynamoDbOperations

Deletes an item by partition and optional sort key.

Specified by:

delete in interface DynamoDbOperations

delete

public <T> void delete(Class<T> entityClass,
 Object primaryKey,
 @Nullable Object sortKey,
 DynamoDbConditionRequest dynamoDBConditionRequest)

Description copied from interface: DynamoDbOperations

Deletes an item by key when the condition succeeds.

Specified by:

delete in interface DynamoDbOperations

getConverter

public DynamoDbConverter getConverter()

Specified by:

getConverter in interface DynamoDbOperations

Returns:

the converter used by these operations

query

public <T> EntityQueryResult<List<T>> query(Class<T> entityClass,
 DynamoDbQueryRequest qr,
 DynamoDbPageRequest dynamoDBPageRequest)

Description copied from interface: DynamoDbOperations

Executes one DynamoDB query page.

Specified by:

query in interface DynamoDbOperations

searchVectors

public <T> EntityQueryResult<List<T>> searchVectors(Class<T> entityClass,
 DynamoDbVectorSearchRequest request)

Description copied from interface: DynamoDbOperations

Executes one DynamoDB vector similarity search, most similar result first.

Specified by:

searchVectors in interface DynamoDbOperations

queryItemCollection

public <A> EntityQueryResult<A> queryItemCollection(Class<A> viewClass,
 DynamoDbQueryRequest dynamoDbRequest,
 DynamoDbPageRequest dynamoDBPageRequest)

Description copied from interface: DynamoDbOperations

Queries and folds one DynamoDB page into an item-collection view.

Specified by:

queryItemCollection in interface DynamoDbOperations

Returns:

the folded page, count, and optional continuation cursor

scan

public <T> EntityQueryResult<List<T>> scan(Class<T> entityClass,
 DynamoDbScanRequest scanRequest)

Description copied from interface: DynamoDbOperations

Executes one DynamoDB scan page.

Specified by:

scan in interface DynamoDbOperations

executeStatement

public <T> EntityReadResult<List<T>> executeStatement(String statement,
 String nextToken,
 Class<T> entityClass,
 List<Object> values)

Description copied from interface: DynamoDbOperations

Executes a PartiQL statement with positional values.

Specified by:

executeStatement in interface DynamoDbOperations

executeStatement

public <T> EntityReadResult<List<T>> executeStatement(String statement,
 String nextToken,
 Class<T> entityClass)

Description copied from interface: DynamoDbOperations

Executes a PartiQL statement without positional values.

Specified by:

executeStatement in interface DynamoDbOperations

executeStatement

public <T> EntityReadResult<List<T>> executeStatement(String statement,
 String nextToken,
 Class<T> entityClass,
 List<Object> values,
 Boolean consistentRead)

Description copied from interface: DynamoDbOperations

Executes a PartiQL statement with positional values and explicit read consistency.

Specified by:

executeStatement in interface DynamoDbOperations

update

public <T> EntityWriteResult<T> update(T entity)

Description copied from interface: DynamoDbOperations

Updates an item from the supplied entity state.

Specified by:

update in interface DynamoDbOperations

update

public <T> EntityWriteResult<T> update(Object partitionKey,
 @Nullable Object sortKey,
 DynamoDbUpdateExpressionRequest dynamoDBUpdateExpressionRequest,
 Class<T> entityClass)

Description copied from interface: DynamoDbOperations

Updates an item with an explicit update request.

Specified by:

update in interface DynamoDbOperations

update

public <T> EntityWriteResult<T> update(Object partitionKey,
 @Nullable Object sortKey,
 DynamoDbUpdateExpressionRequestInterface builderInterface,
 Class<T> entityClass)

Description copied from interface: DynamoDbOperations

Updates an item with a fluent update-expression callback.

Specified by:

update in interface DynamoDbOperations

getTableName

public String getTableName(Class<?> entityClass)

Specified by:

getTableName in interface DynamoDbOperations

Returns:

the resolved physical table name for the entity

count

public <T> long count(Class<T> entityClass)

Description copied from interface: DynamoDbOperations

Counts every item visible through the entity mapping.

Specified by:

count in interface DynamoDbOperations

count

public <T> long count(Class<T> entityClass,
 DynamoDbScanRequest scanRequest)

Description copied from interface: DynamoDbOperations

Counts items matching a scan request.

Specified by:

count in interface DynamoDbOperations

exists

public <T> boolean exists(Class<T> entityClass,
 DynamoDbScanRequest scanRequest)

Description copied from interface: DynamoDbOperations

Checks whether a scan has at least one match.

Specified by:

exists in interface DynamoDbOperations

count

public <T> long count(Class<T> entityClass,
 DynamoDbQueryRequest queryRequest)

Description copied from interface: DynamoDbOperations

Counts items matching a query request.

Specified by:

count in interface DynamoDbOperations

exists

public <T> boolean exists(Class<T> entityClass,
 DynamoDbQueryRequest queryRequest)

Description copied from interface: DynamoDbOperations

Checks whether a query has at least one match.

Specified by:

exists in interface DynamoDbOperations

findAll

public <T> List<T> findAll(Class<T> entityClass)

Description copied from interface: DynamoDbOperations

Reads all items visible through the entity mapping.

Specified by:

findAll in interface DynamoDbOperations

getEntityOperations

protected EntityOperations getEntityOperations()

maybeCallBeforeConvert

protected <T> T maybeCallBeforeConvert(T object,
 String tableName)

maybeCallBeforeSave

protected <T> T maybeCallBeforeSave(T object,
 String tableName)

maybeCallAfterSave

protected <T> T maybeCallAfterSave(T object,
 String tableName)

maybeCallAfterConvert

protected <T> T maybeCallAfterConvert(T object,
 String tableName)

query

public <T> IndexQueryBuilder<T> query(Class<T> entityClass,
 String indexName)

Description copied from interface: DynamoDbOperations

Starts a typed query against the named index.

Specified by:

query in interface DynamoDbOperations