aws / aws-sdk-java-v2

The official AWS SDK for Java - Version 2
Apache License 2.0
2.2k stars 853 forks source link

DynamoDb enhanced client: support UpdateExpressions in single-request update #5554

Open IDUN-BogdanPi opened 2 months ago

IDUN-BogdanPi commented 2 months ago

Describe the feature

Enhance the UpdateItemEnhancedRequest to support update expressions. https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.UpdateExpressions.html

I see this feature is partially implemented: https://aws.amazon.com/blogs/developer/using-atomic-counters-in-the-enhanced-dynamodb-aws-sdk-for-java-2-x-client/

but as it is also stated in the article:

Update expressions in the extensions are applicable for use cases where you want to do the same thing with an attribute every time that you call the database, such as atomic counters. However, if you need a one-time effect for a single request, then leveraging the extension framework isn’t useful.

Use Case

I need to atomically increment a numeric value in a table column by different amounts on demand, without first reading the current value.

Consider this table:

@Getter
@Setter
@DynamoDbBean
public class Recording {

    private String id;
    private Long totalRecordingSeconds;

I need to be able to update and increment the value of totalRecordingSeconds with different durations: +30, + 20 ... etc, without reading the current value.

It would be helpful to be able to perform something like:

        String updateExpression = "SET totalRecordingSeconds = if_not_exists(totalRecordingSeconds, :zero) + :increment";

        Map<String, AttributeValue> expressionValues = new HashMap<>();
        expressionValues.put(":increment", AttributeValue.builder().n(Long.toString(incrementBy)).build());
        expressionValues.put(":zero", AttributeValue.builder().n("0").build());

        Expression expression = Expression.builder()
                .expression(updateExpression)
                .expressionValues(expressionValues)
                .build();

        UpdateItemEnhancedRequest<Recording> request = UpdateItemEnhancedRequest.builder(Recording.class)
                .key(k -> k.partitionValue(id))  
                .updateExpression(expression)   
                .build();

        table.updateItem(request);

Proposed Solution

No response

Other Information

No response

Acknowledgements

AWS Java SDK version used

2.21.37

JDK version used

22.0.2

Operating System and version

MacOS Sonoma 14.5

debora-ito commented 2 months ago

PR https://github.com/aws/aws-sdk-java-v2/pull/3836 started working on this but it lost traction. I'll see if I can get it moving again.

IDUN-BogdanPi commented 2 months ago

Much appreciated!