Class BatchWriteBuilder<T>

java.lang.Object

dev.hogwai.dynamodb.simplified.builder.base.AbstractBatchWriteBuilder<T, BatchWriteBuilder<T>>

dev.hogwai.dynamodb.simplified.builder.BatchWriteBuilder<T>

Type Parameters:

T - the item type

public class BatchWriteBuilder<T>
extends AbstractBatchWriteBuilder<T, BatchWriteBuilder<T>>

Builds a batch write operation to put and delete multiple items in a single table.

Obtain via Table.batchWrite().

A single batch write can contain up to 25 put and delete operations combined. Unprocessed items are automatically retried with exponential backoff (up to 3 attempts).

Field Summary

Fields inherited from class AbstractBatchWriteBuilder

itemsToPut, keysToDelete, returnConsumedCapacity

Constructor Summary

Constructors

Constructor	Description
BatchWriteBuilder(@NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable<T> table, @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient)	Creates a new BatchWriteBuilder with the given table and low-level client.

Method Summary

Modifier and Type	Method	Description
@NonNull BatchWriteResult	execute()	Executes the batch write operation.
protected BatchWriteBuilder<T>	self()	Returns this typed as S for fluent chaining.
protected @NonNull String	tableName()	Returns the DynamoDB table name.
protected @NonNull software.amazon.awssdk.enhanced.dynamodb.TableSchema<T>	tableSchema()	Returns the table schema for converting items to attribute maps.

Methods inherited from class AbstractBatchWriteBuilder

buildRequestItems, delete, delete, put, returnConsumedCapacity

Methods inherited from class Object

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

Constructor Details

BatchWriteBuilder

public BatchWriteBuilder(@NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable<T> table,
 @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient)

Creates a new BatchWriteBuilder with the given table and low-level client.

Parameters:

table - the DynamoDB table

dynamoDbClient - the low-level DynamoDB client

Method Details

self

protected BatchWriteBuilder<T> self()

Description copied from class: AbstractBatchWriteBuilder

Returns this typed as S for fluent chaining.

Specified by:

self in class AbstractBatchWriteBuilder<T, BatchWriteBuilder<T>>

Returns:

this builder

tableSchema

protected @NonNull software.amazon.awssdk.enhanced.dynamodb.TableSchema<T> tableSchema()

Description copied from class: AbstractBatchWriteBuilder

Returns the table schema for converting items to attribute maps.

Specified by:

tableSchema in class AbstractBatchWriteBuilder<T, BatchWriteBuilder<T>>

Returns:

the table schema

tableName

protected @NonNull String tableName()

Description copied from class: AbstractBatchWriteBuilder

Returns the DynamoDB table name.

Specified by:

tableName in class AbstractBatchWriteBuilder<T, BatchWriteBuilder<T>>

Returns:

the DynamoDB table name

execute

public @NonNull BatchWriteResult execute()

Executes the batch write operation.

All puts and deletes added to this builder are sent in a single batch write request. Unprocessed items are automatically retried with exponential backoff (up to 3 attempts). Uses the low-level client so that unprocessed items can be retried.

Returns:

a BatchWriteResult containing any unprocessed items

Throws:

IllegalArgumentException - if more than 25 items (puts + deletes combined) are provided