com.amazonaws.services.dynamodbv2.document

Class Index

java.lang.Object

com.amazonaws.services.dynamodbv2.document.Index

All Implemented Interfaces:

QueryApi

@ThreadSafe
public class Index
extends Object
implements QueryApi

Represents a secondary index on a DynamoDB table. This covers both GSI (Global Secondary Index) and LSI (Local Secondary Index). Instance of this class can be obtained via Table.getIndex(String).

Method Summary

Methods

Modifier and Type	Method and Description
String	getIndexName()
Table	getTable() Returns the owning table.
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 projectionExpression, String filterExpression, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTable

public final Table getTable()

Returns the owning table.

getIndexName

public final String getIndexName()

Returns:

the name of this index

query

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

Description copied from interface: QueryApi

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

Specified by:

query in interface QueryApi

query

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

Description copied from interface: QueryApi

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

Specified by:

query in interface QueryApi

query

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

Description copied from interface: QueryApi

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

Specified by:

query in interface QueryApi

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

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

Description copied from interface: QueryApi

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

Specified by:

query in interface QueryApi

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

filterExpression - 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

public ItemCollection<QueryOutcome> query(QuerySpec spec)

Description copied from interface: QueryApi

Queries table by specifying all the details.

Specified by:

query in interface QueryApi

query

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

Description copied from interface: QueryApi

Retrieves items by the specified hash key.

Specified by:

query in interface QueryApi

query

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

Specified by:

query in interface QueryApi

query

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

Specified by:

query in interface QueryApi

query

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

Specified by:

query in interface QueryApi

query

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

Description copied from interface: QueryApi

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

Specified by:

query in interface QueryApi

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

public ItemCollection<QueryOutcome> query(KeyAttribute hashKey)

Description copied from interface: QueryApi

Retrieves items by the specified hash key.

Specified by:

query in interface QueryApi