DynamoDBCondition Class Reference
| Inherits from | NSObject |
| Declared in | DynamoDBCondition.h |
Tasks
-
attributeValueListRepresents one or more values to evaluate against the supplied attribute. This list contains exactly one value, except for a
propertyBETWEENorINcomparison, in which case the list contains two values.For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example,
ais greater thanA, andaais greater thanB. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.For Binary, Amazon DynamoDB treats each byte of the binary data as unsigned when it compares binary values, for example when evaluating query expressions.
-
comparisonOperatorRepresents a comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEENValid comparison operators for Scan:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEENFor information on specifying data types in JSON, see JSON Data Format of the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
-
EQ: Equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not equal{“NS”:[“6”, “2”, “1”]}. -
NE: Not equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not equal{“NS”:[“6”, “2”, “1”]}. -
LE: Less than or equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
LT: Less than.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
GE: Greater than or equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
GT: Greater than.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
NOT_NULL: The attribute exists. -
NULL: The attribute does not exist. -
CONTAINS: checks for a subsequence, or value in a set.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (“SS”, “NS”, or “BS”), then the operation checks for a member of the set (not as a substring).
-
NOT_CONTAINS: checks for absence of a subsequence, or absence of a value in a set.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (“SS”, “NS”, or “BS”), then the operation checks for the absence of a member of the set (not as a substring).
-
BEGINS_WITH: checks for a prefix.AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
-
IN: checks for exact matches.AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
-
BETWEEN: Greater than or equal to the first value, and less than or equal to the second value.AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not compare to{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}
Constraints:
property
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH -
-
– initDefault constructor for a new Condition object. Callers should use the property methods to initialize this object after creating it.
-
– addAttributeValueList:Adds a single object to attributeValueList. This function will alloc and init attributeValueList if not already done.
-
– descriptionReturns a string representation of this object; useful for testing and debugging.
Properties
attributeValueList
Represents one or more values to evaluate against the supplied
attribute. This list contains exactly one value, except for a
For type Number, value comparisons
are numeric. String value comparisons for greater than, equals, or
less than are based on ASCII character code values. For example,
For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in which case the
list contains two values. a is greater than A, and aa is
greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
@property (nonatomic, retain) NSMutableArray *attributeValueListDiscussion
Represents one or more values to evaluate against the supplied
attribute. This list contains exactly one value, except for a
For type Number, value comparisons
are numeric. String value comparisons for greater than, equals, or
less than are based on ASCII character code values. For example,
For Binary, Amazon DynamoDB treats each byte of the binary data as
unsigned when it compares binary values, for example when evaluating
query expressions. BETWEEN or IN comparison, in which case the
list contains two values. a is greater than A, and aa is
greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
Declared In
DynamoDBCondition.hcomparisonOperator
Represents a comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH |
BETWEEN
Valid comparison operators for Scan:
EQ |
NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |
BEGINS_WITH | IN | BETWEEN
For information on specifying data types in JSON, see JSON Data Format of the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
-
EQ: Equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not equal{“NS”:[“6”, “2”, “1”]}. -
NE: Not equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not equal{“NS”:[“6”, “2”, “1”]}. -
LE: Less than or equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
LT: Less than.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
GE: Greater than or equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
GT: Greater than.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
NOT_NULL: The attribute exists. -
NULL: The attribute does not exist. -
CONTAINS: checks for a subsequence, or value in a set.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (“SS”, “NS”, or “BS”), then the operation checks for a member of the set (not as a substring).
-
NOT_CONTAINS: checks for absence of a subsequence, or absence of a value in a set.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (“SS”, “NS”, or “BS”), then the operation checks for the absence of a member of the set (not as a substring).
-
BEGINS_WITH: checks for a prefix.AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
-
IN: checks for exact matches.AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
-
BETWEEN: Greater than or equal to the first value, and less than or equal to the second value.AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not compare to{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
@property (nonatomic, retain) NSString *comparisonOperatorDiscussion
Represents a comparator for evaluating attributes. For example, equals, greater than, less than, etc.
Valid comparison operators for Query:
EQ | LE | LT | GE | GT | BEGINS_WITH |
BETWEEN
Valid comparison operators for Scan:
EQ |
NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |
BEGINS_WITH | IN | BETWEEN
For information on specifying data types in JSON, see JSON Data Format of the Amazon DynamoDB Developer Guide.
The following are descriptions of each comparison operator.
-
EQ: Equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not equal{“NS”:[“6”, “2”, “1”]}. -
NE: Not equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not equal{“NS”:[“6”, “2”, “1”]}. -
LE: Less than or equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
LT: Less than.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
GE: Greater than or equal.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
GT: Greater than.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not equal{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}. -
NOT_NULL: The attribute exists. -
NULL: The attribute does not exist. -
CONTAINS: checks for a subsequence, or value in a set.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for a substring match. If the target attribute of the comparison is Binary, then the operation looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (“SS”, “NS”, or “BS”), then the operation checks for a member of the set (not as a substring).
-
NOT_CONTAINS: checks for absence of a subsequence, or absence of a value in a set.AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set). If the target attribute of the comparison is a String, then the operation checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operation checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (“SS”, “NS”, or “BS”), then the operation checks for the absence of a member of the set (not as a substring).
-
BEGINS_WITH: checks for a prefix.AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set). The target attribute of the comparison must be a String or Binary (not a Number or a set).
-
IN: checks for exact matches.AttributeValueList can contain more than one AttributeValue of type String, Number, or Binary (not a set). The target attribute of the comparison must be of the same type and exact value to match. A String never matches a String set.
-
BETWEEN: Greater than or equal to the first value, and less than or equal to the second value.AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue of a different type than the one specified in the request, the value does not match. For example,
{“S”:“6”}does not compare to{“N”:“6”}. Also,{“N”:“6”}does not compare to{“NS”:[“6”, “2”, “1”]}
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
Declared In
DynamoDBCondition.hInstance Methods
addAttributeValueList:
Adds a single object to attributeValueList. This function will alloc and init attributeValueList if not already done.
- (void)addAttributeValueList:(DynamoDBAttributeValue *)attributeValueListObjectDiscussion
Adds a single object to attributeValueList. This function will alloc and init attributeValueList if not already done.
Declared In
DynamoDBCondition.hdescription
Returns a string representation of this object; useful for testing and debugging.
- (NSString *)descriptionReturn Value
A string representation of this object.
Discussion
Returns a string representation of this object; useful for testing and debugging.
Declared In
DynamoDBCondition.hinit
Default constructor for a new Condition object. Callers should use the property methods to initialize this object after creating it.
- (id)initDiscussion
Default constructor for a new Condition object. Callers should use the property methods to initialize this object after creating it.
Declared In
DynamoDBCondition.h