@aws-sdk/client-dynamodb

What is @aws-sdk/client-dynamodb?

The @aws-sdk/client-dynamodb npm package is a client library for interacting with Amazon DynamoDB, a NoSQL database service provided by AWS. It allows developers to perform various operations on DynamoDB tables and data, such as creating and deleting tables, reading and writing data, and querying and scanning data.

What are @aws-sdk/client-dynamodb's main functionalities?

Creating a DynamoDB Table

This code sample demonstrates how to create a new DynamoDB table with a specified schema and provisioned throughput.

const { DynamoDBClient, CreateTableCommand } = require('@aws-sdk/client-dynamodb');

const client = new DynamoDBClient({ region: 'us-west-2' });
const createTableParams = {
  TableName: 'MyTable',
  KeySchema: [{ AttributeName: 'id', KeyType: 'HASH' }],
  AttributeDefinitions: [{ AttributeName: 'id', AttributeType: 'S' }],
  ProvisionedThroughput: { ReadCapacityUnits: 5, WriteCapacityUnits: 5 }
};

const createTableCommand = new CreateTableCommand(createTableParams);
client.send(createTableCommand).then((data) => console.log(data)).catch((error) => console.error(error));

Inserting Data into a DynamoDB Table

This code sample shows how to insert a new item into a DynamoDB table.

const { DynamoDBClient, PutItemCommand } = require('@aws-sdk/client-dynamodb');

const client = new DynamoDBClient({ region: 'us-west-2' });
const putItemParams = {
  TableName: 'MyTable',
  Item: {
    'id': { S: '123' },
    'data': { S: 'Some data' }
  }
};

const putItemCommand = new PutItemCommand(putItemParams);
client.send(putItemCommand).then((data) => console.log(data)).catch((error) => console.error(error));

Querying Data from a DynamoDB Table

This code sample illustrates how to query a DynamoDB table for items with a specific key.

const { DynamoDBClient, QueryCommand } = require('@aws-sdk/client-dynamodb');

const client = new DynamoDBClient({ region: 'us-west-2' });
const queryParams = {
  TableName: 'MyTable',
  KeyConditionExpression: 'id = :idValue',
  ExpressionAttributeValues: {
    ':idValue': { S: '123' }
  }
};

const queryCommand = new QueryCommand(queryParams);
client.send(queryCommand).then((data) => console.log(data.Items)).catch((error) => console.error(error));

Other packages similar to @aws-sdk/client-dynamodb

dynamoose

Dynamoose is a modeling tool for Amazon DynamoDB that provides a higher-level abstraction for working with DynamoDB. It offers features like schema definition, validation, and easy querying. It is designed to be simple to use and aims to provide a similar experience to working with MongoDB. Compared to @aws-sdk/client-dynamodb, Dynamoose adds an additional layer of abstraction and can be more convenient for certain use cases.

dynamo-types

Dynamo-types is a TypeScript library that provides decorators and other features to make it easier to work with DynamoDB in a strongly-typed way. It is built on top of the AWS SDK and provides a more type-safe interface for defining and querying DynamoDB tables. It is a good choice for TypeScript users who want to leverage type safety in their DynamoDB interactions, whereas @aws-sdk/client-dynamodb is more general-purpose and not specifically tailored to TypeScript.

README

@aws-sdk/client-dynamodb

Description

AWS SDK for JavaScript DynamoDB Client for Node.js, Browser and React Native.

Amazon DynamoDB

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.

With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.

DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.

Installing

To install the this package, simply type add or install @aws-sdk/client-dynamodb using your favorite package manager:

• npm install @aws-sdk/client-dynamodb
• yarn add @aws-sdk/client-dynamodb
• pnpm add @aws-sdk/client-dynamodb

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the DynamoDBClient and the commands you need, for example BatchExecuteStatementCommand:

// ES5 example
const { DynamoDBClient, BatchExecuteStatementCommand } = require("@aws-sdk/client-dynamodb");

// ES6+ example
import { DynamoDBClient, BatchExecuteStatementCommand } from "@aws-sdk/client-dynamodb";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by difference commands.
const client = new DynamoDBClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new BatchExecuteStatementCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // proccess err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-dynamodb";
const client = new AWS.DynamoDB({ region: "REGION" });

// async/await.
try {
  const data = client.batchExecuteStatement(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .batchExecuteStatement(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.batchExecuteStatement(params, (err, data) => {
  // proccess err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-dynamodb package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Changelog

3.3.0 (2021-01-14)

Bug Fixes

• clients: export explicit dependencies on @aws-sdk/types (#1902) (96f1087)
• clients: lowercase all header names in serializer (#1892) (1308721)
• url-parser: merge browser and node url parser, add rn url parser (#1903) (99be092)
• util-waiters: waiters should call operation once before entering waiting (#1915) (2a6ac11)

Features

• clients: update README with documentation, usage and more (#1907) (03be111)