Database.DynamoDB.Filter

Module for creating filter conditions

Example as used in nested structure for scan:

scanCond (hashitem' <!:> "a" <.> author' <.> name' ==. "x") 20

Condition datatype

data FilterCondition t

Filter condition. Use with scan, query, update and delete methods.

Filtering on primary key is not allowed.

Constructors

Not (FilterCondition t)

Negate condition

Instances

Semigroup (FilterCondition t)

Methods

(<>) :: FilterCondition t -> FilterCondition t -> FilterCondition t

sconcat :: NonEmpty (FilterCondition t) -> FilterCondition t

stimes :: Integral b => b -> FilterCondition t -> FilterCondition t

Logical operators

(&&.) :: FilterCondition t -> FilterCondition t -> FilterCondition t infixr 3

AND for combining conditions.

(||.) :: FilterCondition t -> FilterCondition t -> FilterCondition t infixr 3

OR for combining conditions

Equality comparisons

(==.) :: (InCollection col tbl FullPath, DynamoEncodable typ) => Column typ ctyp col -> typ -> FilterCondition tbl infix 4

Tests for equality. Automatically adjusts query to account for missing attributes.

Note: checks against empty values esentially translate to attrMissing.

(/=.) :: (InCollection col tbl FullPath, DynamoEncodable typ) => Column typ ctyp col -> typ -> FilterCondition tbl infix 4

a /= b === Not (a == b)

(>=.) :: (InCollection col tbl FullPath, DynamoEncodable typ, Ord typ) => Column typ ctyp col -> typ -> FilterCondition tbl infix 4

(>.) :: (InCollection col tbl FullPath, DynamoEncodable typ, Ord typ) => Column typ ctyp col -> typ -> FilterCondition tbl infix 4

(<=.) :: (InCollection col tbl FullPath, DynamoEncodable typ, Ord typ) => Column typ ctyp col -> typ -> FilterCondition tbl infix 4

(<.) :: (InCollection col tbl FullPath, DynamoEncodable typ, Ord typ) => Column typ ctyp col -> typ -> FilterCondition tbl infix 4

Extended functions

attrExists :: InCollection col tbl FullPath => Column typ TypColumn col -> FilterCondition tbl

Check existence of attribute.

attrMissing :: InCollection col tbl FullPath => Column typ TypColumn col -> FilterCondition tbl

Checks non-existence of an attribute

beginsWith :: (InCollection col tbl FullPath, IsText typ) => Column typ TypColumn col -> Text -> FilterCondition tbl

Comparison for text columns.

contains :: (InCollection col tbl FullPath, IsText typ) => Column typ TypColumn col -> Text -> FilterCondition tbl

CONTAINS condition for text-like attributes.

setContains :: (InCollection col tbl FullPath, DynamoScalar v a) => Column (Set a) TypColumn col -> a -> FilterCondition tbl

CONTAINS condition for sets.

valIn :: (InCollection col tbl FullPath, DynamoScalar v typ) => Column typ ctyp col -> [typ] -> FilterCondition tbl

a IN (b, c, d); the list may contain up to 100 values.

between :: (Ord typ, InCollection col tbl FullPath, DynamoScalar v typ) => Column typ ctyp col -> (typ, typ) -> FilterCondition tbl

Numeric/string range comparison.

size :: Column typ TypColumn col -> Column Int TypSize col

Size (i.e. number of bytes) of saved attribute.