Skip to content

Add conditional save, update and delete operation support for DynamoDB entities. Fixes #gh-1147 #1371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add conditional save, update and delete operation support for DynamoDB entities. Fixes #gh-1147 #1371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bc8c29c
Add save dynamodb entity with PutItemEnhancedRequest. Fixes gh-1147
vyomrastogi Apr 12, 2025
aba3633
Add update dynamodb entity with UpdateEnhancedItemRequest
vyomrastogi Apr 12, 2025
64f03c0
Add delete dynamodb entity conditionally with DeleteItemEnhancedRequest
vyomrastogi Apr 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions spring-cloud-aws-dynamodb/src/main/java/io/awspring/cloud/dynamodb/DynamoDbOperations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@

import org.springframework.lang.Nullable;
import software.amazon.awssdk.enhanced.dynamodb.Key;
import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.PageIterable;
import software.amazon.awssdk.enhanced.dynamodb.model.PutItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.QueryEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.ScanEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedRequest;

/**
* Interface for simple DynamoDB template operations.
Expand All @@ -37,6 +40,17 @@ public interface DynamoDbOperations {
*/
<T> T save(T entity);

/**
* Saves an item in DynamoDB using the provided PutItemEnhancedRequest.
*
* @param putItemEnhancedRequest the request object containing the item to be saved
* @param clazz the class type of the item to be saved so
* {@link software.amazon.awssdk.enhanced.dynamodb.TableSchema} can be generated.
*
* @see PutItemEnhancedRequest
*/
<T> void save(PutItemEnhancedRequest<T> putItemEnhancedRequest, Class<T> clazz);
Copy link
Author

@vyomrastogi vyomrastogi Apr 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dear Reviewers,

Here I opted to make this method void as DynamoDbTable.putItem does not return updated entity. There is possibility if someone is using extensions then the entity would have been update at db layer and hence passed entity would not hold latest state.

This deviates from set norm, so happy to adapt to maintain consistency. What's your recommendation ?


/**
* Updates Entity to DynamoDB table.
*
Expand All @@ -45,6 +59,17 @@ public interface DynamoDbOperations {
*/
<T> T update(T entity);

/**
* Updates an item in DynamoDB using the provided UpdateItemEnhancedRequest.
*
* @param updateItemEnhancedRequest the request object containing the item to be updated
* @param clazz the class type of the item to be updated so
* {@link software.amazon.awssdk.enhanced.dynamodb.TableSchema} can be generated.
*
* @see UpdateItemEnhancedRequest
*/
<T> T update(UpdateItemEnhancedRequest<T> updateItemEnhancedRequest, Class<T> clazz);

/**
* Deletes a record for a given Key.
*
Expand All @@ -61,6 +86,17 @@ public interface DynamoDbOperations {
*/
<T> T delete(T entity);

/**
* Deletes a record for a given DeleteItemEnhancedRequest.
*
* @param deleteItemEnhancedRequest the request object containing the item to be deleted
* @param clazz the class type of the item to be deleted so
* {@link software.amazon.awssdk.enhanced.dynamodb.TableSchema} can be generated.
*
* @see DeleteItemEnhancedRequest
*/
<T> T delete(DeleteItemEnhancedRequest deleteItemEnhancedRequest, Class<T> clazz);

