SupaFilter<B extends SupaCore> class

Represents a filter that can be applied to a Supabase query.

Filters allow you to only return rows that match certain conditions.

Filters can be used on select(), update(), upsert(), and delete() queries.

Implemented types

• SupaFilterMixin<B>

Implementers

• SupaContainedByArrayFilter
• SupaContainedByJSONFilter
• SupaContainedByRangeFilter
• SupaContainsArrayFilter
• SupaContainsJSONFilter
• SupaContainsRangeFilter
• SupaEqualFilter
• SupaFilterFilter
• SupaGreaterFilter
• SupaGreaterOrEqualFilter
• SupaIncludedInFilter
• SupaIsNullFilter
• SupaLessFilter
• SupaLessOrEqualFilter
• SupaLikeFilter
• SupaMatchFilter
• SupaNotEqualFilter
• SupaNotFilter
• SupaOrFilter
• SupaOverlapsArrayFilter
• SupaOverlapsRangeFilter
• SupaRangeAdjacentFilter
• SupaRangeGreaterFilter
• SupaRangeGreaterOrEqualFilter
• SupaRangeLessFilter
• SupaRangeLessOrEqualFilter
• SupaTextSearchFilter

Constructors

SupaFilter(SupaFilter<B>? previousFilter)

Represents a filter that can be applied to a Supabase query.

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

previousFilter → SupaFilter<B>?

The filter that was applied before this one.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

build<P>(PostgrestFilterBuilder<P> builder) → PostgrestFilterBuilder<P>

Cascades the Supabase filter onto the provided builder.

containedByArray<T>(SupaColumn<B, dynamic, List?> column, List<T> value) → SupaFilter<B>

Array column contained by array value

override

containedByJSON(SupaColumn<B, dynamic, Map<String, dynamic>?> column, Map<String, dynamic> value) → SupaFilter<B>

Jsonb column contained by json value

override

containedByRange<J extends Object>(SupaColumn<B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B>

Range column contained by range value

override

containsArray<J>(SupaColumn<B, dynamic, List<J>?> column, List<J> values) → SupaFilter<B>

Array column contains every element in a value

override

containsJSON(SupaColumn<B, dynamic, Map<String, dynamic>?> column, Map<String, dynamic> json) → SupaFilter<B>

Jsonb column contains every element in a value

override

containsRange<J extends Object>(SupaColumn<B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B>

Range column contains every element in a value

override

equal(SupaValue<B, dynamic, dynamic> value) → SupaFilter<B>

Column is equal to a value

override

filter(String column, String operator, Object? value) → SupaFilter<B>

Match the filter

override

greater(SupaValue<B, dynamic, Object?> value) → SupaFilter<B>

Column is greater than a value

override

greaterOrEqual(SupaValue<B, dynamic, Object?> value) → SupaFilter<B>

Column is greater than or equal to a value

override

includedIn<J>(SupaColumn<B, dynamic, J?> column, List<J> values) → SupaFilter<B>

Column is in an array

override

isNull(SupaColumn<B, dynamic, Object?> column) → SupaFilter<B>

Column is equal to null

override

less(SupaValue<B, dynamic, Object?> value) → SupaFilter<B>

Column is less than a value

override

lessOrEqual(SupaValue<B, dynamic, Object?> value) → SupaFilter<B>

Column is less than or equal to a value

override

like(SupaColumn<B, dynamic, String?> column, String pattern, {bool isCaseSensitive = true}) → SupaFilter<B>

Column matches a pattern

override

match(Set<SupaValue<B, dynamic, dynamic>> values) → SupaFilter<B>

Match an associated value

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

not(String column, String operator, Object? value) → SupaFilter<B>

Don't match the filter

override

notEqual(SupaValue<B, dynamic, dynamic> value) → SupaFilter<B>

Column is not equal to a value

override

or(String filter, {String? referencedTable}) → SupaFilter<B>

Match at least one filter

override

overlapsArray<J>(SupaColumn<B, dynamic, List<J>?> column, List<J> values) → SupaFilter<B>

Array with a common element

override

overlapsRange<J extends Object>(SupaColumn<B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B>

Range with a common element

override

rangeAdjacent<J extends Object>(SupaColumn<B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B>

Mutually exclusive to a range

override

rangeGreater<J extends Object>(SupaColumn<B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B>

Greater than a range

override

rangeGreaterOrEqual<J extends Object>(SupaColumn<B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B>

Greater than or equal to a range

override

rangeLess<J extends Object>(SupaColumn<B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B>

Less than a range

override

rangeLessOrEqual<J extends Object>(SupaColumn<B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B>

Less than or equal to a range

override

textSearch(SupaValue<B, dynamic, String?> searchText, {String? config, TextSearchType? type}) → SupaFilter<B>

Match a string

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited