software.amazon.awssdk.extensions.dynamodb.mappingclient.core

Class DynamoDbMappedDatabase

java.lang.Object

software.amazon.awssdk.extensions.dynamodb.mappingclient.core.DynamoDbMappedDatabase

All Implemented Interfaces:

MappedDatabase

@ThreadSafe
public class DynamoDbMappedDatabase
extends Object
implements MappedDatabase

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamoDbMappedDatabase.Builder

Method Summary

Modifier and Type	Method and Description
static DynamoDbMappedDatabase.Builder	builder() Constructs a builder for the default approved implementation of this interface.
boolean	equals(Object o)
<T> T	execute(DatabaseOperation<?,?,T> operation) Executes a command against the database.
DynamoDbClient	getDynamoDbClient()
MapperExtension	getMapperExtension()
int	hashCode()
<T> DynamoDbMappedTable<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.
DynamoDbMappedDatabase.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static DynamoDbMappedDatabase.Builder builder()

Description copied from interface: MappedDatabase

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

Specified by:

builder in interface MappedDatabase

Returns:

A builder for a DynamoDbMappedDatabase.

execute

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

Description copied from interface: MappedDatabase

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

Specified by:

execute in interface MappedDatabase

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

public <T> DynamoDbMappedTable<T> table(String tableName,
                                        TableSchema<T> tableSchema)

Description copied from interface: MappedDatabase

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

Specified by:

table in interface MappedDatabase

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.

getDynamoDbClient

public DynamoDbClient getDynamoDbClient()

getMapperExtension

public MapperExtension getMapperExtension()

toBuilder

public DynamoDbMappedDatabase.Builder toBuilder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object