Filter class abstract

Filter for searching into the database

Don't subclass

Available extensions

• SembastFilterCombination

Constructors

Filter.and(List<Filter> filters)

Record must match all of the given filters.

factory

Filter.arrayContains(String field, Object value)

Filter where the field is a list that contains a given value

factory

Filter.arrayContainsAll(String field, List<Object> values)

Filter where the field is a list that contains all values

factory

Filter.arrayContainsAny(String field, List<Object> values)

Filter where the field is a list that contains any of the given values

factory

Filter.byKey(Object? key)

Filter by key.

factory

Filter.custom(bool matches(RecordSnapshot<Key?, Value?> record))

Custom filter, use with caution and do not modify record data as it provides a raw access to the record internal value for efficiency.

factory

Filter.equals(String field, Object? value, {bool? anyInList})

field value must be equals to value.

factory

Filter.greaterThan(String field, Object? value)

Filter where the field is greater than the specified value

factory

Filter.greaterThanOrEquals(String field, Object? value)

Filter where the field is less than or equals to the specified value

factory

Filter.inList(String field, List<Object> list)

Filter where the field is in the list of values

factory

Filter.isNull(String field)

Filter where the field value is null.

factory

Filter.lessThan(String field, Object? value)

Filter where the field value is less than the specified value.

factory

Filter.lessThanOrEquals(String field, Object? value)

Filter where the field value is less than or equals to the specified value.

factory

Filter.matches(String field, String pattern, {bool? anyInList})

Use RegExp pattern matching for the given field which has to be a string.

factory

Filter.matchesRegExp(String field, RegExp regExp, {bool? anyInList})

Filter field value using regExp regular expression.

factory

Filter.not(Filter filter)

Record must not match the given filter.

factory

Filter.notEquals(String field, Object? value)

Filter where the field value is not equals to the specified value.

factory

Filter.notNull(String field)

Filter where the field value is not null.

factory

Filter.or(List<Filter> filters)

Record must match any of the given filters.

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator &(Filter other) → Filter

Available on Filter, provided by the SembastFilterCombination extension

Record must match this and other filter.

operator ==(Object other) → bool

The equality operator.

inherited

operator |(Filter other) → Filter

Available on Filter, provided by the SembastFilterCombination extension

Record must match this or other filter.