The AbortSignal to use for the fetch request
Only relevant for jsonb, array, and range columns. Match only rows where
every element appearing in column is contained by value.
The jsonb, array, or range column to filter on
The jsonb, array, or range value to filter with
Only relevant for jsonb, array, and range columns. Match only rows where
every element appearing in column is contained by value.
The jsonb, array, or range column to filter on
The jsonb, array, or range value to filter with
Only relevant for jsonb, array, and range columns. Match only rows where
column contains every element appearing in value.
The jsonb, array, or range column to filter on
The jsonb, array, or range value to filter with
Only relevant for jsonb, array, and range columns. Match only rows where
column contains every element appearing in value.
The jsonb, array, or range column to filter on
The jsonb, array, or range value to filter with
Return data as a string in CSV format.
Match only rows where column is equal to value.
To check if the value of column is NULL, you should use .is() instead.
The column to filter on
The value to filter with
Match only rows where column is equal to value.
To check if the value of column is NULL, you should use .is() instead.
The column to filter on
The value to filter with
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
Match only rows which satisfy the filter. This is an escape hatch - you should use the specific filter methods wherever possible.
Unlike most filters, opearator and value are used as-is and need to
follow PostgREST
syntax. You also need
to make sure they are properly sanitized.
The column to filter on
The operator to filter with, following PostgREST syntax
The value to filter with, following PostgREST syntax
Match only rows which satisfy the filter. This is an escape hatch - you should use the specific filter methods wherever possible.
Unlike most filters, opearator and value are used as-is and need to
follow PostgREST
syntax. You also need
to make sure they are properly sanitized.
The column to filter on
The operator to filter with, following PostgREST syntax
The value to filter with, following PostgREST syntax
Return data as an object in GeoJSON format.
Match only rows where column is greater than value.
The column to filter on
The value to filter with
Match only rows where column is greater than value.
The column to filter on
The value to filter with
Match only rows where column is greater than or equal to value.
The column to filter on
The value to filter with
Match only rows where column is greater than or equal to value.
The column to filter on
The value to filter with
Match only rows where column matches pattern case-insensitively.
The column to filter on
The pattern to match with
Match only rows where column matches pattern case-insensitively.
The column to filter on
The pattern to match with
Match only rows where column matches all of patterns case-insensitively.
The column to filter on
The patterns to match with
Match only rows where column matches all of patterns case-insensitively.
The column to filter on
The patterns to match with
Match only rows where column matches any of patterns case-insensitively.
The column to filter on
The patterns to match with
Match only rows where column matches any of patterns case-insensitively.
The column to filter on
The patterns to match with
Match only rows where column is included in the values array.
The column to filter on
The values array to filter with
Match only rows where column is included in the values array.
The column to filter on
The values array to filter with
Match only rows where column IS value.
For non-boolean columns, this is only relevant for checking if the value of
column is NULL by setting value to null.
For boolean columns, you can also set value to true or false and it
will behave the same way as .eq().
The column to filter on
The value to filter with
Match only rows where column IS value.
For non-boolean columns, this is only relevant for checking if the value of
column is NULL by setting value to null.
For boolean columns, you can also set value to true or false and it
will behave the same way as .eq().
The column to filter on
The value to filter with
Match only rows where column matches pattern case-sensitively.
The column to filter on
The pattern to match with
Match only rows where column matches pattern case-sensitively.
The column to filter on
The pattern to match with
Match only rows where column matches all of patterns case-sensitively.
The column to filter on
The patterns to match with
Match only rows where column matches all of patterns case-sensitively.
The column to filter on
The patterns to match with
Match only rows where column matches any of patterns case-sensitively.
The column to filter on
The patterns to match with
Match only rows where column matches any of patterns case-sensitively.
The column to filter on
The patterns to match with
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
Match only rows where column is less than value.
The column to filter on
The value to filter with
Match only rows where column is less than value.
The column to filter on
The value to filter with
Match only rows where column is less than or equal to value.
The column to filter on
The value to filter with
Match only rows where column is less than or equal to value.
The column to filter on
The value to filter with
Match only rows where each column in query keys is equal to its
associated value. Shorthand for multiple .eq()s.
The object to filter with, with column names as keys mapped to their filter values
Match only rows where each column in query keys is equal to its
associated value. Shorthand for multiple .eq()s.
The object to filter with, with column names as keys mapped to their filter values
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.
Match only rows where column is not equal to value.
The column to filter on
The value to filter with
Match only rows where column is not equal to value.
The column to filter on
The value to filter with
Match only rows which doesn't satisfy the filter.
Unlike most filters, opearator and value are used as-is and need to
follow PostgREST
syntax. You also need
to make sure they are properly sanitized.
The column to filter on
The operator to be negated to filter with, following PostgREST syntax
The value to filter with, following PostgREST syntax
Match only rows which doesn't satisfy the filter.
Unlike most filters, opearator and value are used as-is and need to
follow PostgREST
syntax. You also need
to make sure they are properly sanitized.
The column to filter on
The operator to be negated to filter with, following PostgREST syntax
The value to filter with, following PostgREST syntax
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
Named parameters
Deprecated, use referencedTable instead
Set this to filter on referenced tables instead of the parent table
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
Only relevant for array and range columns. Match only rows where
column and value have an element in common.
The array or range column to filter on
The array or range value to filter with
Only relevant for array and range columns. Match only rows where
column and value have an element in common.
The array or range column to filter on
The array or range value to filter with
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
Only relevant for range columns. Match only rows where column is
mutually exclusive to range and there can be no element between the two
ranges.
The range column to filter on
The range to filter with
Only relevant for range columns. Match only rows where column is
mutually exclusive to range and there can be no element between the two
ranges.
The range column to filter on
The range to filter with
Only relevant for range columns. Match only rows where every element in
column is greater than any element in range.
The range column to filter on
The range to filter with
Only relevant for range columns. Match only rows where every element in
column is greater than any element in range.
The range column to filter on
The range to filter with
Only relevant for range columns. Match only rows where every element in
column is either contained in range or greater than any element in
range.
The range column to filter on
The range to filter with
Only relevant for range columns. Match only rows where every element in
column is either contained in range or greater than any element in
range.
The range column to filter on
The range to filter with
Only relevant for range columns. Match only rows where every element in
column is less than any element in range.
The range column to filter on
The range to filter with
Only relevant for range columns. Match only rows where every element in
column is less than any element in range.
The range column to filter on
The range to filter with
Only relevant for range columns. Match only rows where every element in
column is either contained in range or less than any element in
range.
The range column to filter on
The range to filter with
Only relevant for range columns. Match only rows where every element in
column is either contained in range or less than any element in
range.
The range column to filter on
The range to filter with
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.
Only relevant for text and tsvector columns. Match only rows where
column matches the query string in query.
The text or tsvector column to filter on
The query text to match with
Named parameters
The text search configuration to use
Change how the query text is interpreted
Only relevant for text and tsvector columns. Match only rows where
column matches the query string in query.
The text or tsvector column to filter on
The query text to match with
Named parameters
The text search configuration to use
Change how the query text is interpreted
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.