PostgrestFilterBuilder<T> class

Inheritance
Available extensions

Constructors

PostgrestFilterBuilder(PostgrestBuilder<T, T, T> builder)

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
toJS → JSPromise<T>

Available on Future<T>, provided by the FutureOfJSAnyToJSPromise extension

A JSPromise that either resolves with the result of the completed Future or rejects with an object that contains its error.
no setter
toJS → JSPromise<JSAny?>

Available on Future<void>, provided by the FutureOfVoidToJSPromise extension

A JSPromise that either resolves once this Future completes or rejects with an object that contains its error.
no setter

Methods

appendSearchParams(String key, String value, [Uri? url]) → Uri
Get new Uri with updated queryParams Uses lists to allow multiple values for the same key
inherited
asStream() → Stream<T>
Creates a Stream containing the result of this future.
inherited
catchError(Function onError, {bool test(Object error)?}) → Future<T>
Handles errors emitted by this Future.
inherited
containedBy(String column, Object value) → PostgrestFilterBuilder<T>
Finds all rows whose json, array, or range value on the stated column is contained by the specified value.
contains(String column, Object value) → PostgrestFilterBuilder<T>
Finds all rows whose json, array, or range value on the stated column contains the values specified in value.
copyWithUrl(Uri url) → PostgrestFilterBuilder<T>
override
count([CountOption count = CountOption.exact]) → ResponsePostgrestBuilder<PostgrestResponse<T>, T, T>
Performs additionally to the select a count query.
inherited
csv() → PostgrestTransformBuilder<String>
Retrieves the response as CSV.
inherited
eq(String column, Object value) → PostgrestFilterBuilder<T>
Finds all rows whose value on the stated column exactly matches the specified value.
explain({bool analyze = false, bool verbose = false, bool settings = false, bool buffers = false, bool wal = false}) → PostgrestBuilder<String, String, String>
Obtains the EXPLAIN plan for this request.
inherited
filter(String column, String operator, Object? value) → PostgrestFilterBuilder<T>
Finds all rows whose column satisfies the filter.
geojson() → ResponsePostgrestBuilder<Map<String, dynamic>, Map<String, dynamic>, Map<String, dynamic>>
Enables support for GeoJSON for use with PostGIS data types Used when you need the complete response to be in GeoJSON format. You will need to enable the PostGIS extension for this to work.
inherited
gt(String column, Object value) → PostgrestFilterBuilder<T>
Finds all rows whose value on the stated column is greater than the specified value.
gte(String column, Object value) → PostgrestFilterBuilder<T>
Finds all rows whose value on the stated column is greater than or equal to the specified value.
Performs a head request.
inherited
ignore() → void

Available on Future<T>, provided by the FutureExtensions extension

