DynamoDB code examples for the SDK for JavaScript (v3)

Overview

Shows how to use the AWS SDK for JavaScript (v3) to work with Amazon DynamoDB.

DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability.

⚠ Important

• Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
• Running the tests might result in charges to your AWS account.
• We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
• This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Code examples

Prerequisites

For prerequisites, see the README in the javascriptv3 folder.

Get started

• Hello DynamoDB (ListTables)

Basics

Code examples that show you how to perform the essential operations within a service.

• Learn the basics

Single actions

Code excerpts that show you how to call individual service functions.

• BatchExecuteStatement
• BatchGetItem
• BatchWriteItem
• CreateTable
• DeleteItem
• DeleteTable
• DescribeTable
• ExecuteStatement
• GetItem
• ListTables
• PutItem
• Query
• Scan
• UpdateItem

Scenarios

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

• Query a table by using batches of PartiQL statements
• Query a table using PartiQL

Run the examples

Instructions

Note: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see JavaScript ES6/CommonJS syntax.

Run a single action

node ./actions/<fileName>

Run a scenario

Most scenarios can be run with the following command:

node ./scenarios/<fileName>

Run with options

Some actions and scenarios can be run with options from the command line:

node ./scenarios/<fileName> --option1 --option2

util.parseArgs is used to configure these options. For the specific options available to each script, see the parseArgs usage for that file.

Hello DynamoDB

This example shows you how to get started using DynamoDB.

node ./hello.js

Learn the basics

This example shows you how to do the following:

• Create a table that can hold movie data.
• Put, get, and update a single movie in the table.
• Write movie data to the table from a sample JSON file.
• Query for movies that were released in a given year.
• Scan for movies that were released in a range of years.
• Delete a movie from the table, then delete the table.

Query a table by using batches of PartiQL statements

This example shows you how to do the following:

• Get a batch of items by running multiple SELECT statements.
• Add a batch of items by running multiple INSERT statements.
• Update a batch of items by running multiple UPDATE statements.
• Delete a batch of items by running multiple DELETE statements.

Query a table using PartiQL

This example shows you how to do the following:

• Get an item by running a SELECT statement.
• Add an item by running an INSERT statement.
• Update an item by running an UPDATE statement.
• Delete an item by running a DELETE statement.

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the javascriptv3 folder.

Additional resources

• DynamoDB Developer Guide
• DynamoDB API Reference
• SDK for JavaScript (v3) DynamoDB reference

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0