Query Global Secondary Index in DynamoDB Using Java (Guide w/ Code Examples)

To query a global secondary index (GSI) in a DynamoDB table in Java, you can use the query method of the AmazonDynamoDB client by providing the GSI Name, Table Name, and Key Condition Expression.

In the below example, YourTableName is the name of the table that contains the GSI you want to query, YourGSI is the name of the GSI you want to query, GSIKeyAttribute is the name of the key attribute on the GSI, and YourSearchValue is the value you want to search for in the GSI.

import com.amazonaws.services.dynamodbv2.AmazonDynamoDB;
import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClientBuilder;
import com.amazonaws.services.dynamodbv2.model.Attribute.Attributevalue;
import com.amazonaws.services.dynamodbv2.model.queryrequest;
import com.amazonaws.services.dynamodbv2.model.queryresult;

public class DynamoDBQueryGSIExample {
    public static void main(String[] args) {
        AmazonDynamoDB client = AmazonDynamoDBClientBuilder.defaultClient();

        QueryRequest request = new QueryRequest()
            .withTableName("YourTableName")
            .withIndexName("YourGSI")
            .withKeyConditionExpression("GSIKeyAttribute = :value")
            .withExpressionAttributeValues(
                new AttributeValue().withS(":value", "YourSearchValue"));
        QueryResult result = client.query(request);

        System.out.println("Query successful!");
        System.out.println(result);
    }
}