PostgrestTypedTransformBuilder<Row, T> class

The typed counterpart of PostgrestTransformBuilder.

Row is the type a single row converts into and T is the type the request resolves to when awaited.

Inheritance
Available extensions
Annotations
  • @experimental

Properties

hashCode → int
The hash code for this object.
no setterinherited
request → PostgrestTableRequest
The request awaiting this builder executes.
finalinherited
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

asStream() → Stream<T>
A broadcast stream of the one result. The request runs when the first listener subscribes, so a listener added later still receives it.
inherited
catchError(Function onError, {bool test(Object error)?}) → Future<T>
Handles errors emitted by this Future.
inherited
count([CountOption option = CountOption.exact]) → PostgrestTypedBuilder<PostgrestResponse<T>>
Performs additionally to the query a count query.
csv() → PostgrestTypedTransformBuilder<Row, String>
Retrieves the response as CSV.
dryRun() → PostgrestTypedTransformBuilder<Row, 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}) → PostgrestTypedBuilder<String>
Obtains the EXPLAIN plan for this request.
geojson() → PostgrestTypedBuilder<Map<String, dynamic>>
Enables support for GeoJSON for use with PostGIS data types.
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}) → PostgrestTypedTransformBuilder<Row, T>
Limits the result with the specified count.
maxAffected(int value) → PostgrestTypedTransformBuilder<Row, T>
Sets the maximum number of rows that can be affected by the query.
maybeSingle() → PostgrestTypedTransformBuilder<Row, Element?>

Available on PostgrestTypedTransformBuilder<Row, List<Element>>, provided by the PostgrestTypedRowsBuilder extension

Retrieves at most one row from the result, or null when the result is empty.
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(PostgrestOrdering<Row> ordering) → PostgrestTypedTransformBuilder<Row, T>
Sorts the result by ordering.
range(int from, int to, {String? referencedTable}) → PostgrestTypedTransformBuilder<Row, T>
Limits the result to rows within the specified range, inclusive.
select() → PostgrestTypedTransformBuilder<Row, List<Row>>
Performs horizontal filtering with SELECT, returning the affected rows typed as Row.
selectOnly(List<PostgrestSelectable<Row>> columns) → PostgrestTypedTransformBuilder<Row, List<PostgrestPartialRow<Row>>>
Performs horizontal filtering with SELECT, returning columns of the affected rows as PostgrestPartialRows.
single() → PostgrestTypedTransformBuilder<Row, Element>

Available on PostgrestTypedTransformBuilder<Row, List<Element>>, provided by the PostgrestTypedRowsBuilder extension

Retrieves only one row from the result.
stripNulls() → PostgrestTypedTransformBuilder<Row, 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

Operators

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