PostgrestTransformBuilder
§Type Parameters
§Methods
Set the AbortSignal for the fetch request.
- The AbortSignal to use for the fetch request
Return data
as a string in CSV format.
Return data
as the EXPLAIN plan for the query.
You need to enable the db_plan_enabled setting before using this method.
- Named parameters
- If
true
, the query will be executed and the actual run time will be returned
- If
true
, the query identifier will be returned anddata
will include the output columns of the query
- If
true
, include information on configuration parameters that affect query planning
- If
true
, include information on buffer usage
- If
true
, include information on WAL record generation
- The format of the output, can be
"text"
(default) or"json"
Return data
as an object in GeoJSON format.
Limit the query result by count
.
- The maximum number of rows to return
- Named parameters
- Set this to limit rows of referenced tables instead of the parent table
- Deprecated, use
options.referencedTable
instead
Set the maximum number of rows that can be affected by the query. Only available in PostgREST v13+ and only works with PATCH and DELETE methods.
- The maximum number of rows that can be affected
Return data
as a single object instead of an array of objects.
Query result must be zero or one row (e.g. using .limit(1)
), otherwise
this returns an error.
Use options.referencedTable
instead of options.foreignTable
Use options.referencedTable
instead of options.foreignTable
Limit the query result by starting at an offset from
and ending at the offset to
.
Only records within this range are returned.
This respects the query order and if there is no order clause the range could behave unexpectedly.
The from
and to
values are 0-based and inclusive: range(1, 3)
will include the second, third
and fourth rows of the query.
- The starting index from which to limit the result
- The last index to which to limit the result
- Named parameters
- Set this to limit rows of referenced tables instead of the parent table
- Deprecated, use
options.referencedTable
instead
Override the type of the returned data
.
Use overrideTypes<yourType, { merge: false }>() method at the end of your call chain instead
Rollback the query.
data
will still be returned, but the query is not committed.
Perform a SELECT on the query result.
By default, .insert()
, .update()
, .upsert()
, and .delete()
do not
return modified rows. By calling this method, modified rows are returned in
data
.
- The columns to retrieve, separated by commas
Return data
as a single object instead of an array of objects.
Query result must be one row (e.g. using .limit(1)
), otherwise this
returns an error.