Completely ignores this future and its result.
ilike(String column, String pattern) → PostgrestFilterBuilder<T>
Finds all rows whose value in the stated column matches the supplied pattern (case insensitive).
ilikeAllOf(String column, List<String> patterns) → PostgrestFilterBuilder
Match only rows where column matches all of patterns case-insensitively.
ilikeAnyOf(String column, List<String> patterns) → PostgrestFilterBuilder
Match only rows where column matches any of patterns case-insensitively.
imatchRegex(String column, String pattern) → PostgrestFilterBuilder<T>
Finds all rows whose value in the stated column matches the supplied pattern using PostgreSQL regular expression (case insensitive).
inFilter(String column, List values) → PostgrestFilterBuilder<T>
Finds all rows whose value on the stated column is found on the specified values.
isDistinct(String column, Object? value) → PostgrestFilterBuilder<T>
Finds all rows whose value on the stated column is not equal to the specified value, treating NULL as a comparable value.
isFilter(String column, bool? value) → PostgrestFilterBuilder<T>
A check for exact equality (null, true, false)
like(String column, String pattern) → PostgrestFilterBuilder<T>
Finds all rows whose value in the stated column matches the supplied pattern (case sensitive).
likeAllOf(String column, List<String> patterns) → PostgrestFilterBuilder
Match only rows where column matches all of patterns case-sensitively.
likeAnyOf(String column, List<String> patterns) → PostgrestFilterBuilder
Match only rows where column matches any of patterns case-sensitively.
limit(int count, {String? referencedTable}) → PostgrestTransformBuilder<T>
Limits the result with the specified count.
inherited
lt(String column, Object value) → PostgrestFilterBuilder<T>
Finds all rows whose value on the stated column is less than the specified value.
lte(String column, Object value) → PostgrestFilterBuilder<T>
Finds all rows whose value on the stated column is less than or equal to the specified value.
match(Map<String, Object> query) → PostgrestFilterBuilder<T>
Finds all rows whose columns match the specified query object.
matchRegex(String column, String pattern) → PostgrestFilterBuilder<T>
Finds all rows whose value in the stated column matches the supplied pattern using PostgreSQL regular expression (case sensitive).
maxAffected(int value) → PostgrestTransformBuilder<T>
Sets the maximum number of rows that can be affected by the query.
inherited
maybeSingle() → PostgrestTransformBuilder<PostgrestMap?>
Retrieves at most one row from the result.
inherited
neq(String column, Object value) → PostgrestFilterBuilder<T>
Finds all rows whose value on the stated column doesn't match the specified value.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
not(String column, String operator, Object? value) → PostgrestFilterBuilder<T>
Finds all rows which doesn't satisfy the filter.
onError<E extends Object>(FutureOr<T> handleError(E error, StackTrace stackTrace), {bool test(E error)?}) → Future<T>

Available on Future<T>, provided by the FutureExtensions extension

Handles errors on this future.
or(String filters, {String? referencedTable}) → PostgrestFilterBuilder<T>
Finds all rows satisfying at least one of the filters.
order(String column, {bool ascending = false, bool nullsFirst = false, String? referencedTable}) → PostgrestTransformBuilder<T>
Orders the result with the specified column.
inherited
overlaps(String column, Object value) → PostgrestFilterBuilder<T>
Finds all rows whose array or range value on the stated column overlaps (has a value in common) with the specified value.
overrideSearchParams(String key, String value) → Uri
Get new Uri with overridden queryParams
inherited
range(int from, int to, {String? referencedTable}) → PostgrestTransformBuilder<T>
Limits the result to rows within the specified range, inclusive.
inherited
rangeAdjacent(String column, String range) → PostgrestFilterBuilder<T>
Finds all rows whose range value on the stated column is adjacent to the specified range.
rangeGt(String column, String range) → PostgrestFilterBuilder<T>
Finds all rows whose range value on the stated column is strictly to the right of the specified range.
rangeGte(String column, String range) → PostgrestFilterBuilder<T>
Finds all rows whose range value on the stated column does not extend to the left of the specified range.
rangeLt(String column, String range) → PostgrestFilterBuilder<T>
Finds all rows whose range value on the stated column is strictly to the left of the specified range.
rangeLte(String column, String range) → PostgrestFilterBuilder<T>
Finds all rows whose range value on the stated column does not extend to the right of the specified range.
select([String columns = '*']) → PostgrestTransformBuilder<PostgrestList>
Performs horizontal filtering with SELECT.
inherited
setHeader(String key, String value) → PostgrestFilterBuilder<T>
override
single() → PostgrestTransformBuilder<PostgrestMap>
Retrieves only one row from the result.
inherited
textSearch(String column, String query, {String? config, TextSearchType? type}) → PostgrestFilterBuilder<T>
Finds all rows whose text or tsvector value on the stated column matches the tsquery in query.
then<U>(FutureOr<U> onValue(T value), {Function? onError}) → Future<U>
Register callbacks to be called when this future completes.
inherited
timeout(Duration timeLimit, {FutureOr<T> onTimeout()?}) → Future<T>
Stop waiting for this future after timeLimit has passed.
inherited
toString() → String
A string representation of this object.
inherited
whenComplete(FutureOr<void> action()) → Future<T>
Registers a function to be called when this future completes.
inherited
withConverter<U>(PostgrestConverter<U, T> converter) → PostgrestBuilder<U, U, T>
Converts any response that comes from the server into a type-safe response.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited