com.amazonaws.services.dynamodbv2.document.api

Interface QueryApi

All Known Implementing Classes:

Index, Table

@ThreadSafe
public interface QueryApi

A Table-centric Query API.

Method Summary

Methods

Modifier and Type	Method and Description
ItemCollection<QueryOutcome>	query(KeyAttribute hashKey) Retrieves items by the specified hash key.
ItemCollection<QueryOutcome>	query(KeyAttribute hashKey, RangeKeyCondition rangeKeyCondition) Retrieves items by the specified hash key and a range key condition.
ItemCollection<QueryOutcome>	query(KeyAttribute hashKey, RangeKeyCondition rangeKeyCondition, QueryFilter... queryFilters) Retrieves items by the specified hash key, a range key condition and a list of query filters.
ItemCollection<QueryOutcome>	query(KeyAttribute hashKey, RangeKeyCondition rangeKeyCondition, String filterExpression, Map<String,String> nameMap, Map<String,Object> valueMap) Retrieves items by the specified hash key, a range key condition, and a filter expression string.
ItemCollection<QueryOutcome>	query(KeyAttribute hashKey, RangeKeyCondition rangeKeyCondition, String filterExpression, String projectionExpression, Map<String,String> nameMap, Map<String,Object> valueMap) Retrieves items by the specified hash key, a range key condition, a filter expression and a projection expression.
ItemCollection<QueryOutcome>	query(QuerySpec spec) Queries table by specifying all the details.
ItemCollection<QueryOutcome>	query(String hashKeyName, Object hashKeyValue) Retrieves items by the specified hash key.
ItemCollection<QueryOutcome>	query(String hashKeyName, Object hashKeyValue, RangeKeyCondition rangeKeyCondition)
ItemCollection<QueryOutcome>	query(String hashKeyName, Object hashKeyValue, RangeKeyCondition rangeKeyCondition, QueryFilter... queryFilters)
ItemCollection<QueryOutcome>	query(String hashKeyName, Object hashKeyValue, RangeKeyCondition rangeKeyCondition, String filterExpression, Map<String,String> nameMap, Map<String,Object> valueMap)
ItemCollection<QueryOutcome>	query(String hashKeyName, Object hashKeyValue, RangeKeyCondition rangeKeyCondition, String filterExpression, String projectionExpression, Map<String,String> nameMap, Map<String,Object> valueMap) Retrieves items by the specified hash key, a range key condition, a filter expression and a projection expression.

Method Detail

query

ItemCollection<QueryOutcome> query(String hashKeyName,
                                 Object hashKeyValue)

Retrieves items by the specified hash key.

query

ItemCollection<QueryOutcome> query(KeyAttribute hashKey)

Retrieves items by the specified hash key.

query

ItemCollection<QueryOutcome> query(KeyAttribute hashKey,
                                 RangeKeyCondition rangeKeyCondition)

Retrieves items by the specified hash key and a range key condition.

query

ItemCollection<QueryOutcome> query(String hashKeyName,
                                 Object hashKeyValue,
                                 RangeKeyCondition rangeKeyCondition)

query

ItemCollection<QueryOutcome> query(KeyAttribute hashKey,
                                 RangeKeyCondition rangeKeyCondition,
                                 QueryFilter... queryFilters)

Retrieves items by the specified hash key, a range key condition and a list of query filters.

query

ItemCollection<QueryOutcome> query(String hashKeyName,
                                 Object hashKeyValue,
                                 RangeKeyCondition rangeKeyCondition,
                                 QueryFilter... queryFilters)

query

ItemCollection<QueryOutcome> query(KeyAttribute hashKey,
                                 RangeKeyCondition rangeKeyCondition,
                                 String filterExpression,
                                 Map<String,String> nameMap,
                                 Map<String,Object> valueMap)

Retrieves items by the specified hash key, a range key condition, and a filter expression string.

Parameters:

filterExpression - filter expression example: "(#a > :a) AND (#c > :c OR #e < :e)"

nameMap - actual values for the attribute-name place holders; can be null if there is no attribute-name placeholder.

valueMap - actual values for the value place holders can be null if there is no attribute-value placeholder.

query

ItemCollection<QueryOutcome> query(String hashKeyName,
                                 Object hashKeyValue,
                                 RangeKeyCondition rangeKeyCondition,
                                 String filterExpression,
                                 Map<String,String> nameMap,
                                 Map<String,Object> valueMap)

query

ItemCollection<QueryOutcome> query(KeyAttribute hashKey,
                                 RangeKeyCondition rangeKeyCondition,
                                 String filterExpression,
                                 String projectionExpression,
                                 Map<String,String> nameMap,
                                 Map<String,Object> valueMap)

Retrieves items by the specified hash key, a range key condition, a filter expression and a projection expression.

Parameters:

filterExpression - filter expression example: "(#a > :a) AND (#c > :c OR #e < :e)"

projectionExpression - projection expression example: "a.b, c[0].e"

nameMap - actual values for the attribute-name place holders; can be null if there is no attribute-name placeholder.

valueMap - actual values for the value place holders can be null if there is no attribute-value placeholder.

query

ItemCollection<QueryOutcome> query(String hashKeyName,
                                 Object hashKeyValue,
                                 RangeKeyCondition rangeKeyCondition,
                                 String filterExpression,
                                 String projectionExpression,
                                 Map<String,String> nameMap,
                                 Map<String,Object> valueMap)

Retrieves items by the specified hash key, a range key condition, a filter expression and a projection expression.

Parameters:

filterExpression - filter expression example: "(#a > :a) AND (#c > :c OR #e < :e)"

projectionExpression - projection expression example: "a.b, c[0].e"

nameMap - actual values for the attribute-name place holders; can be null if there is no attribute-name placeholder.

valueMap - actual values for the value place holders can be null if there is no attribute-value placeholder.

query

ItemCollection<QueryOutcome> query(QuerySpec spec)

Queries table by specifying all the details.