PostgrestQueryBuilder<T> class

The query builder class provides a convenient interface to creating request queries.

Allows the user to stack the filter functions before they call any of

  • select() - "get"
  • insert() - "post"
  • update() - "patch"
  • delete() - "delete" Once any of these are called the filters are passed down to the Request.
Inheritance
Available extensions

Constructors

PostgrestQueryBuilder({required Uri url, HttpMethod? method, Map<String, String>? headers, String? schema, Client? httpClient, YAJsonIsolate? isolate, bool retryEnabled = true, int retryCount = 3, Set<int> retryableStatusCodes = PostgrestClient.defaultRetryableStatusCodes, Duration retryDelay(int attempt)?, Duration? requestTimeout, Future<void>? abortSignal})
The query builder class provides a convenient interface to creating request queries.

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

abortSignal(Future<void> abortSignal) → PostgrestBuilder<T, T, T>
Allows manually triggering request abortion by completing the provided Future.
inherited
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
count([CountOption option = CountOption.exact]) → PostgrestFilterBuilder<int>
Only performs a count query on the table or view.
delete() → PostgrestFilterBuilder<T>
Perform a DELETE on the table or view.
ignore() → void

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

Completely ignores this future and its result.
insert(Object values, {bool defaultToNull = true}) → PostgrestFilterBuilder<T>
Perform an INSERT into the table or view.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
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.
overrideSearchParams(String key, String value, [Uri? url]) → Uri
Get new Uri with overridden queryParams
inherited
retry({bool enabled = true, int? count, Duration? requestTimeout}) → PostgrestQueryBuilder<T>
Overrides the retry behavior for this specific request.
override
select([String columns = '*']) → PostgrestFilterBuilder<PostgrestList>
Perform a SELECT query on the table or view.
setHeader(String key, String value) → PostgrestQueryBuilder<T>
override
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
update(Map values) → PostgrestFilterBuilder<T>
Perform an UPDATE on the table or view.
upsert(Object values, {String? onConflict, bool ignoreDuplicates = false, bool defaultToNull = true}) → PostgrestFilterBuilder<T>
Perform an UPSERT on the table or view.
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