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.
Optional
options: { Named parameters
Optional
analyze?: booleanIf true
, the query will be executed and the
actual run time will be returned
Optional
buffers?: booleanIf true
, include information on buffer usage
Optional
format?: "text" | "json"The format of the output, can be "text"
(default)
or "json"
Optional
settings?: booleanIf true
, include information on configuration
parameters that affect query planning
Optional
verbose?: booleanIf true
, the query identifier will be returned
and data
will include the output columns of the query
Optional
wal?: booleanIf true
, include information on WAL record generation
Optional
init: RequestInitOptional
init: RequestInitReturn data
as an object in GeoJSON format.
Limit the query result by count
.
The maximum number of rows to return
Optional
options: { Named parameters
Optional
foreignDeprecated, use options.referencedTable
instead
Optional
referencedSet this to limit rows of referenced tables instead of the parent table
Match only rows which satisfy at least one of the filters.
Unlike most filters, filters
is used as-is and needs to follow PostgREST
syntax. You also need
to make sure it's properly sanitized.
It's currently not possible to do an .or()
filter across multiple tables.
The filters to use, following PostgREST syntax
Optional
options: { Named parameters
Optional
foreignDeprecated, use referencedTable
instead
Optional
referencedSet this to filter on referenced tables instead of the parent table
Optional
options: { Optional
ascending?: booleanOptional
nullsOptional
referencedOptional
options: { Optional
ascending?: booleanOptional
nullsOptional
referencedOptional
options: { Optional
ascending?: booleanOptional
foreignOptional
nullsOptional
options: { Optional
ascending?: booleanOptional
foreignOptional
nullsLimit 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
Optional
options: { Named parameters
Optional
foreignDeprecated, use options.referencedTable
instead
Optional
referencedSet this to limit rows of referenced tables instead of the parent table
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
.
Optional
columns: QueryThe columns to retrieve, separated by commas
Optional
options: { Optional
config?: stringOptional
type?: "websearch" | "plain" | "phrase"Optional
options: { Optional
config?: stringOptional
type?: "websearch" | "plain" | "phrase"If there's an error with the query, throwOnError will reject the promise by throwing the error instead of returning it as part of a successful response.
Set the AbortSignal for the fetch request.