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

Merged
maciejwalkowiak merged 5 commits into from
Sep 14, 2025
Merged

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
5 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
5b101d5
Merge remote-tracking branch 'origin/main' into gh-1147
maciejwalkowiak Sep 14, 2025
16cfa21
Remove class parameter from methods that can obtain class by calling …
maciejwalkowiak Sep 14, 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
22 changes: 22 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,7 +17,9 @@

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;
Expand All @@ -39,6 +41,15 @@ public interface DynamoDbOperations {
*/
<T> T save(T entity);

/**
* Saves an item in DynamoDB using the provided PutItemEnhancedRequest.
*
* @param request the request object containing the item to be saved
*
* @see PutItemEnhancedRequest
*/
<T> void save(PutItemEnhancedRequest<T> request);

/**
* Updates Entity to DynamoDB table.
*
Expand Down Expand Up @@ -71,6 +82,17 @@ public interface DynamoDbOperations {
*/
<T> T delete(T entity);

/**
* Deletes a record for a given DeleteItemEnhancedRequest.
*
* @param request 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 request, Class<T> clazz);

/**
* Loads entity for a given Key.
*
Expand Down
15 changes: 15 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,7 +21,9 @@
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;
Expand Down Expand Up @@ -64,6 +66,12 @@ public <T> T save(T entity) {
return entity;
}

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

public <T> T update(T entity) {
Assert.notNull(entity, "entity is required");
return prepareTable(entity).updateItem(entity);
Expand All @@ -72,6 +80,7 @@ public <T> T update(T entity) {
@Override
public <T> T update(UpdateItemEnhancedRequest<T> request) {
Assert.notNull(request, "updateItemEnhancedRequest is required");
Assert.notNull(request.item(), "request item is required");
return prepareTable(request.item()).updateItem(request);
}

Expand All @@ -86,6 +95,12 @@ public <T> T delete(T entity) {
return prepareTable(entity).deleteItem(entity);
}

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

@Nullable
public <T> T load(Key key, Class<T> clazz) {
Assert.notNull(key, "key is required");
Expand Down
89 changes: 89 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 @@ -29,10 +30,13 @@
import org.springframework.util.StringUtils;
import software.amazon.awssdk.enhanced.dynamodb.*;
import software.amazon.awssdk.enhanced.dynamodb.model.*;
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.services.dynamodb.DynamoDbClient;
import software.amazon.awssdk.services.dynamodb.model.*;

Expand Down Expand Up @@ -322,6 +326,91 @@ 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 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);
});

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