/**
* Loads entity for a given Key.
*
Expand Down
21 changes: 21 additions & 0 deletions spring-cloud-aws-dynamodb/src/main/java/io/awspring/cloud/dynamodb/DynamoDbTemplate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@
import software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClient;
import software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable;
import software.amazon.awssdk.enhanced.dynamodb.Key;
import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.PageIterable;
import software.amazon.awssdk.enhanced.dynamodb.model.PutItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.QueryEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.ScanEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedRequest;

/**
* Default implementation of {@link DynamoDbOperations}.
Expand Down Expand Up @@ -61,11 +64,23 @@ public <T> T save(T entity) {
return entity;
}

public <T> void save(PutItemEnhancedRequest<T> putItemEnhancedRequest, Class<T> clazz) {
Assert.notNull(putItemEnhancedRequest, "putItemEnhancedRequest is required");
Assert.notNull(clazz, "clazz is required");
prepareTable(clazz).putItem(putItemEnhancedRequest);
}

public <T> T update(T entity) {
Assert.notNull(entity, "entity is required");
return prepareTable(entity).updateItem(entity);
}

public <T> T update(UpdateItemEnhancedRequest<T> updateItemEnhancedRequest, Class<T> clazz) {
Assert.notNull(updateItemEnhancedRequest, "updateItemEnhancedRequest is required");
Assert.notNull(clazz, "clazz is required");
return prepareTable(clazz).updateItem(updateItemEnhancedRequest);
}

public <T> T delete(Key key, Class<T> clazz) {
Assert.notNull(key, "key is required");
Assert.notNull(clazz, "clazz is required");
Expand All @@ -77,6 +92,12 @@ public <T> T delete(T entity) {
return prepareTable(entity).deleteItem(entity);
}

public <T> T delete(DeleteItemEnhancedRequest deleteItemEnhancedRequest, Class<T> clazz) {
Assert.notNull(deleteItemEnhancedRequest, "deleteItemEnhancedRequest is required");
Assert.notNull(clazz, "clazz is required");
return prepareTable(clazz).deleteItem(deleteItemEnhancedRequest);
}

@Nullable
public <T> T load(Key key, Class<T> clazz) {
Assert.notNull(key, "key is required");
Expand Down
129 changes: 129 additions & 0 deletions ...ws-dynamodb/src/test/java/io/awspring/cloud/dynamodb/DynamoDbTemplateIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package io.awspring.cloud.dynamodb;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.Assert.assertThrows;

import java.util.ArrayList;
import java.util.List;
Expand All @@ -33,10 +34,13 @@
import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
import software.amazon.awssdk.enhanced.dynamodb.*;
import software.amazon.awssdk.enhanced.dynamodb.model.DeleteItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.PageIterable;
import software.amazon.awssdk.enhanced.dynamodb.model.PutItemEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.QueryConditional;
import software.amazon.awssdk.enhanced.dynamodb.model.QueryEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.ScanEnhancedRequest;
import software.amazon.awssdk.enhanced.dynamodb.model.UpdateItemEnhancedRequest;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.dynamodb.model.*;
Expand Down Expand Up @@ -310,6 +314,131 @@ void dynamoDbTemplate_saveAndScanForParticularIndex_entitySuccessful(DynamoDbTab
cleanUp(dynamoDbTable, personEntity2.getUuid());
}

@ParameterizedTest
@MethodSource("argumentSource")
void dynamoDbTemplate_saveConditionallyAndRead_entitySuccessfully(DynamoDbTable<PersonEntity> dynamoDbTable,
DynamoDbTemplate dynamoDbTemplate) {
UUID uuid = UUID.randomUUID();
PersonEntity personEntity = new PersonEntity(uuid, "foo", null);
PersonEntity secondPersonEntity = new PersonEntity(uuid, "foo", "jar");
PutItemEnhancedRequest<PersonEntity> putItemEnhancedRequest = PutItemEnhancedRequest.builder(PersonEntity.class)
.conditionExpression(Expression.builder().expression("attribute_not_exists(lastName)").build())
.item(secondPersonEntity).build();
// save a person with lastName "bar"
dynamoDbTemplate.save(personEntity);
// attempt to replace person with lastName "jar"
dynamoDbTemplate.save(putItemEnhancedRequest, PersonEntity.class);
PersonEntity savedPersonEntity = dynamoDbTemplate.load(
Key.builder().partitionValue(secondPersonEntity.getUuid().toString()).build(), PersonEntity.class);
assertThat(savedPersonEntity).isEqualTo(secondPersonEntity);

cleanUp(dynamoDbTable, personEntity.getUuid());
}

@ParameterizedTest
@MethodSource("argumentSource")
void dynamoDbTemplate_saveConditionally_entityFails(DynamoDbTable<PersonEntity> dynamoDbTable,
DynamoDbTemplate dynamoDbTemplate) {
UUID uuid = UUID.randomUUID();
PersonEntity personEntity = new PersonEntity(uuid, "foo", "bar");
PersonEntity secondPersonEntity = new PersonEntity(uuid, "foo", "jar");
PutItemEnhancedRequest<PersonEntity> putItemEnhancedRequest = PutItemEnhancedRequest.builder(PersonEntity.class)
.conditionExpression(Expression.builder().expression("attribute_not_exists(lastName)").build())
.item(secondPersonEntity).build();
// save person with lastName "bar"
dynamoDbTemplate.save(personEntity);
// try to save new lastName "jar" for the same person
assertThrows(DynamoDbException.class, () -> {
dynamoDbTemplate.save(putItemEnhancedRequest, PersonEntity.class);
});

cleanUp(dynamoDbTable, personEntity.getUuid());

}

@ParameterizedTest
@MethodSource("argumentSource")
void dynamoDbTemplate_updateConditionally_entitySuccessfully(DynamoDbTable<PersonEntity> dynamoDbTable,
DynamoDbTemplate dynamoDbTemplate) {
UUID uuid = UUID.randomUUID();
PersonEntity personEntity = new PersonEntity(uuid, "foo", null);
PersonEntity updatedPersonEntity = new PersonEntity(uuid, "foo", "bar");
UpdateItemEnhancedRequest<PersonEntity> updateItemEnhancedRequest = UpdateItemEnhancedRequest
.builder(PersonEntity.class)
.conditionExpression(Expression.builder().expression("attribute_not_exists(lastName)").build())
.item(updatedPersonEntity).build();
// save a person with lastName "bar"
dynamoDbTemplate.save(personEntity);
// update person lastName
PersonEntity savedPersonEntity = dynamoDbTemplate.update(updateItemEnhancedRequest, PersonEntity.class);
assertThat(savedPersonEntity.getLastName()).isEqualTo("bar");

cleanUp(dynamoDbTable, personEntity.getUuid());
}

@ParameterizedTest
@MethodSource("argumentSource")
void dynamoDbTemplate_updateConditionally_entityFails(DynamoDbTable<PersonEntity> dynamoDbTable,
DynamoDbTemplate dynamoDbTemplate) {
UUID uuid = UUID.randomUUID();
PersonEntity personEntity = new PersonEntity(uuid, "foo", "bar");
PersonEntity updatedPersonEntity = new PersonEntity(uuid, "foo", "jar");
UpdateItemEnhancedRequest<PersonEntity> updateItemEnhancedRequest = UpdateItemEnhancedRequest
.builder(PersonEntity.class)
.conditionExpression(Expression.builder().expression("attribute_not_exists(lastName)").build())
.item(updatedPersonEntity).build();
// save a person with lastName "bar"
dynamoDbTemplate.save(personEntity);
// update person lastName
assertThrows(DynamoDbException.class, () -> {
dynamoDbTemplate.update(updateItemEnhancedRequest, PersonEntity.class);
});
cleanUp(dynamoDbTable, personEntity.getUuid());
}

@ParameterizedTest
@MethodSource("argumentSource")
void dynamoDbTemplate_deleteConditionally_entitySuccessfully(DynamoDbTable<PersonEntity> dynamoDbTable,
DynamoDbTemplate dynamoDbTemplate) {
UUID uuid = UUID.randomUUID();
PersonEntity personEntity = new PersonEntity(uuid, "notfoo", "bar");
DeleteItemEnhancedRequest deleteItemEnhancedRequest = DeleteItemEnhancedRequest.builder()
.conditionExpression(Expression.builder().expression("#nameNotBeDeleted <> :value")
.putExpressionName("#nameNotBeDeleted", "name")
.putExpressionValue(":value", AttributeValue.builder().s("foo").build()).build())
.key(Key.builder().partitionValue(personEntity.getUuid().toString()).build()).build();
dynamoDbTemplate.save(personEntity);
dynamoDbTemplate.delete(deleteItemEnhancedRequest, PersonEntity.class);

PersonEntity deletedEntity = dynamoDbTemplate
.load(Key.builder().partitionValue(personEntity.getUuid().toString()).build(), PersonEntity.class);

assertThat(deletedEntity).isNull();
}

@ParameterizedTest
@MethodSource("argumentSource")
void dynamoDbTemplate_deleteConditionally_entityFails(DynamoDbTable<PersonEntity> dynamoDbTable,
DynamoDbTemplate dynamoDbTemplate) {
UUID uuid = UUID.randomUUID();
PersonEntity personEntity = new PersonEntity(uuid, "foo", "bar");
DeleteItemEnhancedRequest deleteItemEnhancedRequest = DeleteItemEnhancedRequest.builder()
.conditionExpression(Expression.builder().expression("#nameNotBeDeleted <> :value")
.putExpressionName("#nameNotBeDeleted", "name")
.putExpressionValue(":value", AttributeValue.builder().s("foo").build()).build())
.key(Key.builder().partitionValue(personEntity.getUuid().toString()).build()).build();
dynamoDbTemplate.save(personEntity);
assertThrows(DynamoDbException.class, () -> {
dynamoDbTemplate.delete(deleteItemEnhancedRequest, PersonEntity.class);
});

PersonEntity deletedEntity = dynamoDbTemplate
.load(Key.builder().partitionValue(personEntity.getUuid().toString()).build(), PersonEntity.class);

assertThat(deletedEntity).isNotNull();
cleanUp(dynamoDbTable, personEntity.getUuid());
}

public static void cleanUp(DynamoDbTable<PersonEntity> dynamoDbTable, UUID uuid) {
dynamoDbTable.deleteItem(Key.builder().partitionValue(uuid.toString()).build());
}
Expand Down