Document client abstraction in DynamoDB

Introduction

The document client abstraction makes it easy to work with DynamoDB by letting you use simple JavaScript objects instead of complex low-level commands.

When you want to save a new item to a DynamoDB table using simple JavaScript objects.

When you need to read an item from DynamoDB without dealing with raw attribute values.

When updating or deleting items in DynamoDB using easy-to-understand code.

When you want to avoid writing verbose code for data conversion between your app and DynamoDB.

Syntax

DynamoDB

import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
import { DynamoDBDocumentClient, PutCommand, GetCommand } from "@aws-sdk/lib-dynamodb";

const client = new DynamoDBClient({ region: "your-region" });
const docClient = DynamoDBDocumentClient.from(client);

// To put an item
await docClient.send(new PutCommand({
  TableName: "YourTableName",
  Item: { key1: "value1", key2: 123 }
}));

// To get an item
const result = await docClient.send(new GetCommand({
  TableName: "YourTableName",
  Key: { key1: "value1" }
}));

The Document Client automatically converts JavaScript objects to DynamoDB format and back.

You use commands like PutCommand and GetCommand with the document client to perform operations.

Examples

Stores a user object with simple keys and values.

DynamoDB

await docClient.send(new PutCommand({
  TableName: "Users",
  Item: { userId: "123", name: "Alice", age: 30 }
}));

Retrieves the user with userId '123' and prints the JavaScript object.

DynamoDB

const data = await docClient.send(new GetCommand({
  TableName: "Users",
  Key: { userId: "123" }
}));
console.log(data.Item);

If the item is missing, the result's Item is undefined.

DynamoDB

// Edge case: Getting an item that does not exist
const data = await docClient.send(new GetCommand({
  TableName: "Users",
  Key: { userId: "999" }
}));
console.log(data.Item); // undefined

Sample Program

This program shows how to use the document client to get an item before and after inserting it. It prints the item state before and after the PutCommand.

DynamoDB

import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
import { DynamoDBDocumentClient, PutCommand, GetCommand } from "@aws-sdk/lib-dynamodb";

async function run() {
  const client = new DynamoDBClient({ region: "us-east-1" });
  const docClient = DynamoDBDocumentClient.from(client);

  console.log("Before putting item:");
  let getResult = await docClient.send(new GetCommand({
    TableName: "TestTable",
    Key: { id: "1" }
  }));
  console.log(getResult.Item); // Should be undefined if no item

  await docClient.send(new PutCommand({
    TableName: "TestTable",
    Item: { id: "1", name: "John Doe", age: 25 }
  }));

  console.log("After putting item:");
  getResult = await docClient.send(new GetCommand({
    TableName: "TestTable",
    Key: { id: "1" }
  }));
  console.log(getResult.Item); // Should show the inserted item
}

run().catch(console.error);

Important Notes

The document client simplifies working with DynamoDB by handling data conversion automatically.

Time complexity depends on the operation (e.g., GetCommand is O(1) for primary key access).

Common mistake: forgetting to await the send() method, which causes unexpected behavior.

Use the document client when you want clean, readable code without manual data marshaling.

Summary

The document client lets you use plain JavaScript objects with DynamoDB.

It hides the complexity of DynamoDB's data format conversions.

You use commands like PutCommand and GetCommand with the document client to perform operations.

Practice

1. What is the main benefit of using the DynamoDB Document Client abstraction?

easy

A. It requires you to write complex JSON expressions for queries.

B. It allows you to work with plain JavaScript objects without manual data conversion.

C. It only supports string data types in DynamoDB.

D. It disables the use of PutCommand and GetCommand.

Solution

1. Step 1: Understand Document Client purpose

   The Document Client simplifies interaction by letting you use normal JavaScript objects.

2. Step 2: Compare options

   The incorrect options describe limitations or incorrect features, while the correct one states the main benefit.

3. Final Answer:

   It allows you to work with plain JavaScript objects without manual data conversion. -> Option B

4. Quick Check:

   Document Client simplifies data handling = A [OK]

Hint: Document Client hides data format details, use plain objects [OK]

Common Mistakes:

• Thinking you must manually convert data formats
• Believing it only supports strings
• Confusing commands it supports

2. Which of the following is the correct way to import the DynamoDB Document Client in JavaScript?

easy

A. import DynamoDBDocumentClient from 'aws-sdk';

B. const DynamoDBDocumentClient = require('aws-sdk/lib-dynamodb');

