Querying GSI in DynamoDB - Step-by-Step Execution

Concept Flow - Querying GSI

Start Query

↓

Specify GSI Name

↓

Set KeyConditionExpression on GSI

↓

Send Query to DynamoDB

↓

DynamoDB Searches GSI

↓

Return Matching Items

↓

Process Results

The query starts by specifying the GSI name and key condition, then DynamoDB searches the GSI and returns matching items.

Execution Sample

DynamoDB

query_params = {
  'TableName': 'Orders',
  'IndexName': 'CustomerIndex',
  'KeyConditionExpression': 'CustomerId = :cid',
  'ExpressionAttributeValues': { ':cid': { 'S': 'C123' } }
}
result = dynamodb.query(query_params)

This code queries the 'Orders' table using the 'CustomerIndex' GSI to find orders for customer 'C123'.

Execution Table

Step	Action	Parameter/Value	DynamoDB Internal Process	Result
1	Start Query	TableName='Orders'	Prepare to query 'Orders' table	Ready to query
2	Specify GSI	IndexName='CustomerIndex'	Use GSI 'CustomerIndex' instead of main table index	GSI selected
3	Set KeyConditionExpression	CustomerId = :cid	Filter items where CustomerId equals 'C123'	Condition set
4	Set ExpressionAttributeValues	:cid = 'C123'	Bind value 'C123' to :cid	Value bound
5	Send Query	Execute query with parameters	DynamoDB searches GSI for matching items	Query sent
6	DynamoDB Search	Search GSI for CustomerId='C123'	Scan GSI partitions for matching keys	Matching items found
7	Return Results	Return matching items	Send items back to client	Items received
8	Process Results	Client processes returned items	Display or use data	Query complete

💡 Query completes after DynamoDB returns all matching items from the specified GSI.

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	After Step 5	Final
query_params	{}	{ 'TableName': 'Orders', 'IndexName': 'CustomerIndex' }	{ 'TableName': 'Orders', 'IndexName': 'CustomerIndex', 'KeyConditionExpression': 'CustomerId = :cid' }	{ 'TableName': 'Orders', 'IndexName': 'CustomerIndex', 'KeyConditionExpression': 'CustomerId = :cid', 'ExpressionAttributeValues': { ':cid': { 'S': 'C123' } } }	Sent to DynamoDB for query	Sent to DynamoDB for query

Key Moments - 3 Insights

Why do we need to specify the IndexName when querying a GSI?

Because without specifying IndexName, DynamoDB queries the main table's primary key. Specifying IndexName tells DynamoDB to use the GSI instead, as shown in execution_table step 2.

Can we use the main table's primary key attributes in the KeyConditionExpression when querying a GSI?

No, the KeyConditionExpression must use the GSI's key attributes. This is shown in step 3 where the condition uses 'CustomerId', which is the GSI partition key.

What happens if no items match the KeyConditionExpression in the GSI?

DynamoDB returns an empty result set. The query still completes successfully as shown in step 7, but with zero items.

Visual Quiz - 3 Questions

Look at the execution_table, at which step is the GSI specified for the query?

A Step 2

B Step 3

C Step 5

D Step 7

💡 Hint

Check the 'Action' and 'Parameter/Value' columns in execution_table row for step 2.

According to variable_tracker, what is the value of query_params after step 4?

A { TableName: 'Orders', IndexName: 'CustomerIndex' }

B { 'TableName': 'Orders', 'IndexName': 'CustomerIndex', 'KeyConditionExpression': 'CustomerId = :cid', 'ExpressionAttributeValues': { ':cid': { 'S': 'C123' } } }

C { TableName: 'Orders', IndexName: 'CustomerIndex', KeyConditionExpression: 'CustomerId = :cid' }

D {}

💡 Hint

Look at the 'After Step 4' column in variable_tracker for query_params.

If we omit the IndexName parameter, what will DynamoDB query according to the concept_flow?

A The specified GSI

B An error is thrown

C The main table's primary key

