Skip to main content

Upserts with version awareness in DynamoDB

Introduction

ElasticSearch has a concurrency control capability that enables writes to use a version value to determine whether to apply an update or discard it as being stale in comparison to some existing data.

As part of considering a migration away from ElasticSearch as a data store, I was interested in how other databases could be made to achieve the same type of version aware upsert capability.

In some earlier posts on this blog I have shared how the version aware upserting can be done with PostgreSQL, MariaDB and TitanDB.

This post is to share how the same capability can be achieved with AWS's DynamoDB document database, as an example of a non-relational database.

What does the DynamoDB API offer?

Insert, or update 

DynamoDB has putItem for creating an item in a DynamoDB table, and updateItem for updating an existing item.

On first look, we might expect some combination of putItem and updateItem to need to be applied, as that would resemble how the relational databases had to detect conflict and fall back to attempt the second type of operation.

It turns out that we can just use putItem, as the API documentation states:

"If an item with the same key already exists in the table, it is replaced with the new item."

So, that takes care of the insert otherwise update aspect of the implementation, but what about version awareness?

Conditional updating

The putItem API offers us the option of specifying some conditional logic that includes the ability to compare existing data against the data being sent.

If we have a table called event, containing an id and a version then we can have a call like the following:

String idAsString = "event-123";
String version = "456";

Map<String, AttributeValue> eventDataUpdating = Map.of(
"id", AttributeValue.builder().s(idAsString).build(),
"version", AttributeValue.builder().n(version).build());

dbClient.putItem(
PutItemRequest.builder().tableName("event")
.item(eventDataUpdating)
.conditionExpression("attribute_not_exists(id) OR (version < :version)")
.expressionAttributeValues(Map.of(":version", AttributeValue.builder().n(version).build()))
.returnValuesOnConditionCheckFailure(ReturnValuesOnConditionCheckFailure.ALL_OLD)
.build());

In that code, conditionExpression and expressionAttributeValues combine to express the two situations that determine whether the content should be written into the event table:

  • attribute_not_exists covers the insert case, as there is no existing record with the specified id;
  • version < :version covers the situation where an existing item exists but has a lower version value than what is being provided now.

Try it out

I've been experimenting in Java, using the Localstack Docker container as a standalone environment for interacting with DynamoDB, so you can grab the code and try running it for yourself.

At the time of this post, it is just a single class that:

  • creates the table
  • writes an initial low version
  • sets up 100 randomly ordered version values
  • spins up virtual threads that each pick up one of the version values and concurrently attempt to apply the update using the condition check
  • prints out when a conflict has prevented an attempted update (as expected) 
  • verifies that when the dust has settled we ultimately end up with the highest version being written

Code in GitHub  

(You'll need Java 21 or later, Maven, and Docker). 

Disclaimer

So far I have only scratched the surface of how to achieve the desired functionality.

I would not recommend applying this approach without also diving deep into the documentation for further layers of potential limitations and situations where eventual consistency may make this less appropriate than it appears.

 

Comments

Popular posts from this blog

Speeding up Software Builds for Continuous Integration

Downloading the Internet Can you remember the last time you started out on a clean development environment and ran the build of some software using Maven or Gradle for dependency management? It takes ages to download all of the necessary third party libraries from one or more remote repositories, leading to expressions like, "Just waiting for Maven to download the Internet". Once your development environment has been used for building a few projects the range of dependencies that will need to be downloaded for other builds reduces down as the previously referenced ones will now be cached and found locally on your computer's hard drive. What happens on the Continuous Integration environment? Now consider what goes on when Jenkins or your other preferred Continuous Integration server comes to build your software. If it doesn't have a local copy of the libraries that have been referenced then it is going to pay the cost of that slow " download the Internet" p...

2022 - A year in review

Just a look back over the last 12 months. January I moved back to Christchurch to live, after having spent a few months further south since moving back from London. Work was mainly around balancing other peoples' understanding and expectations around our use of Kafka. February I decided that it would be worthwhile to have a year's subscription for streaming Sky Sports, as some rugby matches that I would want to watch would be on at time when venues wouldn't be open. Having moved to Christchurch to be close to an office, now found myself working from home as Covid restrictions came back into effect across New Zealand. March Got back into some actual coding at work - as opposed to mainly reviewing pull requests for configuration changes for Kafka topics.  This became urgent, as the command line interface tool that our provisioning system was dependent on had been marked for deprecation. April   Had my first direct experience with Covid-19.  I only went for a test because ...

Applying AI to software development can be like following SatNav

Trying out a different navigation system A month or so ago I upgraded to a car that has a SatNav system included, so I have been trying to use that instead of the Maps app on my phone. My experiences with it so far have generally been good, but it is far from flawless - a bit like Artificial Intelligence (AI) in software development. As context, my previous vehicle was not too old to include SatNav, it just hadn't been set up with English language or New Zealand maps - one of the down sides of having a second hand vehicle that originated in Japan. Flawed or incomplete information Driving around central Christchurch can be a bit challenging at times as various roadworks are underway, leaving streets closed off or narrowed down to a single lane. It could be reasonable to expect that a basic navigation system might not have up to the minute awareness of those closures and restrictions. However, something that I did not expect to encounter was the navigation system advising me to expec...