Basic scan operation in DynamoDB - Mini Project: Build & Apply

Basic Scan Operation in DynamoDB

📖 Scenario: You are managing a small online bookstore. You want to retrieve all the books stored in your DynamoDB table to see what is available.

🎯 Goal: Build a simple DynamoDB scan operation to fetch all items from the Books table.

📋 What You'll Learn

Create a DynamoDB table named Books with sample book entries.

Set up a DynamoDB client configuration.

Write a scan operation to retrieve all items from the Books table.

Complete the scan request with the necessary parameters.

💡 Why This Matters

🌍 Real World

Scanning a DynamoDB table is a common task to retrieve all items when you want to display or process the entire dataset.

💼 Career

Understanding how to perform scan operations is essential for database administrators and backend developers working with AWS DynamoDB.

1

Create the Books table with sample data

Create a variable called books_table that represents a DynamoDB table named Books with these exact items: {'BookID': '1', 'Title': 'The Great Gatsby', 'Author': 'F. Scott Fitzgerald'} and {'BookID': '2', 'Title': '1984', 'Author': 'George Orwell'}.

DynamoDB

# Create the books_table variable with the specified items
# Your code here

Hint

Think of books_table as a list of dictionaries, each dictionary representing a book.

2

Set up the DynamoDB client configuration

Create a variable called dynamodb_client and set it to a dictionary with the key region_name and value 'us-east-1' to simulate the client configuration.

DynamoDB

books_table = [
    {'BookID': '1', 'Title': 'The Great Gatsby', 'Author': 'F. Scott Fitzgerald'},
    {'BookID': '2', 'Title': '1984', 'Author': 'George Orwell'}
]
# Create the dynamodb_client configuration dictionary
# Your code here

Hint

This simulates setting up the DynamoDB client with a region.

3

Write the scan operation to retrieve all items

Create a variable called scan_params and set it to a dictionary with the key TableName and value 'Books' to prepare the scan parameters.

DynamoDB

books_table = [
    {'BookID': '1', 'Title': 'The Great Gatsby', 'Author': 'F. Scott Fitzgerald'},
    {'BookID': '2', 'Title': '1984', 'Author': 'George Orwell'}
]
dynamodb_client = {'region_name': 'us-east-1'}
# Create the scan_params dictionary with TableName 'Books'
# Your code here

Hint

The scan parameters tell DynamoDB which table to scan.

4

Complete the scan request

Create a variable called scan_request and set it to a dictionary with keys Client and Params set to dynamodb_client and scan_params respectively to represent the full scan request.

DynamoDB

books_table = [
    {'BookID': '1', 'Title': 'The Great Gatsby', 'Author': 'F. Scott Fitzgerald'},
    {'BookID': '2', 'Title': '1984', 'Author': 'George Orwell'}
]
dynamodb_client = {'region_name': 'us-east-1'}
scan_params = {'TableName': 'Books'}
# Create the scan_request dictionary with Client and Params keys
# Your code here

Hint

This dictionary represents the full scan request to DynamoDB.

Practice

1. What does the scan operation do in DynamoDB?

easy

A. Reads all items in a table

B. Reads only one item by key

C. Deletes items from a table

D. Updates items in a table

Solution

1. Step 1: Understand the scan operation

   The scan operation reads every item in the DynamoDB table without filtering by key.

2. Step 2: Compare with other operations

   Unlike get or query, scan reads all items, not just specific keys.

3. Final Answer:

   Reads all items in a table -> Option A

4. Quick Check:

   Scan = Reads all items [OK]

Hint: Scan reads entire table, not just keys [OK]

Common Mistakes:

• Confusing scan with get or query
• Thinking scan deletes or updates data
• Assuming scan reads only filtered items

2. Which of the following is the correct syntax to perform a scan operation using AWS SDK for JavaScript v3?

easy

A. const data = await client.get({ TableName: 'MyTable' });

