software.amazon.awssdk.extensions.dynamodb.mappingclient

Interface MappedIndex<T>

Type Parameters:

T - The type of the modelled object.

All Known Implementing Classes:

DynamoDbMappedIndex

public interface MappedIndex<T>

Interface for running commands against an object that is linked to a specific DynamoDb secondary index and knows how to map records from the table that index is linked to into a modelled object. This interface is extended by the DynamoDbMappedTable interface as all commands that can be made against a secondary index can also be made against the primary index. Typically an implementation for this interface can be obtained from a MappedTable which in turn can be obtained from a MappedDatabase: mappedIndex = mappedDatabase.table(tableSchema).index("gsi_1");

Method Summary

Modifier and Type	Method and Description
<R> R	execute(IndexOperation<T,?,?,R> operationToPerform) Executes a command against the database with the context of the specific table and secondary index this object is linked to.
String	getIndexName() Gets the physical secondary index name that operations performed by this object will be executed against.
MapperExtension	getMapperExtension() Gets the MapperExtension associated with this mapped resource.
String	getTableName() Gets the physical table name that operations performed by this object will be executed against.
TableSchema<T>	getTableSchema() Gets the TableSchema object that this mapped table was built with.
Key	keyFrom(T item) Creates a Key object from a modelled item.

Method Detail

execute

<R> R execute(IndexOperation<T,?,?,R> operationToPerform)

Executes a command against the database with the context of the specific table and secondary index this object is linked to. Example: mappedIndex.execute(Scan.create());

Type Parameters:

R - The expected return type from the operation. This is typically inferred by the compiler.

Parameters:

operationToPerform - The operation to be performed in the context of the secondary index.

Returns:

The result of the operation being executed. The documentation on the operation itself should have more information.

getMapperExtension

MapperExtension getMapperExtension()

Gets the MapperExtension associated with this mapped resource.

Returns:

The MapperExtension associated with this mapped resource.

getTableSchema

TableSchema<T> getTableSchema()

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

Returns:

The TableSchema object for this mapped table.

getTableName

String getTableName()

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

Returns:

The physical table name.

getIndexName

String getIndexName()

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

Returns:

The physical secondary index name.

keyFrom

Key keyFrom(T item)

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

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.