C. import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";

D. const { DynamoDBDocumentClient } = require('@aws-sdk/client-dynamodb');

Solution

1. Step 1: Identify correct import syntax

   The Document Client is imported from "@aws-sdk/lib-dynamodb" using ES module syntax.

2. Step 2: Eliminate incorrect options

   The CommonJS require uses the wrong path; importing from 'aws-sdk' uses the wrong package; destructuring from '@aws-sdk/client-dynamodb' uses the wrong package.

3. Final Answer:

   import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb"; -> Option C

4. Quick Check:

   Correct ES module import from lib-dynamodb = A [OK]

Hint: Use ES module import from '@aws-sdk/lib-dynamodb' [OK]

Common Mistakes:

• Importing from '@aws-sdk/client-dynamodb' instead
• Using require with wrong package
• Missing curly braces in import

3. Given the following code snippet using DynamoDB Document Client, what will be the output if the item exists?

const params = { TableName: "Users", Key: { userId: "123" } };
const command = new GetCommand(params);
const data = await docClient.send(command);
console.log(data.Item);

medium

A. An object representing the user with userId '123', e.g., { userId: '123', name: 'Alice' }

B. A string containing the userId '123'

C. An error because GetCommand is not supported by Document Client

D. Undefined, because data.Item is not returned

Solution

1. Step 1: Understand GetCommand with Document Client

   GetCommand returns an object with an Item property containing the requested item if it exists.

2. Step 2: Analyze console.log output

   Logging data.Item prints the full object stored for userId '123', not just a string or undefined.

3. Final Answer:

   An object representing the user with userId '123', e.g., { userId: '123', name: 'Alice' } -> Option A

4. Quick Check:

   GetCommand returns item object = B [OK]

Hint: GetCommand returns full item object in data.Item [OK]

Common Mistakes:

• Expecting only the key value as output
• Thinking GetCommand is unsupported
• Assuming data.Item is undefined

4. Identify the error in this DynamoDB Document Client code snippet:

const params = { TableName: "Products", Item: { id: 101, name: "Pen" } };
const command = new GetCommand(params);
const result = await docClient.send(command);
console.log(result);

medium

A. Using GetCommand with an Item parameter instead of Key

B. Missing await keyword before docClient.send

C. TableName should be lowercase

D. Item should be a string, not an object

Solution

1. Step 1: Check command and parameters

   GetCommand requires a Key parameter to identify the item, not an Item parameter.

2. Step 2: Validate other options

   Await is present, TableName is case-sensitive but correct, and Item must be an object for PutCommand, not GetCommand.

3. Final Answer:

   Using GetCommand with an Item parameter instead of Key -> Option A

4. Quick Check:

   GetCommand needs Key, not Item = D [OK]

Hint: GetCommand uses Key, PutCommand uses Item [OK]

Common Mistakes:

• Confusing Item and Key parameters
• Ignoring case sensitivity of TableName
• Forgetting await keyword

5. You want to add a new user to the DynamoDB table 'Users' using the Document Client. Which code snippet correctly performs this operation?

hard

A. const params = { TableName: 'Users', Key: { userId: 'u123' }, Item: { name: 'Bob' } };
const command = new PutCommand(params);
await docClient.send(command);

B. const params = { TableName: 'Users', Key: { userId: 'u123' } };
const command = new PutCommand(params);
await docClient.send(command);

C. const params = { TableName: 'Users', Item: { userId: 'u123' } };
const command = new GetCommand(params);
await docClient.send(command);

D. const params = { TableName: 'Users', Item: { userId: 'u123', name: 'Bob' } };
const command = new PutCommand(params);
await docClient.send(command);

Solution

1. Step 1: Understand PutCommand parameters

   PutCommand requires an Item parameter with the full object to insert, including the key attributes.

2. Step 2: Analyze each option

   Using both Key and Item is incorrect; using only Key omits the Item; using GetCommand retrieves instead of inserts; the correct snippet uses Item containing both key and attributes.

3. Final Answer:

   const params = { TableName: 'Users', Item: { userId: 'u123', name: 'Bob' } }; const command = new PutCommand(params); await docClient.send(command); -> Option D

4. Quick Check:

   PutCommand with Item including key = C [OK]

Hint: PutCommand needs full Item object including keys [OK]

Common Mistakes:

• Using Key instead of Item for PutCommand
• Mixing GetCommand with PutCommand parameters
• Omitting key attributes in Item