Document client abstraction in DynamoDB - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the Document Client abstraction in DynamoDB?

The Document Client is a higher-level API in DynamoDB that simplifies working with items as JSON-like documents, making it easier to read and write data without dealing with low-level attribute types.

beginner

How does the Document Client simplify data operations compared to the low-level DynamoDB API?

It automatically converts native JavaScript types to DynamoDB attribute types and vice versa, so you can work with plain objects instead of manually specifying data types.

beginner

Which method would you use with the Document Client to add a new item to a DynamoDB table?

You use the `put` method to add or replace an item in a DynamoDB table using the Document Client.

beginner

What is the benefit of using the Document Client when retrieving data from DynamoDB?

It returns data as plain JavaScript objects, so you don't need to manually parse DynamoDB's attribute value format, making the code cleaner and easier to understand.

intermediate

Can the Document Client handle complex nested data structures in DynamoDB?

Yes, the Document Client supports nested objects and arrays, allowing you to work with complex JSON-like documents naturally.

What does the DynamoDB Document Client automatically handle for you?

A Conversion between JavaScript types and DynamoDB attribute types

B Creating tables automatically

C Managing database backups

D Running SQL queries

The Document Client converts JavaScript objects to DynamoDB's attribute value format and back, simplifying data operations.

Which method is used by the Document Client to retrieve a single item from a table?

A put

B query

C get

D scan

The `get` method retrieves a single item by its key using the Document Client.

When using the Document Client, how do you represent nested data like arrays or objects?

A As strings only

B As plain JavaScript arrays and objects

C You cannot store nested data

D Only as flat key-value pairs

The Document Client supports nested arrays and objects naturally, so you use plain JavaScript structures.

What is a key advantage of using the Document Client over the low-level DynamoDB API?

A Generates database schema

B Automatically scales the database

C Encrypts data automatically

D Simplifies data format handling

The Document Client simplifies how you handle data formats by converting types automatically.

Which of the following is NOT a feature of the DynamoDB Document Client?

A Automatic table creation

B Automatic type conversion

C Support for nested JSON documents

D Simplified API for CRUD operations

The Document Client does not create tables automatically; table management is separate.

Explain what the DynamoDB Document Client abstraction is and why it is useful.

Think about how it helps you avoid manual data type conversions.

Describe how you would use the Document Client to add and retrieve an item from a DynamoDB table.

Focus on the methods and data format used.

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