Package software.amazon.awssdk.enhanced.dynamodb.internal.client

Class DefaultDynamoDbIndex<T>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.internal.client.DefaultDynamoDbIndex<T>

All Implemented Interfaces:

DynamoDbIndex<T>

public class DefaultDynamoDbIndex<T>
extends Object
implements DynamoDbIndex<T>

Method Summary

Modifier and Type	Method	Description
DynamoDbClient	dynamoDbClient()
boolean	equals(Object o)
int	hashCode()
String	indexName()	Gets the physical secondary index name that operations performed by this object will be executed against.
Key	keyFrom(T item)	Creates a Key object from a modelled item.
DynamoDbEnhancedClientExtension	mapperExtension()	Gets the DynamoDbEnhancedClientExtension associated with this mapped resource.
SdkIterable<Page<T>>	query(Consumer<QueryEnhancedRequest.Builder> requestConsumer)	Executes a query against a secondary index using a QueryConditional expression to retrieve a list of items matching the given conditions.
SdkIterable<Page<T>>	query(QueryConditional queryConditional)	Executes a query against the secondary index of the table using a QueryConditional expression to retrieve a list of items matching the given conditions.
SdkIterable<Page<T>>	query(QueryEnhancedRequest request)	Executes a query against a secondary index using a QueryConditional expression to retrieve a list of items matching the given conditions.
SdkIterable<Page<T>>	scan()	Scans the table against a secondary index and retrieves all items using default settings.
SdkIterable<Page<T>>	scan(Consumer<ScanEnhancedRequest.Builder> requestConsumer)	Scans the table against a secondary index and retrieves all items.
SdkIterable<Page<T>>	scan(ScanEnhancedRequest request)	Scans the table against a secondary index and retrieves all items.
String	tableName()	Gets the physical table name that operations performed by this object will be executed against.
TableSchema<T>	tableSchema()	Gets the TableSchema object that this mapped table was built with.

Methods inherited from class java.lang.Object

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

Method Detail

query

public SdkIterable<Page<T>> query(QueryEnhancedRequest request)

Description copied from interface: DynamoDbIndex

Executes a query against a secondary index using a QueryConditional expression to retrieve a list of items matching the given conditions.

The result is accessed through iterable pages (see Page) in an interactive way; each time a result page is retrieved, a query call is made to DynamoDb to get those entries. If no matches are found, the resulting iterator will contain an empty page. Results are sorted by sort key value in ascending order by default; this behavior can be overridden in the QueryEnhancedRequest.

The additional configuration parameters that the enhanced client supports are defined in the QueryEnhancedRequest.

This operation calls the low-level DynamoDB API Query operation. Consult the Query documentation for further details and constraints.

Example:

 

 QueryConditional queryConditional = QueryConditional.keyEqualTo(Key.builder().partitionValue("id-value").build());
 Iterator<Page<MyItem>> results = mappedIndex.query(QueryEnhancedRequest.builder()
                                                                        .queryConditional(queryConditional)
                                                                        .build());
 
 

Specified by:

query in interface DynamoDbIndex<T>

Parameters:

request - A QueryEnhancedRequest defining the query conditions and how to handle the results.

Returns:

an iterator of type SdkIterable with paginated results (see Page).

query

public SdkIterable<Page<T>> query(Consumer<QueryEnhancedRequest.Builder> requestConsumer)

Description copied from interface: DynamoDbIndex

Executes a query against a secondary index using a QueryConditional expression to retrieve a list of items matching the given conditions.

The result is accessed through iterable pages (see Page) in an interactive way; each time a result page is retrieved, a query call is made to DynamoDb to get those entries. If no matches are found, the resulting iterator will contain an empty page. Results are sorted by sort key value in ascending order by default; this behavior can be overridden in the QueryEnhancedRequest.

The additional configuration parameters that the enhanced client supports are defined in the QueryEnhancedRequest.

This operation calls the low-level DynamoDB API Query operation. Consult the Query documentation for further details and constraints.

Note: This is a convenience method that creates an instance of the request builder avoiding the need to create one manually via QueryEnhancedRequest.builder().

Example:

 

 Iterator<Page<MyItem>> results =
     mappedIndex.query(r -> r.queryConditional(QueryConditional.keyEqualTo(k -> k.partitionValue("id-value"))));
 
 

Specified by:

query in interface DynamoDbIndex<T>

Parameters:

requestConsumer - A Consumer of QueryEnhancedRequest defining the query conditions and how to handle the results.

Returns:

an iterator of type SdkIterable with paginated results (see Page).

query

public SdkIterable<Page<T>> query(QueryConditional queryConditional)

Description copied from interface: DynamoDbIndex

