software.amazon.awssdk.extensions.dynamodb.mappingclient

Interface MappedDatabase

All Known Implementing Classes:

DynamoDbMappedDatabase

public interface MappedDatabase

Interface for running commands against a DynamoDb database. An implementation for this interface can be instantiated by using the default builder: MappedDatabase.builder() .dynamoDbClient(dynamoDbClient) .extendWith(mapperExtension) // Optional. See 'extensions' package. .build();

Method Summary

Modifier and Type	Method and Description
static DynamoDbMappedDatabase.Builder	builder() Constructs a builder for the default approved implementation of this interface.
<T> T	execute(DatabaseOperation<?,?,T> operation) Executes a command against the database.
<T> MappedTable<T>	table(String tableName, TableSchema<T> tableSchema) Returns a mapped table that can be used to execute commands that work with mapped items against that table.

Method Detail

execute

<T> T execute(DatabaseOperation<?,?,T> operation)

Executes a command against the database. Example: mappedDatabase.execute(BatchGetItem.of(...));

Type Parameters:

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

Parameters:

operation - The operation to be performed in the context of the database.

Returns:

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

table

<T> MappedTable<T> table(String tableName,
                         TableSchema<T> tableSchema)

Returns a mapped table that can be used to execute commands that work with mapped items against that table.

Type Parameters:

T - THe modelled object type being mapped to this table.

Parameters:

tableName - The name of the physical table persisted by DynamoDb.

tableSchema - A TableSchema that maps the table to a modelled object.

Returns:

A MappedTable object that can be used to execute table operations against.

builder

static DynamoDbMappedDatabase.Builder builder()

Constructs a builder for the default approved implementation of this interface.

Returns:

A builder for a DynamoDbMappedDatabase.