software.amazon.awssdk.extensions.dynamodb.mappingclient

Interface MappedTable<T>

Type Parameters:

T - The type of the modelled object.

All Known Implementing Classes:

DynamoDbMappedTable

public interface MappedTable<T>

Interface for running commands against an object that is linked to a specific DynamoDb table and knows how to map records from that table into a modelled object. Typically an implementation for this interface can be obtained from a MappedDatabase: mappedTable = mappedDatabase.table(tableSchema);

Method Summary

Modifier and Type	Method and Description
<R> R	execute(TableOperation<T,?,?,R> operationToPerform) Executes a command against the database with the context of the primary index of the specific table this object is linked to.
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.
MappedIndex<T>	index(String indexName) Returns a mapped index that can be used to execute commands against a secondary index belonging to the table being mapped by this object.
Key	keyFrom(T item) Creates a Key object from a modelled item.

Method Detail

index

MappedIndex<T> index(String indexName)

Returns a mapped index that can be used to execute commands against a secondary index belonging to the table being mapped by this object. Note that only a subset of the commands that work against a table will work against a secondary index.

Parameters:

indexName - The name of the secondary index to build the command interface for.

Returns:

A MappedIndex object that can be used to execute database commands against.

execute

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

Executes a command against the database with the context of the primary index of the specific table this object is linked to. Example: mappedTable.execute(PutItem.of(myItem));

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 primary index of the table.

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.

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.