Class BatchWrite<T>

Namespace

Amazon.DynamoDBv2.DataModel

Assembly

AWSSDK.DynamoDBv2.dll

Represents a strongly-typed object for writing/deleting a batch of items in a single DynamoDB table

public class BatchWrite<T> : BatchWrite

Type Parameters

T

Inheritance

object

BatchWrite

BatchWrite<T>

Inherited Members

BatchWrite.ExecuteAsync(CancellationToken)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

AddDeleteItem(T)

Add a single item to be deleted in the current batch operation.

public void AddDeleteItem(T item)

Parameters

item T

Item to be deleted

AddDeleteItems(IEnumerable<T>)

Add a number of items to be deleted in the current batch operation

public void AddDeleteItems(IEnumerable<T> values)

Parameters

values IEnumerable<T>

Items to be deleted

AddDeleteKey(object)

Add a single item to be deleted in the current batch operation. Item is identified by its hash primary key.

public void AddDeleteKey(object hashKey)

Parameters

hashKey object

Hash key of the item to delete

AddDeleteKey(object, object)

Add a single item to be deleted in the current batch operation. Item is identified by its hash-and-range primary key.

public void AddDeleteKey(object hashKey, object rangeKey)

Parameters

hashKey object

Hash key of the item to delete

rangeKey object

Range key of the item to delete

AddPutItem(T)

Add a single item to be put in the current batch operation

public void AddPutItem(T item)

Parameters

item T

AddPutItems(IEnumerable<T>)

Add a number of items to be put in the current batch operation

public void AddPutItems(IEnumerable<T> values)

Parameters

values IEnumerable<T>

Items to put

Combine(params BatchWrite[])

Creates a MultiTableBatchWrite object that is a combination of the current BatchWrite and the specified BatchWrites

public MultiTableBatchWrite Combine(params BatchWrite[] otherBatches)

Parameters

otherBatches BatchWrite[]

Other BatchWrite objects

Returns

MultiTableBatchWrite

MultiTableBatchWrite consisting of the multiple BatchWrite objects: the current batch and the passed-in batches.

ExecuteHelper()

Execute the batch write.

protected override void ExecuteHelper()

ExecuteHelperAsync(CancellationToken)

Execute the batch write asynchronously.

protected override Task ExecuteHelperAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task