Interface IDynamoTableUpdateItem<TRecord>
Interface to specify a UpdateItem operation.
Namespace: LambdaSharp.DynamoDB.Native.Operations
Assembly: LambdaSharp.DynamoDB.Native.dll
Syntax
public interface IDynamoTableUpdateItem<TRecord>
where TRecord : class
Type Parameters
Name | Description |
---|---|
TRecord | The record type. |
Methods
Add(Expression<Func<TRecord, ISet<Byte[]>>>, IEnumerable<Byte[]>)
Add one or more values to a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, ISet<byte[]>>> attribute, IEnumerable<byte[]> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to add. |
Returns
Type | Description |
---|---|
IDynamo |
Add(Expression<Func<TRecord, ISet<Decimal>>>, IEnumerable<Decimal>)
Add one or more values to a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, ISet<decimal>>> attribute, IEnumerable<decimal> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to add. |
Returns
Type | Description |
---|---|
IDynamo |
Add(Expression<Func<TRecord, ISet<Double>>>, IEnumerable<Double>)
Add one or more values to a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, ISet<double>>> attribute, IEnumerable<double> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to add. |
Returns
Type | Description |
---|---|
IDynamo |
Add(Expression<Func<TRecord, ISet<Int32>>>, IEnumerable<Int32>)
Add one or more values to a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, ISet<int>>> attribute, IEnumerable<int> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to add. |
Returns
Type | Description |
---|---|
IDynamo |
Add(Expression<Func<TRecord, ISet<Int64>>>, IEnumerable<Int64>)
Add one or more values to a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, ISet<long>>> attribute, IEnumerable<long> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to add. |
Returns
Type | Description |
---|---|
IDynamo |
Add(Expression<Func<TRecord, ISet<String>>>, IEnumerable<String>)
Add one or more values to a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, ISet<string>>> attribute, IEnumerable<string> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to add. |
Returns
Type | Description |
---|---|
IDynamo |
Add(Expression<Func<TRecord, Decimal>>, Decimal)
Add a value to a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, decimal>> attribute, decimal value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | Value to add. |
Returns
Type | Description |
---|---|
IDynamo |
Add(Expression<Func<TRecord, Double>>, Double)
Add a value to a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, double>> attribute, double value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | Value to add. |
Returns
Type | Description |
---|---|
IDynamo |
Add(Expression<Func<TRecord, Int32>>, Int32)
Add a value to a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, int>> attribute, int value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | Value to add. |
Returns
Type | Description |
---|---|
IDynamo |
Add(Expression<Func<TRecord, Int64>>, Int64)
Add a value to a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Add(Expression<Func<TRecord, long>> attribute, long value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | Value to add. |
Returns
Type | Description |
---|---|
IDynamo |
Delete(Expression<Func<TRecord, ISet<Byte[]>>>, IEnumerable<Byte[]>)
Delete one or more values from a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Delete(Expression<Func<TRecord, ISet<byte[]>>> attribute, IEnumerable<byte[]> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to delete. |
Returns
Type | Description |
---|---|
IDynamo |
Delete(Expression<Func<TRecord, ISet<Decimal>>>, IEnumerable<Decimal>)
Delete one or more values from a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Delete(Expression<Func<TRecord, ISet<decimal>>> attribute, IEnumerable<decimal> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to delete. |
Returns
Type | Description |
---|---|
IDynamo |
Delete(Expression<Func<TRecord, ISet<Double>>>, IEnumerable<Double>)
Delete one or more values from a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Delete(Expression<Func<TRecord, ISet<double>>> attribute, IEnumerable<double> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to delete. |
Returns
Type | Description |
---|---|
IDynamo |
Delete(Expression<Func<TRecord, ISet<Int32>>>, IEnumerable<Int32>)
Delete one or more values from a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Delete(Expression<Func<TRecord, ISet<int>>> attribute, IEnumerable<int> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to delete. |
Returns
Type | Description |
---|---|
IDynamo |
Delete(Expression<Func<TRecord, ISet<Int64>>>, IEnumerable<Int64>)
Delete one or more values from a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Delete(Expression<Func<TRecord, ISet<long>>> attribute, IEnumerable<long> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to delete. |
Returns
Type | Description |
---|---|
IDynamo |
Delete(Expression<Func<TRecord, ISet<String>>>, IEnumerable<String>)
Delete one or more values from a record set property.
Declaration
IDynamoTableUpdateItem<TRecord> Delete(Expression<Func<TRecord, ISet<string>>> attribute, IEnumerable<string> values)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record set property. |
System. |
values | Values to delete. |
Returns
Type | Description |
---|---|
IDynamo |
ExecuteAsync(CancellationToken)
Execute the UpdateItem operation.
Declaration
Task<bool> ExecuteAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System. |
cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
Type | Description |
---|---|
System. |
True, when successful. False, when condition is not met. |
ExecuteReturnNewItemAsync(CancellationToken)
Execute the UpdateItem operation.
Declaration
Task<TRecord> ExecuteReturnNewItemAsync(CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System. |
cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
Type | Description |
---|---|
System. |
Updated record when found and condition is met. |
ExecuteReturnOldItemAsync(CancellationToken)
Execute the UpdateItem operation.
Declaration
Task<TRecord> ExecuteReturnOldItemAsync(CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System. |
cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
Type | Description |
---|---|
System. |
Old record when found and condition is met. |
Remove(String)
Remove a DynamoDB item attribute. Used for removing attributes used by local/global secondary indices.
Declaration
IDynamoTableUpdateItem<TRecord> Remove(string key)
Parameters
Type | Name | Description |
---|---|---|
System. |
key | Name of attribute. |
Returns
Type | Description |
---|---|
IDynamo |
Remove<T>(Expression<Func<TRecord, T>>)
Remove a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Remove<T>(Expression<Func<TRecord, T>> attribute)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
Returns
Type | Description |
---|---|
IDynamo |
Type Parameters
Name | Description |
---|---|
T | The property type. |
Set(String, AttributeValue)
Set the value of a DynamoDB item attribute. Used for storing attributes used by local/global secondary indices.
Declaration
IDynamoTableUpdateItem<TRecord> Set(string key, AttributeValue value)
Parameters
Type | Name | Description |
---|---|---|
System. |
key | Name of attribute. |
Amazon. |
value | Value of attribute. |
Returns
Type | Description |
---|---|
IDynamo |
Set(String, String)
Set the value of a DynamoDB item attribute. Used for storing attributes used by local/global secondary indices.
Declaration
virtual IDynamoTableUpdateItem<TRecord> Set(string key, string value)
Parameters
Type | Name | Description |
---|---|---|
System. |
key | Name of attribute. |
System. |
value | Value of attribute. |
Returns
Type | Description |
---|---|
IDynamo |
Set<T>(Expression<Func<TRecord, T>>, T)
Set a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Set<T>(Expression<Func<TRecord, T>> attribute, T value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
T | value | The value to set. |
Returns
Type | Description |
---|---|
IDynamo |
Type Parameters
Name | Description |
---|---|
T | The property type. |
Set<T>(Expression<Func<TRecord, T>>, Expression<Func<TRecord, T>>)
Set a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Set<T>(Expression<Func<TRecord, T>> attribute, Expression<Func<TRecord, T>> value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | The value to set. |
Returns
Type | Description |
---|---|
IDynamo |
Type Parameters
Name | Description |
---|---|
T | The property type. |
Set<T>(Expression<Func<TRecord, IDictionary<String, T>>>, IDictionary<String, T>)
Set a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Set<T>(Expression<Func<TRecord, IDictionary<string, T>>> attribute, IDictionary<string, T> value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | The value to set. |
Returns
Type | Description |
---|---|
IDynamo |
Type Parameters
Name | Description |
---|---|
T | The property type. |
Set<T>(Expression<Func<TRecord, IDictionary<String, T>>>, Expression<Func<TRecord, IDictionary<String, T>>>)
Set a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Set<T>(Expression<Func<TRecord, IDictionary<string, T>>> attribute, Expression<Func<TRecord, IDictionary<string, T>>> value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | The value to set. |
Returns
Type | Description |
---|---|
IDynamo |
Type Parameters
Name | Description |
---|---|
T | The property type. |
Set<T>(Expression<Func<TRecord, IList<T>>>, IList<T>)
Set a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Set<T>(Expression<Func<TRecord, IList<T>>> attribute, IList<T> value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | The value to set. |
Returns
Type | Description |
---|---|
IDynamo |
Type Parameters
Name | Description |
---|---|
T | The property type. |
Set<T>(Expression<Func<TRecord, IList<T>>>, Expression<Func<TRecord, IList<T>>>)
Set a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Set<T>(Expression<Func<TRecord, IList<T>>> attribute, Expression<Func<TRecord, IList<T>>> value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | The value to set. |
Returns
Type | Description |
---|---|
IDynamo |
Type Parameters
Name | Description |
---|---|
T | The property type. |
Set<T>(Expression<Func<TRecord, ISet<T>>>, ISet<T>)
Set a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Set<T>(Expression<Func<TRecord, ISet<T>>> attribute, ISet<T> value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | The value to set. |
Returns
Type | Description |
---|---|
IDynamo |
Type Parameters
Name | Description |
---|---|
T | The property type. |
Set<T>(Expression<Func<TRecord, ISet<T>>>, Expression<Func<TRecord, ISet<T>>>)
Set a record property.
Declaration
IDynamoTableUpdateItem<TRecord> Set<T>(Expression<Func<TRecord, ISet<T>>> attribute, Expression<Func<TRecord, ISet<T>>> value)
Parameters
Type | Name | Description |
---|---|---|
System. |
attribute | A lambda expression that selects the target record property. |
System. |
value | The value to set. |
Returns
Type | Description |
---|---|
IDynamo |
Type Parameters
Name | Description |
---|---|
T | The property type. |
WithCondition(Expression<Func<TRecord, Boolean>>)
Add condition for UpdateItem operation.
Declaration
IDynamoTableUpdateItem<TRecord> WithCondition(Expression<Func<TRecord, bool>> condition)
Parameters
Type | Name | Description |
---|---|---|
System. |
condition | A lambda predicate representing the DynamoDB condition expression. |
Returns
Type | Description |
---|---|
IDynamo |