Menu
Amazon DynamoDB
Getting Started Guide (API Version 2012-08-10)

Step 4: Query and Scan the Data

You can use the query method to retrieve data from a table. You must specify a partition key value; the sort key is optional.

The primary key for the Movies table is composed of the following:

  • year – The partition key. The attribute type is number. 

  • title – The sort key. The attribute type is string.

To find all movies released during a year, you need to specify only the year. You can also provide the title to retrieve a subset of movies based on some condition (on the sort key). For example, to find movies released in 2014 that have a title starting with the letter "A".

In addition to query, there is also a scan method that can retrieve all of the table data.

To learn more about querying and scanning data, see Query and Scan in the Amazon DynamoDB Developer Guide.

Step 4.1: Query

The code included in this step performs the following queries:

  • Retrieve all movies release in year 1985.

  • Retrieve all movies released in year 1992, with title beginning with the letter "A" through the letter "L".

  1. Copy the following program into your Java development environment.

    // Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    // Licensed under the Apache License, Version 2.0.
    
    package com.amazonaws.codesamples.gsg;
    
    import java.util.HashMap;
    import java.util.Iterator;
    
    import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
    import com.amazonaws.services.dynamodbv2.document.DynamoDB;
    import com.amazonaws.services.dynamodbv2.document.Item;
    import com.amazonaws.services.dynamodbv2.document.ItemCollection;
    import com.amazonaws.services.dynamodbv2.document.QueryOutcome;
    import com.amazonaws.services.dynamodbv2.document.Table;
    import com.amazonaws.services.dynamodbv2.document.spec.QuerySpec;
    import com.amazonaws.services.dynamodbv2.document.utils.NameMap;
    
    public class MoviesQuery {
    
        public static void main(String[] args) throws Exception {
    
            AmazonDynamoDBClient client = new AmazonDynamoDBClient()
                .withEndpoint("http://localhost:8000");
    
            DynamoDB dynamoDB = new DynamoDB(client);
    
            Table table = dynamoDB.getTable("Movies");
    
            HashMap<String, String> nameMap = new HashMap<String, String>();
            nameMap.put("#yr", "year");
    
            HashMap<String, Object> valueMap = new HashMap<String, Object>();
            valueMap.put(":yyyy", 1985);
    
            QuerySpec querySpec = new QuerySpec()
                .withKeyConditionExpression("#yr = :yyyy")
                .withNameMap(nameMap)
                .withValueMap(valueMap);
    
            ItemCollection<QueryOutcome> items = null;
            Iterator<Item> iterator = null;
            Item item = null;
    
            try {
                System.out.println("Movies from 1985");
                items = table.query(querySpec);
    
                iterator = items.iterator();
                while (iterator.hasNext()) {
                    item = iterator.next();
                    System.out.println(item.getNumber("year") + ": "
                            + item.getString("title"));
                }
    
            } catch (Exception e) {
                System.err.println("Unable to query movies from 1985");
                System.err.println(e.getMessage());
            }
    
            valueMap.put(":yyyy", 1992);
            valueMap.put(":letter1", "A");
            valueMap.put(":letter2", "L");
    
            querySpec
                    .withProjectionExpression(
                            "#yr, title, info.genres, info.actors[0]")
                    .withKeyConditionExpression(
                            "#yr = :yyyy and title between :letter1 and :letter2")
                    .withNameMap(nameMap).withValueMap(valueMap);
    
            try {
                System.out
                        .println("Movies from 1992 - titles A-L, with genres and lead actor");
                items = table.query(querySpec);
    
                iterator = items.iterator();
                while (iterator.hasNext()) {
                    item = iterator.next();
                    System.out.println(item.getNumber("year") + ": "
                            + item.getString("title") + " " + item.getMap("info"));
                }
    
            } catch (Exception e) {
                System.err.println("Unable to query movies from 1992:");
                System.err.println(e.getMessage());
            }
        }
    }
    

    Note

    • nameMap provides name substitution. We use this because year is a reserved word in DynamoDB—you cannot use it directly in any expression, including KeyConditionExpression. We use the expression attribute name #yr to address this.

    • valueMap provides value substitution. We use this because you cannot use literals in any expression, including KeyConditionExpression. We use the expression attribute value :yyyy to address this.

    First, you create the querySpec object, which describes the query parameters, and then you pass the object to the query method.

  2. Compile and run the program.

Note

The preceding program shows how to query a table by its primary key attributes. In DynamoDB, you can optionally create one or more secondary indexes on a table, and query those indexes in the same way that you query a table. Secondary indexes give your applications additional flexibility by allowing queries on non-key attributes. For more information about secondary indexes, see Secondary Indexes in the Amazon DynamoDB Developer Guide.

Step 4.2: Scan

The scan method reads every item in the entire table, and returns all of the data in the table. You can provide an optional filter_expression, so that only the items matching your criteria are returned. However, note that the filter is only applied after the entire table has been scanned.

The following program scans the entire Movies table, which contains approximately 5,000 items. The scan specifies the optional filter to retrieve only the movies from the 1950s (approximately 100 items), and discard all of the others.

  1. Copy the following program into your Java development environment.

    // Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    // Licensed under the Apache License, Version 2.0.
    
    package com.amazonaws.codesamples.gsg;
    
    import java.util.Iterator;
    
    import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClient;
    import com.amazonaws.services.dynamodbv2.document.DynamoDB;
    import com.amazonaws.services.dynamodbv2.document.Item;
    import com.amazonaws.services.dynamodbv2.document.ItemCollection;
    import com.amazonaws.services.dynamodbv2.document.ScanOutcome;
    import com.amazonaws.services.dynamodbv2.document.Table;
    import com.amazonaws.services.dynamodbv2.document.spec.ScanSpec;
    import com.amazonaws.services.dynamodbv2.document.utils.NameMap;
    import com.amazonaws.services.dynamodbv2.document.utils.ValueMap;
    
    public class MoviesScan {
    
        public static void main(String[] args) throws Exception {
    
            AmazonDynamoDBClient client = new AmazonDynamoDBClient()
                .withEndpoint("http://localhost:8000");
    
            DynamoDB dynamoDB = new DynamoDB(client);
    
            Table table = dynamoDB.getTable("Movies");
    
            ScanSpec scanSpec = new ScanSpec()
                .withProjectionExpression("#yr, title, info.rating")
                .withFilterExpression("#yr between :start_yr and :end_yr")
                .withNameMap(new NameMap().with("#yr",  "year"))
                .withValueMap(new ValueMap().withNumber(":start_yr", 1950).withNumber(":end_yr", 1959));
    
            try {
                ItemCollection<ScanOutcome> items = table.scan(scanSpec);
    
                Iterator<Item> iter = items.iterator();
                while (iter.hasNext()) {
                    Item item = iter.next();
                    System.out.println(item.toString());
                }
                
            } catch (Exception e) {
                System.err.println("Unable to scan the table:");
                System.err.println(e.getMessage());
            }
        }
    }

    In the code, note the following:

    • ProjectionExpression specifies the attributes you want in the scan result.

    • FilterExpression specifies a condition that returns only items that satisfy the condition. All other items are discarded.

  2. Compile and run the program.

Note

You can also use the Scan operation with any secondary indexes that you have created on the table. For more information about secondary indexes, see Secondary Indexes in the Amazon DynamoDB Developer Guide.

Next Step

Step 5: (Optional) Delete the Table