@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

For SDK usage, please step to SDK reademe.