Using PartiQL to query AWS DynamoDb in Javascript.

This github repo contains the code examples and a getting started part to follow along with this article.

In that article, I compare ways of querying and inserting data into dynamoDb using PartiQL vs using the Document API using the AWS Javascript SDK.

Prerequisite Tasks

The examples here are run using node. To set up and run this example, first complete these tasks:

1. Install Node.js. For more information, see the Node.js website.
2. Create a shared configurations file with your user credentials. For more information about providing a shared credentials file, see Loading Credentials in Node.js from the Shared Credentials File.

Getting Started

1. Download or clone this git repository.
2. If your environment doesn't already have your AWS profile, then setup the AWS credentials by creating a .env file with the same keys in the sample.env.
3. This code uses the us-east-1 region. If you want to use a different region, change the value in aws-config.js. PartiQL support for DynamoDb is supported in at least 23 regions.
4. Run npm run get-started. This will create a new DynamoDb table called Movies and upload some sample data.

Running code samples to query uploaded data

The code examples for querying the data are in the folder ./query-data.

Check the files and change the paramaters if you would like to query something different.

You can run the examples using the command line:

// To run the code example for querying using the dynamoDb partiQL api.

node query-data/query-partiQL.js

// To run the code example for querying using the dynamoDb document client.

node query-data/query-documentAPI.js

Running code samples to insert sample data

The code examples for inserting random movie data are in the folder ./insert-data.

Check the files and change the paramaters if you would like to insert something different.

You can run the examples using the command line:

// To run the code example for inserting data using the dynamoDb partiQL api.

node insert-data/insert-partiQL.js

// To run the code example for inserting data using the dynamoDb document client.

node insert-data/insert-documentAPI.js

Running code samples to batch insert sample data

The code examples for batch inserting random movie data are in the folder ./batch-insert.

A movie list of 500 items is created user faker library.

You can run the examples using the command line:

// To run the code example for batch inserting data using the dynamoDb partiQL api.

node batch-insert/batch-partiQL.js

// To run the code example for batch inserting data using the dynamoDb document client.

node batch-insert/batch-documentAPI.js

(Optional) Delete the table

You can clean the Movies table by running

npm run cleanup