software.amazon.awssdk.extensions.dynamodb.mappingclient

Interface MappedTable<T>

Type Parameters:

T - The type of the modelled object.

All Superinterfaces:

MappedTableResource<T>

All Known Implementing Classes:

DynamoDbMappedTable

public interface MappedTable<T>
extends MappedTableResource<T>

Synchronous interface for running commands against an object that is linked to a specific DynamoDb table resource and therefore knows how to map records from that table into a modelled object.

Method Summary

Modifier and Type	Method and Description
<R> SdkIterable<R>	execute(PaginatedTableOperation<T,?,?,R> operationToPerform) Executes a command that is expected to return a paginated list of data items against the database with the context of the primary index of the specific table this object is linked to.
<R> R	execute(TableOperation<T,?,?,R> operationToPerform) Executes a command that is expected to return a single data item against the database with the context of the primary index of the specific table this object is linked to.
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.

Methods inherited from interface software.amazon.awssdk.extensions.dynamodb.mappingclient.MappedTableResource

keyFrom, mapperExtension, tableName, tableSchema

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 that is expected to return a single data item against the database with the context of the primary index of the specific table this object is linked to.

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.

execute

<R> SdkIterable<R> execute(PaginatedTableOperation<T,?,?,R> operationToPerform)

Executes a command that is expected to return a paginated list of data items against the database with the context of the primary index of the specific table this object is linked to.

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:

An SdkIterable that will return successive pages of result data items as it is iterated over.