D All indexes are queried

💡 Hint

Refer to concept_flow where specifying GSI is a separate step before querying.

Concept Snapshot

Querying a GSI in DynamoDB:
- Use 'IndexName' to specify the GSI.
- KeyConditionExpression must use GSI keys.
- ExpressionAttributeValues bind values.
- DynamoDB returns matching items from the GSI.
- Without IndexName, main table is queried.

Full Transcript

This visual execution trace shows how to query a Global Secondary Index (GSI) in DynamoDB. First, you prepare query parameters including the table name and specify the GSI name using 'IndexName'. Then, you set a KeyConditionExpression using the GSI's key attributes and bind values with ExpressionAttributeValues. When the query is sent, DynamoDB searches the GSI for matching items and returns them. The variable tracker shows how the query parameters build up step-by-step. Key moments clarify why specifying the GSI is necessary and how the query behaves if no items match. The quiz questions test understanding of these steps and parameters.

Practice

1. What is the main purpose of querying a Global Secondary Index (GSI) in DynamoDB?

easy

A. To delete items from the table

B. To create a backup of the table

C. To update the primary key of items

D. To find items using an alternate key without scanning the whole table

Solution

1. Step 1: Understand what a GSI is used for

   A GSI allows querying data using a different key than the primary key.

2. Step 2: Identify the main benefit of querying a GSI

   Querying a GSI helps find items quickly without scanning the entire table.

3. Final Answer:

   To find items using an alternate key without scanning the whole table -> Option D

4. Quick Check:

   Query GSI = alternate key search [OK]

Hint: GSI lets you search by different keys fast [OK]

Common Mistakes:

• Confusing GSI query with table scan
• Thinking GSI is for deleting or updating keys
• Assuming GSI creates backups

2. Which of the following is the correct way to specify a GSI name in a DynamoDB query using AWS SDK?

easy

A. query({ TableName: 'MyTable', Index: 'MyGSI', KeyConditionExpression: 'GSIKey = :val', ExpressionAttributeValues: { ':val': '123' } })

B. query({ TableName: 'MyTable', KeyName: 'MyGSI', KeyConditionExpression: 'GSIKey = :val', ExpressionAttributeValues: { ':val': '123' } })

C. query({ TableName: 'MyTable', IndexName: 'MyGSI', KeyConditionExpression: 'GSIKey = :val', ExpressionAttributeValues: { ':val': '123' } })

D. query({ TableName: 'MyTable', GSIName: 'MyGSI', KeyConditionExpression: 'GSIKey = :val', ExpressionAttributeValues: { ':val': '123' } })

Solution

1. Step 1: Recall the correct parameter name for GSI in DynamoDB query

   The correct parameter to specify a GSI is 'IndexName'.

2. Step 2: Check the options for correct syntax

   Only query({ TableName: 'MyTable', IndexName: 'MyGSI', KeyConditionExpression: 'GSIKey = :val', ExpressionAttributeValues: { ':val': '123' } }) uses 'IndexName' correctly with other required fields.

3. Final Answer:

   query({ TableName: 'MyTable', IndexName: 'MyGSI', KeyConditionExpression: 'GSIKey = :val', ExpressionAttributeValues: { ':val': '123' } }) -> Option C

4. Quick Check:

   Use IndexName to specify GSI [OK]

Hint: Use 'IndexName' to specify GSI in query params [OK]

Common Mistakes:

• Using 'KeyName' or 'GSIName' instead of 'IndexName'
• Omitting ExpressionAttributeValues
• Wrong key condition syntax

3. Given a DynamoDB table with a GSI named 'StatusIndex' on attribute 'status', what will the following query return?

query({ TableName: 'Orders', IndexName: 'StatusIndex', KeyConditionExpression: 'status = :s', ExpressionAttributeValues: { ':s': 'shipped' } })

medium

A. All orders with status 'shipped' using the GSI

B. All orders regardless of status

C. An error because 'status' is not the primary key

D. No results because GSI queries are not supported

Solution

