Class Filter

Namespace

Amazon.DynamoDBv2.DocumentModel

Assembly

AWSSDK.DynamoDBv2.dll

Filter for use with scan and query operations

public class Filter

Inheritance

object

Filter

Derived

QueryFilter

ScanFilter

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Filter()

Default Constructor.

public Filter()

Properties

Conditions

Gets the Conditions for the filter.

protected Dictionary<string, Filter.FilterCondition> Conditions { get; }

Property Value

Dictionary<string, Filter.FilterCondition>

Methods

AddCondition(string, ComparisonOperator, List<DynamoDBEntry>)

Adds a condition

protected void AddCondition(string attributeName, ComparisonOperator comparisonOperator, List<DynamoDBEntry> values)

Parameters

attributeName string

comparisonOperator ComparisonOperator

values List<DynamoDBEntry>

AddCondition(string, FilterCondition)

Adds a condition

protected void AddCondition(string attributeName, Filter.FilterCondition filterCondition)

Parameters

attributeName string

filterCondition Filter.FilterCondition

AddCondition(string, Condition)

Adds a condition for a specified attribute.

If a condition for the attribute already exists, it will be replaced with the new condition.

public void AddCondition(string attributeName, Condition condition)

Parameters

attributeName string

Target attribute name

condition Condition

Condition to be added

ConvertToAttributeValues(DynamoDBEntryConversion, params DynamoDBEntry[])

Creates a list of AttributeValues from a list of DynamoDBEntry items

protected static List<AttributeValue> ConvertToAttributeValues(DynamoDBEntryConversion conversion, params DynamoDBEntry[] values)

Parameters

conversion DynamoDBEntryConversion

values DynamoDBEntry[]

Returns

List<AttributeValue>

ConvertToAttributeValues(DynamoDBEntryConversion, bool, params DynamoDBEntry[])

Creates a list of AttributeValues from a list of DynamoDBEntry items

protected static List<AttributeValue> ConvertToAttributeValues(DynamoDBEntryConversion conversion, bool isEmptyStringValueEnabled, params DynamoDBEntry[] values)

Parameters

conversion DynamoDBEntryConversion

isEmptyStringValueEnabled bool

values DynamoDBEntry[]

Returns

List<AttributeValue>

FromConditions(Dictionary<string, Condition>)

Creates a Filter from a conditions map

public static Filter FromConditions(Dictionary<string, Condition> conditions)

Parameters

conditions Dictionary<string, Condition>

Map from attribute name to condition

Returns

Filter

Equivalent Filter

RemoveCondition(string)

Removes a condition for a specific attribute name.

public void RemoveCondition(string attributeName)

Parameters

attributeName string

Target attribute

ToConditions()

Converts filter to a map of conditions This call will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema

public Dictionary<string, Condition> ToConditions()

Returns

Dictionary<string, Condition>

Map from attribute name to condition

ToConditions(Table)

Converts filter to a map of conditions

public Dictionary<string, Condition> ToConditions(Table table)

Parameters

table Table

Table to use for converting .NET values to DynamoDB values.

Returns

Dictionary<string, Condition>

Map from attribute name to condition

ToConditions(DynamoDBEntryConversion)

Converts filter to a map of conditions

public Dictionary<string, Condition> ToConditions(DynamoDBEntryConversion conversion)

Parameters

conversion DynamoDBEntryConversion

Conversion to use for converting .NET values to DynamoDB values.

Returns

Dictionary<string, Condition>

Map from attribute name to condition

ToConditions(DynamoDBEntryConversion, bool)

Converts filter to a map of conditions

public Dictionary<string, Condition> ToConditions(DynamoDBEntryConversion conversion, bool isEmptyStringValueEnabled)

Parameters

conversion DynamoDBEntryConversion

Conversion to use for converting .NET values to DynamoDB values.

isEmptyStringValueEnabled bool

Returns

Dictionary<string, Condition>

Map from attribute name to condition