Sort key purpose and usage in DynamoDB

Introduction

A sort key helps organize and find related data quickly within the same group in a DynamoDB table.

You want to store multiple items that share a common identifier but differ in some detail.

You need to retrieve items in a specific order, like recent orders by date.

You want to filter or query items efficiently within a group.

You want to model one-to-many relationships, like a user and their posts.

You want to avoid scanning the whole table by narrowing down your search.

Syntax

DynamoDB

CreateTable {
  TableName: string,
  KeySchema: [
    { AttributeName: string, KeyType: 'HASH' },  // Partition key
    { AttributeName: string, KeyType: 'RANGE' }  // Sort key
  ],
  AttributeDefinitions: [
    { AttributeName: string, AttributeType: 'S' | 'N' | 'B' }
  ],
  ProvisionedThroughput: {
    ReadCapacityUnits: number,
    WriteCapacityUnits: number
  }
}

The partition key groups items, and the sort key orders items within that group.

Sort key is optional but useful for organizing related data.

Examples

This example uses 'UserID' as the partition key and 'Timestamp' as the sort key to store user events in order.

DynamoDB

KeySchema: [
  { AttributeName: 'UserID', KeyType: 'HASH' },
  { AttributeName: 'Timestamp', KeyType: 'RANGE' }
]

This example uses only a partition key without a sort key, so each item must have a unique 'OrderID'.

DynamoDB

KeySchema: [
  { AttributeName: 'OrderID', KeyType: 'HASH' }
]

Sample Program

This example creates a table with a partition key 'UserID' and a sort key 'MessageID'. It inserts two messages for the same user and queries them ordered by 'MessageID'.

DynamoDB

CreateTable {
  TableName: 'UserMessages',
  KeySchema: [
    { AttributeName: 'UserID', KeyType: 'HASH' },
    { AttributeName: 'MessageID', KeyType: 'RANGE' }
  ],
  AttributeDefinitions: [
    { AttributeName: 'UserID', AttributeType: 'S' },
    { AttributeName: 'MessageID', AttributeType: 'S' }
  ],
  ProvisionedThroughput: {
    ReadCapacityUnits: 5,
    WriteCapacityUnits: 5
  }
}

-- Insert messages for user 'user123'
PutItem {
  TableName: 'UserMessages',
  Item: { UserID: 'user123', MessageID: 'msg001', Content: 'Hello!' }
}
PutItem {
  TableName: 'UserMessages',
  Item: { UserID: 'user123', MessageID: 'msg002', Content: 'How are you?' }
}

-- Query messages for 'user123' ordered by MessageID
Query {
  TableName: 'UserMessages',
  KeyConditionExpression: 'UserID = :uid',
  ExpressionAttributeValues: { ':uid': 'user123' }
}

Important Notes

Sort keys let you store multiple items with the same partition key but different sort keys.

Queries using sort keys are faster than scanning the whole table.

You can use operators like BETWEEN or begins_with on sort keys to filter results.

Summary

The sort key organizes related items within the same partition key group.

It helps retrieve data in order and filter efficiently.

Using a sort key models one-to-many relationships in DynamoDB.

Practice

1. What is the main purpose of a sort key in a DynamoDB table?

easy

A. To store large binary data efficiently

B. To uniquely identify each item across all partitions

C. To organize and order items within the same partition key

D. To encrypt data at rest automatically

Solution

1. Step 1: Understand partition and sort keys roles

   The partition key groups items, and the sort key orders items within that group.

2. Step 2: Identify the sort key's purpose

   The sort key organizes related items so they can be retrieved in order and filtered efficiently.

3. Final Answer:

   To organize and order items within the same partition key -> Option C

4. Quick Check:

   Sort key = Organize items in partition [OK]

Hint: Sort key orders items inside a partition [OK]

Common Mistakes:

• Confusing sort key with partition key uniqueness
• Thinking sort key encrypts data
• Assuming sort key stores large binary data

2. Which of the following is the correct way to define a DynamoDB table with a partition key named UserID and a sort key named Timestamp using AWS CLI?

easy

A. aws dynamodb create-table --table-name MyTable --attribute-definitions AttributeName=Timestamp,AttributeType=N --key-schema AttributeName=Timestamp,KeyType=HASH --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5

B. aws dynamodb create-table --table-name MyTable --attribute-definitions AttributeName=UserID,AttributeType=S AttributeName=Timestamp,AttributeType=N --key-schema AttributeName=UserID,KeyType=HASH AttributeName=Timestamp,KeyType=HASH --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5

C. aws dynamodb create-table --table-name MyTable --attribute-definitions AttributeName=UserID,AttributeType=S --key-schema AttributeName=UserID,KeyType=RANGE --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5

