Class UpdateBuilder<T>

java.lang.Object

dev.hogwai.dynamodb.simplified.builder.base.AbstractUpdateBuilder<T, UpdateBuilder<T>>

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

Type Parameters:

T - the type of the item

public class UpdateBuilder<T>
extends AbstractUpdateBuilder<T, UpdateBuilder<T>>

A fluent builder for updating an item in a DynamoDB table. Supports both full-item replacement and partial updates via an UpdateExpression. Part of the DynamoDB Simplified library.

Field Summary

Fields inherited from class AbstractUpdateBuilder

conditionExpression, ignoreNulls, item, keyMap, LOG, optimisticLocking, returnValues, updateExpression

Constructor Summary

Constructors

Constructor	Description
UpdateBuilder(@NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable<T> table, @NonNull T item, @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient)	Constructs a new UpdateBuilder for the given table and item.
UpdateBuilder(@NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable<T> table, @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient, @NonNull Object partitionKey, @Nullable Object sortKey)	Key-only constructor for use from Table convenience methods.

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<T>	execute()	Executes the update operation.
protected @NonNull software.amazon.awssdk.enhanced.dynamodb.Key	getKeyFromItem()	Returns a Key built from the current item.
protected @NonNull software.amazon.awssdk.enhanced.dynamodb.TableSchema<T>	getTableSchema()	Returns the table schema for the item type.
protected @NonNull UpdateBuilder<T>	self()	Returns this typed as S for fluent chaining.
protected @NonNull String	tableName()	Returns the DynamoDB table name.

Methods inherited from class AbstractUpdateBuilder

applyOptimisticLocking, buildKeyMap, buildKeyMapFromValues, condition, condition, ignoreNulls, incrementVersion, returnValues, update, withOptimisticLocking

Methods inherited from class Object

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

Constructor Details

UpdateBuilder

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

Constructs a new UpdateBuilder for the given table and item.

Parameters:

table - the DynamoDB table

item - the item to update (full replacement data, or a template object when used with AbstractUpdateBuilder.update(java.util.function.Consumer))

dynamoDbClient - the low-level DynamoDB client (required for partial updates)

UpdateBuilder

public UpdateBuilder(@NonNull software.amazon.awssdk.enhanced.dynamodb.DynamoDbTable<T> table,
 @NonNull software.amazon.awssdk.services.dynamodb.DynamoDbClient dynamoDbClient,
 @NonNull Object partitionKey,
 @Nullable Object sortKey)

Key-only constructor for use from Table convenience methods. Skips the item parameter and builds the key map directly from partition (and optionally sort) key values.

Parameters:

table - the DynamoDB table

dynamoDbClient - the low-level DynamoDB client (required for partial updates)

partitionKey - the partition key value

sortKey - the sort key value, or null if the table has no sort key

Method Details

self

protected @NonNull UpdateBuilder<T> self()

Description copied from class: AbstractUpdateBuilder

Returns this typed as S for fluent chaining.

Specified by:

self in class AbstractUpdateBuilder<T, UpdateBuilder<T>>

Returns:

this builder

tableName

protected @NonNull String tableName()

Description copied from class: AbstractUpdateBuilder

Returns the DynamoDB table name.

Specified by:

tableName in class AbstractUpdateBuilder<T, UpdateBuilder<T>>

Returns:

the DynamoDB table name

getKeyFromItem

protected @NonNull software.amazon.awssdk.enhanced.dynamodb.Key getKeyFromItem()

Description copied from class: AbstractUpdateBuilder

Returns a Key built from the current item. Used internally to build key maps for partial update requests.

Specified by:

getKeyFromItem in class AbstractUpdateBuilder<T, UpdateBuilder<T>>

Returns:

the key derived from the item

getTableSchema

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

Description copied from class: AbstractUpdateBuilder

Returns the table schema for the item type. Used internally for key and attribute conversion.

Specified by:

getTableSchema in class AbstractUpdateBuilder<T, UpdateBuilder<T>>

Returns:

the table schema

execute

public @NonNull Optional<T> execute()

Executes the update operation. If a partial update expression was configured via AbstractUpdateBuilder.update(java.util.function.Consumer), a targeted partial update is performed via the low-level DynamoDB client. Otherwise, the full item is replaced.

Returns:

the updated item, or empty if not found