Condition | Dynameh

An object representing a condition. This is used by requestBuilder.addCondition().

see: http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html

Hierarchy

Condition

Index

Properties

attribute

attribute: string

The attribute name to put the condition on. Nested attributes can be accessed using dot notation; for example a.b.c. Attribute names with literal dots should escape them with a backslash; for example a\.b\.c.

see: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Attributes.html

Optional not

not?: boolean

True to invert the condition.

operator

operator: DynamoConditionOperator

A comparison operator or function name. All DynamoDB operators and functions are supported: =, <>, <, <=, >, >=, BETWEEN, IN, attribute_exists, attribute_not_exists, attribute_type, begins_with, contains, size.

see: http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html

Optional values

values?: any[]

Any arguments necessary to the operator. Can be omitted if the operator requires 0 arguments. For example = requires 1 value and attribute_exists requires 0.