Executes a query against the secondary index of the table using a QueryConditional expression to retrieve a list of items matching the given conditions.

The result is accessed through iterable pages (see Page) in an interactive way; each time a result page is retrieved, a query call is made to DynamoDb to get those entries. If no matches are found, the resulting iterator will contain an empty page. Results are sorted by sort key value in ascending order.

This operation calls the low-level DynamoDB API Query operation. Consult the Query documentation for further details and constraints.

Example:

 

 Iterator<Page<MyItem>> results =
     mappedIndex.query(QueryConditional.keyEqualTo(Key.builder().partitionValue("id-value").build()));
 
 

Specified by:

query in interface DynamoDbIndex<T>

Parameters:

queryConditional - A QueryConditional defining the matching criteria for records to be queried.

Returns:

an iterator of type SdkIterable with paginated results (see Page).

scan

public SdkIterable<Page<T>> scan(ScanEnhancedRequest request)

Description copied from interface: DynamoDbIndex

Scans the table against a secondary index and retrieves all items.

The result is accessed through iterable pages (see Page) in an interactive way; each time a result page is retrieved, a scan call is made to DynamoDb to get those entries. If no matches are found, the resulting iterator will contain an empty page.

The additional configuration parameters that the enhanced client supports are defined in the ScanEnhancedRequest.

Example:

 

 Iterator<Page<MyItem>> results = mappedTable.scan(ScanEnhancedRequest.builder().consistentRead(true).build());
 
 

Specified by:

scan in interface DynamoDbIndex<T>

Parameters:

request - A ScanEnhancedRequest defining how to handle the results.

Returns:

an iterator of type SdkIterable with paginated results (see Page).

scan

public SdkIterable<Page<T>> scan(Consumer<ScanEnhancedRequest.Builder> requestConsumer)

Description copied from interface: DynamoDbIndex

Scans the table against a secondary index and retrieves all items.

The result is accessed through iterable pages (see Page) in an interactive way; each time a result page is retrieved, a scan call is made to DynamoDb to get those entries. If no matches are found, the resulting iterator will contain an empty page.

The additional configuration parameters that the enhanced client supports are defined in the ScanEnhancedRequest.

Note: This is a convenience method that creates an instance of the request builder avoiding the need to create one manually via ScanEnhancedRequest.builder().

Example:

 

 Iterator<Page<MyItem>> results = mappedTable.scan(r -> r.limit(5));
 
 

Specified by:

scan in interface DynamoDbIndex<T>

Parameters:

requestConsumer - A Consumer of ScanEnhancedRequest defining the query conditions and how to handle the results.

Returns:

an iterator of type SdkIterable with paginated results (see Page).

scan

public SdkIterable<Page<T>> scan()

Description copied from interface: DynamoDbIndex

Scans the table against a secondary index and retrieves all items using default settings.

The result is accessed through iterable pages (see Page) in an interactive way; each time a result page is retrieved, a scan call is made to DynamoDb to get those entries. If no matches are found, the resulting iterator will contain an empty page.

Example:

 

 Iterator<Page<MyItem>> results = mappedTable.scan();
 
 

Specified by:

scan in interface DynamoDbIndex<T>

Returns:

an iterator of type SdkIterable with paginated results (see Page).

mapperExtension

public DynamoDbEnhancedClientExtension mapperExtension()

Description copied from interface: DynamoDbIndex

Gets the DynamoDbEnhancedClientExtension associated with this mapped resource.

Specified by:

mapperExtension in interface DynamoDbIndex<T>

Returns:

The DynamoDbEnhancedClientExtension associated with this mapped resource.

tableSchema

public TableSchema<T> tableSchema()

Description copied from interface: DynamoDbIndex

Gets the TableSchema object that this mapped table was built with.

Specified by:

tableSchema in interface DynamoDbIndex<T>

Returns:

The TableSchema object for this mapped table.

dynamoDbClient

public DynamoDbClient dynamoDbClient()

tableName

public String tableName()

Description copied from interface: DynamoDbIndex

Gets the physical table name that operations performed by this object will be executed against.

Specified by:

tableName in interface DynamoDbIndex<T>

Returns:

The physical table name.

indexName

public String indexName()

Description copied from interface: DynamoDbIndex

Gets the physical secondary index name that operations performed by this object will be executed against.

Specified by:

indexName in interface DynamoDbIndex<T>

Returns:

The physical secondary index name.

keyFrom

public Key keyFrom(T item)

Description copied from interface: DynamoDbIndex

Creates a Key object from a modelled item. This key can be used in query conditionals and get operations to locate a specific record.

Specified by:

keyFrom in interface DynamoDbIndex<T>

Parameters:

item - The item to extract the key fields from.

Returns:

A key that has been initialized with the index values extracted from the modelled object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object