PostgrestTransformBuilder<T> class

Inheritance
Available extensions

Constructors

PostgrestTransformBuilder(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

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
copyWithUrl(Uri url) → PostgrestTransformBuilder<T>
count([CountOption count = CountOption.exact]) → ResponsePostgrestBuilder<PostgrestResponse<T>, T, T>
Performs additionally to the select a count query.
csv() → PostgrestTransformBuilder<String>
Retrieves the response as CSV.
dryRun() → PostgrestTransformBuilder<T>
Runs the query but rolls back the transaction, so no changes are persisted.
explain({bool analyze = false, bool verbose = false, bool settings = false, bool buffers = false, bool wal = false, ExplainFormat format = ExplainFormat.text}) → PostgrestBuilder<String, String, String>
Obtains the EXPLAIN plan for this request.
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.
Performs a head request.
ignore() → void

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

Completely ignores this future and its result.
limit(int count, {String? referencedTable}) → PostgrestTransformBuilder<T>
Limits the result with the specified count.
maxAffected(int value) → PostgrestTransformBuilder<T>
Sets the maximum number of rows that can be affected by the query.
maybeSingle() → PostgrestTransformBuilder<PostgrestMap?>
Retrieves at most one row from the result.
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.
order(String column, {bool ascending = false, bool nullsFirst = false, String? referencedTable}) → PostgrestTransformBuilder<T>
Orders the result with the specified column.
overrideSearchParams(String key, String value, [Uri? url]) → 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.
retry({bool enabled = true, int? count, Duration? requestTimeout}) → PostgrestTransformBuilder<T>
Overrides the retry behavior for this specific request.
override
select([String columns = '*']) → PostgrestTransformBuilder<PostgrestList>
Performs horizontal filtering with SELECT.
setHeader(String key, String value) → PostgrestTransformBuilder<T>
override
single() → PostgrestTransformBuilder<PostgrestMap>
Retrieves only one row from the result.
stripNulls() → PostgrestTransformBuilder<T>
Omits null-valued properties from the response objects.
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