software.amazon.awssdk.extensions.dynamodb.mappingclient

Interface DynamoDbEnhancedAsyncClient

All Known Implementing Classes:

DefaultDynamoDbEnhancedAsyncClient

public interface DynamoDbEnhancedAsyncClient

Asynchronous interface for running commands against a DynamoDb database.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DynamoDbEnhancedAsyncClient.Builder The builder definition for a DynamoDbEnhancedAsyncClient.

Method Summary

Modifier and Type	Method and Description
static DynamoDbEnhancedAsyncClient.Builder	builder() Creates a default builder for DynamoDbEnhancedAsyncClient.
<T> CompletableFuture<T>	execute(DatabaseOperation<?,?,T> operation) Executes a command against the database.
<T> AsyncMappedTable<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> CompletableFuture<T> execute(DatabaseOperation<?,?,T> operation)

Executes a command against the database.

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:

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

table

<T> AsyncMappedTable<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 AsyncMappedTable object that can be used to execute table operations against.

builder

static DynamoDbEnhancedAsyncClient.Builder builder()

Creates a default builder for DynamoDbEnhancedAsyncClient.