DynamoDb.SQL – a SQL-like external DSL for Amazon DynamoDB

You can become a serverless blackbelt. Enrol to my 4-week online workshop Production-Ready Serverless and gain hands-on experience building something from scratch using serverless technologies. At the end of the workshop, you should have a broader view of the challenges you will face as your serverless architecture matures and expands. You should also have a firm grasp on when serverless is a good fit for your system as well as common pitfalls you need to avoid. Sign up now and get 15% discount with the code yanprs15!

Amazon’s DynamoDB is a wonderful product – scalable, durable, fast, with predictable latency numbers unlike SimpleDB. However, the only gripe I have with DynamoDB is that there is no built-in support for a query language, which makes life rather difficult when you want to perform a query or a scan against the data you have in DynamoDB.

Whilst the standard AWS SDK for .Net provides a number of different ways to perform queries and scans:

  • using the low-level AmazonDynamoDBClient
  • using the Table helper class
  • using the DynamoDBContext ORM

none of these ways are easy to use and the few attempts to use them in our codebase left a bad taste in my mouth and an external DSL is desperately needed to make it easier to express the query we’d like to perform against data stored in DynamoDB.

Introducing DynamoDb.SQL

It is because of these limitations that I decided to add a SQL-like external DSL on top of existing functionalities to make it easier for .Net developers to work with DynamoDB.

Having spent a couple of weekends I have put together a simple library called DynamoDb.SQL, which you can download and try it yourself from Nuget here. This library adds an external DSL on top of the existing functionalities of the .Net AWS SDK and allows you to query and scan DynamoDB using natural, SQL-like syntax.

Using this syntax, a query can be expressed with the general format:

image

where @HashKey and @RangeKey are special keywords to mean the hash and range key in your table, and operator can be one of the allowed comparison operators for a query request :

=, >=, >, <=, <, BEGINS WITH and BETWEEN .. AND ..

Similarly, a scan can be expressed with the general format:

image

where operator1 to operatorN can be one of the allowed comparison operators in a scan request :

=, !=, >=, >, <=, <, CONTAINS, NOT CONTAINS, BEGINS WITH, IS NULL, IS NOT NULL, BETWEEN .. AND .., and IN (…)

To learn more about the syntax and how to use DynamoDb.SQL, take a look at the Getting Started guide here.

 

Links:

DynamoDB API – Querying and Scanning

DynamoDB – Querying and Scanning using low-level AmazonDynamoDBClient

DynamoDB – Querying and Scanning using Table helper class

DynamoDB – Querying and Scanning using high-level DynamoDBContext

Liked this article? Support me on Patreon and get direct help from me via a private Slack channel or 1-2-1 mentoring.
Subscribe to my newsletter


Hi, I’m Yan. I’m an AWS Serverless Hero and I help companies go faster for less by adopting serverless technologies successfully.

Are you struggling with serverless or need guidance on best practices? Do you want someone to review your architecture and help you avoid costly mistakes down the line? Whatever the case, I’m here to help.

Hire me.


Skill up your serverless game with this hands-on workshop.

My 4-week Production-Ready Serverless online workshop is back!

This course takes you through building a production-ready serverless web application from testing, deployment, security, all the way through to observability. The motivation for this course is to give you hands-on experience building something with serverless technologies while giving you a broader view of the challenges you will face as the architecture matures and expands.

We will start at the basics and give you a firm introduction to Lambda and all the relevant concepts and service features (including the latest announcements in 2020). And then gradually ramping up and cover a wide array of topics such as API security, testing strategies, CI/CD, secret management, and operational best practices for monitoring and troubleshooting.

If you enrol now you can also get 15% OFF with the promo code “yanprs15”.

Enrol now and SAVE 15%.


Check out my new podcast Real-World Serverless where I talk with engineers who are building amazing things with serverless technologies and discuss the real-world use cases and challenges they face. If you’re interested in what people are actually doing with serverless and what it’s really like to be working with serverless day-to-day, then this is the podcast for you.


Check out my new course, Learn you some Lambda best practice for great good! In this course, you will learn best practices for working with AWS Lambda in terms of performance, cost, security, scalability, resilience and observability. We will also cover latest features from re:Invent 2019 such as Provisioned Concurrency and Lambda Destinations. Enrol now and start learning!


Check out my video course, Complete Guide to AWS Step Functions. In this course, we’ll cover everything you need to know to use AWS Step Functions service effectively. There is something for everyone from beginners to more advanced users looking for design patterns and best practices. Enrol now and start learning!