D. aws dynamodb create-table --table-name MyTable --attribute-definitions AttributeName=UserID,AttributeType=S AttributeName=Timestamp,AttributeType=N --key-schema AttributeName=UserID,KeyType=HASH AttributeName=Timestamp,KeyType=RANGE --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5

Solution

1. Step 1: Check attribute definitions and key schema

   Partition key must have KeyType=HASH and sort key must have KeyType=RANGE.

2. Step 2: Verify aws dynamodb create-table --table-name MyTable --attribute-definitions AttributeName=UserID,AttributeType=S AttributeName=Timestamp,AttributeType=N --key-schema AttributeName=UserID,KeyType=HASH AttributeName=Timestamp,KeyType=RANGE --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 matches correct key types

   aws dynamodb create-table --table-name MyTable --attribute-definitions AttributeName=UserID,AttributeType=S AttributeName=Timestamp,AttributeType=N --key-schema AttributeName=UserID,KeyType=HASH AttributeName=Timestamp,KeyType=RANGE --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 uses UserID as HASH and Timestamp as RANGE, which is correct.

3. Final Answer:

   aws dynamodb create-table --table-name MyTable --attribute-definitions AttributeName=UserID,AttributeType=S AttributeName=Timestamp,AttributeType=N --key-schema AttributeName=UserID,KeyType=HASH AttributeName=Timestamp,KeyType=RANGE --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 -> Option D

4. Quick Check:

   Partition=HASH, Sort=RANGE in CLI [OK]

Hint: Sort key uses KeyType=RANGE in key schema [OK]

Common Mistakes:

• Using KeyType=HASH for both keys
• Missing sort key in key schema
• Defining only partition key without sort key

3. Given a DynamoDB table with partition key UserID and sort key OrderDate, what will the following query return?

aws dynamodb query --table-name Orders --key-condition-expression "UserID = :uid AND OrderDate > :date" --expression-attribute-values '{":uid":{"S":"user123"}, ":date":{"S":"2023-01-01"}}'

medium

A. All orders for user123 with OrderDate after 2023-01-01, sorted by OrderDate

B. All orders for user123 regardless of OrderDate

C. All orders with OrderDate after 2023-01-01 for all users

D. Syntax error due to missing partition key in condition

Solution

1. Step 1: Analyze the key condition expression

   The query filters items where UserID equals 'user123' and OrderDate is greater than '2023-01-01'.

2. Step 2: Understand query behavior with partition and sort keys

   Query returns items for one partition key, ordered by sort key, filtered by the condition on sort key.

3. Final Answer:

   All orders for user123 with OrderDate after 2023-01-01, sorted by OrderDate -> Option A

4. Quick Check:

   Query filters by partition and sort key conditions [OK]

Hint: Query needs partition key equality and sort key condition [OK]

Common Mistakes:

• Expecting query to filter across all partitions
• Ignoring sort key condition in query
• Confusing query with scan operation

4. You wrote this DynamoDB query but it returns an error:

aws dynamodb query --table-name Sales --key-condition-expression "OrderID > :oid" --expression-attribute-values '{":oid":{"S":"1000"}}'

What is the likely cause?

medium

A. Using > operator on partition key is allowed

B. Missing partition key equality condition in key-condition-expression

C. Incorrect data type for expression attribute value

D. Missing sort key in attribute definitions

Solution

1. Step 1: Recall query key condition requirements

   DynamoDB query requires partition key equality condition in key-condition-expression.

2. Step 2: Identify error cause

   Query uses only 'OrderID > :oid' without partition key equality, causing error.

3. Final Answer:

   Missing partition key equality condition in key-condition-expression -> Option B

4. Quick Check:

   Partition key equality is mandatory in query [OK]

Hint: Query must have partition key equality condition [OK]

Common Mistakes:

• Using range operators on partition key
• Omitting partition key in query condition
• Confusing query with scan operation

5. You want to model a one-to-many relationship where each CustomerID can have multiple Invoices sorted by InvoiceDate. Which DynamoDB table design best uses the sort key to achieve this?

hard

A. Partition key: CustomerID, Sort key: InvoiceDate

B. Partition key: InvoiceDate, Sort key: CustomerID

C. Partition key: CustomerID only, no sort key

D. Partition key: InvoiceID, Sort key: InvoiceDate

Solution

1. Step 1: Understand one-to-many modeling in DynamoDB

   Use partition key for the 'one' side and sort key to order the 'many' items.

2. Step 2: Apply to CustomerID and Invoices

   CustomerID as partition key groups invoices; InvoiceDate as sort key orders them.

3. Final Answer:

   Partition key: CustomerID, Sort key: InvoiceDate -> Option A

4. Quick Check:

   Sort key models one-to-many order [OK]

Hint: Partition key = one side, sort key = many side order [OK]

Common Mistakes:

• Swapping partition and sort keys
• Not using sort key for ordering
• Using only partition key losing order info