B. const data = await client.query({ TableName: 'MyTable' });

C. const data = await client.scan({ TableName: 'MyTable' });

D. const data = await client.delete({ TableName: 'MyTable' });

Solution

1. Step 1: Identify scan method usage

   The scan method is called on the DynamoDB client with parameters including TableName.

2. Step 2: Check other methods

   Get, query, and delete are different operations and do not perform scan.

3. Final Answer:

   const data = await client.scan({ TableName: 'MyTable' }); -> Option C

4. Quick Check:

   Scan syntax uses client.scan() [OK]

Hint: Scan uses client.scan() with TableName [OK]

Common Mistakes:

• Using get or query instead of scan
• Missing await keyword
• Wrong method names like delete

3. Given a DynamoDB table with 3 items: {id:1, name:'A'}, {id:2, name:'B'}, {id:3, name:'C'}, what will the scan operation return?

medium

A. [{id:1, name:'A'}, {id:2, name:'B'}, {id:3, name:'C'}]

B. Error: No items found

C. []

D. [{id:1, name:'A'}]

Solution

1. Step 1: Understand scan returns all items

   Scan reads every item in the table, so all 3 items will be returned.

2. Step 2: Check options for completeness

   Only [{id:1, name:'A'}, {id:2, name:'B'}, {id:3, name:'C'}] lists all 3 items; others are incomplete or errors.

3. Final Answer:

   [{id:1, name:'A'}, {id:2, name:'B'}, {id:3, name:'C'}] -> Option A

4. Quick Check:

   Scan returns all items [OK]

Hint: Scan returns full table items list [OK]

Common Mistakes:

• Expecting scan to return only one item
• Thinking scan returns empty if no filter
• Confusing scan with query results

4. You wrote this code to scan a DynamoDB table but get no results:

const params = { TableName: 'MyTable', FilterExpression: 'age > :val', ExpressionAttributeValues: { ':val': 30 } };
const data = await client.scan(params);

What is the likely problem?

medium

A. TableName is missing in params

B. FilterExpression syntax is incorrect, causing scan to fail

C. Scan does not support FilterExpression

D. FilterExpression is applied after scan reads all items, so no items match age > 30

Solution

1. Step 1: Understand FilterExpression in scan

   FilterExpression filters results after scanning all items; if no items match, result is empty.

2. Step 2: Check syntax and params

   Syntax is correct, TableName is present, and scan supports FilterExpression.

3. Final Answer:

   FilterExpression is applied after scan reads all items, so no items match age > 30 -> Option D

4. Quick Check:

   FilterExpression filters after scan [OK]

Hint: FilterExpression filters after scan reads all items [OK]

Common Mistakes:

• Thinking FilterExpression prevents scanning items
• Assuming scan fails with FilterExpression
• Missing TableName parameter

5. You want to scan a large DynamoDB table but only retrieve items where status is 'active'. Which approach is best to reduce data returned and improve performance?

hard

A. Use scan with FilterExpression 'status = :s' and ExpressionAttributeValues { ':s': 'active' }

B. Use query operation with status as partition key

C. Use scan without filters and filter results in application code

D. Use scan with ProjectionExpression to get only 'status' attribute

Solution

1. Step 1: Understand scan vs query

   Scan reads entire table; query reads items by key, more efficient for filtering.

2. Step 2: Check if status can be partition key

   If status is partition key, query can efficiently get only 'active' items without scanning all.

3. Step 3: Evaluate other options

   FilterExpression filters after scan, so less efficient; filtering in app wastes bandwidth; ProjectionExpression only limits attributes, not items.

4. Final Answer:

   Use query operation with status as partition key -> Option B

5. Quick Check:

   Query with key filters efficiently [OK]

Hint: Query by key is faster than scan with filters [OK]

Common Mistakes:

• Relying on scan with filters for large tables
• Filtering data in application instead of query
• Confusing ProjectionExpression with filtering items