1. Step 1: Understand the query parameters

   The query uses 'StatusIndex' GSI with a key condition on 'status' = 'shipped'.

2. Step 2: Determine what the query returns

   It returns all items where 'status' attribute equals 'shipped' using the GSI, which is designed for this attribute.

3. Final Answer:

   All orders with status 'shipped' using the GSI -> Option A

4. Quick Check:

   Query GSI by status = shipped returns matching items [OK]

Hint: Query GSI with key condition returns matching items [OK]

Common Mistakes:

• Thinking GSI query returns all items
• Assuming GSI query causes error if attribute not primary key
• Believing GSI queries are unsupported

4. You wrote this DynamoDB query to use a GSI but get an error:

query({ TableName: 'Products', IndexName: 'CategoryIndex', KeyConditionExpression: 'category = :c', ExpressionAttributeValues: { ':c': 'books' } })

What is the most likely cause of the error?

medium

A. You cannot query a GSI in DynamoDB

B. The attribute 'category' is not the partition key of the GSI 'CategoryIndex'

C. ExpressionAttributeValues is missing a value

D. The table name 'Products' is incorrect

Solution

1. Step 1: Understand GSI key requirements

   When querying a GSI, the KeyConditionExpression must use the GSI's partition key attribute.

2. Step 2: Identify the error cause

   If 'category' is not the partition key of 'CategoryIndex', the query will fail with an error.

3. Final Answer:

   The attribute 'category' is not the partition key of the GSI 'CategoryIndex' -> Option B

4. Quick Check:

   GSI query key must be GSI partition key [OK]

Hint: GSI query key must match GSI partition key [OK]

Common Mistakes:

• Using a non-key attribute in KeyConditionExpression
• Assuming table name typo causes this error
• Believing GSI queries are unsupported

5. You have a DynamoDB table 'Employees' with a GSI named 'DeptIndex' where the partition key is 'department' and sort key is 'hireDate'. You want to find all employees in 'Sales' hired after '2023-01-01'. Which query is correct?

hard

A. query({ TableName: 'Employees', IndexName: 'DeptIndex', KeyConditionExpression: 'department = :d AND hireDate > :h', ExpressionAttributeValues: { ':d': 'Sales', ':h': '2023-01-01' } })

B. query({ TableName: 'Employees', IndexName: 'DeptIndex', KeyConditionExpression: 'department = :d OR hireDate > :h', ExpressionAttributeValues: { ':d': 'Sales', ':h': '2023-01-01' } })

C. query({ TableName: 'Employees', KeyConditionExpression: 'department = :d AND hireDate > :h', ExpressionAttributeValues: { ':d': 'Sales', ':h': '2023-01-01' } })

D. query({ TableName: 'Employees', IndexName: 'DeptIndex', FilterExpression: 'department = :d AND hireDate > :h', ExpressionAttributeValues: { ':d': 'Sales', ':h': '2023-01-01' } })

Solution

1. Step 1: Use the GSI name and correct key condition

   Query must specify 'IndexName' as 'DeptIndex' and use KeyConditionExpression with partition key and sort key conditions.

2. Step 2: Check logical operators and expressions

   KeyConditionExpression supports 'AND' for partition key and sort key conditions; 'OR' is invalid here.

3. Step 3: Verify FilterExpression usage

   FilterExpression filters after query; it cannot replace KeyConditionExpression for keys.

4. Final Answer:

   query({ TableName: 'Employees', IndexName: 'DeptIndex', KeyConditionExpression: 'department = :d AND hireDate > :h', ExpressionAttributeValues: { ':d': 'Sales', ':h': '2023-01-01' } }) -> Option A

5. Quick Check:

   Use KeyConditionExpression with AND on GSI keys [OK]

Hint: Use AND in KeyConditionExpression for partition and sort keys [OK]

Common Mistakes:

• Using OR instead of AND in KeyConditionExpression
• Omitting IndexName for GSI query
• Using FilterExpression instead of KeyConditionExpression for keys