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, include information on buffer usage
The format of the output, can be "text" (default)
or "json"
If true, include information on configuration
parameters that affect query planning
If true, the query identifier will be returned
and data will include the output columns of the query
If true, include information on WAL record generation
Return data as an object in GeoJSON format.
Limit the query result by count.
The maximum number of rows to return
Named parameters
Deprecated, use options.referencedTable
instead
Set this to limit rows of referenced tables instead of the parent table
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.
Order the query result by column.
You can call this method multiple times to order by multiple columns.
You can order referenced tables, but it only affects the ordering of the
parent table if you use !inner in the query.
The column to order by
Named parameters
If true, the result will be in ascending order
If true, nulls appear first. If false,
nulls appear last.
Set this to order a referenced table by its columns
Order the query result by column.
You can call this method multiple times to order by multiple columns.
You can order referenced tables, but it only affects the ordering of the
parent table if you use !inner in the query.
The column to order by
Named parameters
If true, the result will be in ascending order
If true, nulls appear first. If false,
nulls appear last.
Set this to order a referenced table by its columns
Order the query result by column.
You can call this method multiple times to order by multiple columns.
You can order referenced tables, but it only affects the ordering of the
parent table if you use !inner in the query.
The column to order by
Named parameters
Order the query result by column.
You can call this method multiple times to order by multiple columns.
You can order referenced tables, but it only affects the ordering of the
parent table if you use !inner in the query.
The column to order by
Named parameters
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
Deprecated, use options.referencedTable
instead
Set this to limit rows of referenced tables instead of the parent table
Override the type of the returned data.
The new result type to override with
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
Set an HTTP header for the request.
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.
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.
Generated using TypeDoc
Set the AbortSignal for the fetch request.