How to Sort Results in DynamoDB: Simple Guide

In DynamoDB, you sort results by using a Query operation on a table with a composite primary key, which includes a partition key and a sort key. Use the ScanIndexForward parameter set to true for ascending order or false for descending order to control the sorting of the results.

Syntax

The Query operation in DynamoDB allows sorting by the sort key. The key parts are:

• TableName: The name of your DynamoDB table.
• KeyConditionExpression: Defines the partition key and optionally conditions on the sort key.
• ScanIndexForward: A boolean that controls the sort order; true for ascending, false for descending.

javascript

const params = {
  TableName: 'YourTableName',
  KeyConditionExpression: '#pk = :pkval',
  ExpressionAttributeNames: {
    '#pk': 'PartitionKeyName'
  },
  ExpressionAttributeValues: {
    ':pkval': 'PartitionKeyValue'
  },
  ScanIndexForward: true // true = ascending, false = descending
};

Example

This example queries a DynamoDB table named Orders where the partition key is CustomerId and the sort key is OrderDate. It sorts the orders by date in descending order (newest first).

javascript

const AWS = require('aws-sdk');
const dynamodb = new AWS.DynamoDB.DocumentClient();

const params = {
  TableName: 'Orders',
  KeyConditionExpression: '#cid = :cid',
  ExpressionAttributeNames: {
    '#cid': 'CustomerId'
  },
  ExpressionAttributeValues: {
    ':cid': 'C123'
  },
  ScanIndexForward: false // descending order
};

dynamodb.query(params, (err, data) => {
  if (err) {
    console.error('Error querying:', err);
  } else {
    console.log('Sorted orders:', data.Items);
  }
});

Output

Sorted orders: [
  { CustomerId: 'C123', OrderDate: '2024-06-10', OrderId: 'O1003' },
  { CustomerId: 'C123', OrderDate: '2024-05-15', OrderId: 'O1002' },
  { CustomerId: 'C123', OrderDate: '2024-04-01', OrderId: 'O1001' }
]

Common Pitfalls

Many beginners try to sort results using Scan operations, but Scan does not support sorting. Sorting only works with Query on tables or indexes that have a sort key.

Also, remember that sorting is only possible on the sort key attribute, not on any other attribute.

javascript

/* Wrong: Trying to sort with Scan (no sorting possible) */
const wrongParams = {
  TableName: 'Orders'
  // ScanIndexForward has no effect on Scan
};

/* Right: Use Query with sort key and ScanIndexForward */
const rightParams = {
  TableName: 'Orders',
  KeyConditionExpression: '#cid = :cid',
  ExpressionAttributeNames: { '#cid': 'CustomerId' },
  ExpressionAttributeValues: { ':cid': 'C123' },
  ScanIndexForward: false
};

Quick Reference

Parameter	Description	Values
TableName	Name of the DynamoDB table	String
KeyConditionExpression	Condition to select partition key and sort key	String
ExpressionAttributeNames	Map of attribute name placeholders	Object
ExpressionAttributeValues	Map of attribute value placeholders	Object
ScanIndexForward	Sort order of results	true (ascending), false (descending)

Key Takeaways

Use Query operation with a sort key to sort DynamoDB results.

Set ScanIndexForward to true for ascending or false for descending order.

Scan operations do not support sorting.

Sorting only works on the sort key attribute, not on other attributes.

Always specify KeyConditionExpression to include the partition key.