Result-shape transforms: order, limit, range, single, csv, geojson, explain, rollback, returning.
Result-shape transforms: order, limit, range, single, csv, geojson, explain, rollback, returning.
(explain req)(explain req opts)Return the EXPLAIN plan for the query. Requires db_plan_enabled
on the Supabase project.
Return the EXPLAIN plan for the query. Requires `db_plan_enabled` on the Supabase project.
(geojson req)Return data as a GeoJSON object.
Return data as a GeoJSON object.
(limit req n)(limit req n opts)Limit results to n. Optionally scope to a foreign table.
Limit results to `n`. Optionally scope to a foreign table.
(maybe-single req)Like single but tolerates 0-row results. GET requests use json; other
methods use pgrst-object.
Like `single` but tolerates 0-row results. GET requests use json; other methods use pgrst-object.
(order req column)(order req column opts)Order results by column. Multiple calls stack.
Opts: :asc — boolean (default false → desc, matching elixir port) :null-first — boolean (default false → nullslast) :foreign-table — scope order to a related table
Order results by `column`. Multiple calls stack. Opts: :asc — boolean (default false → desc, matching elixir port) :null-first — boolean (default false → nullslast) :foreign-table — scope order to a related table
(range req from to)(range req from to opts)0-based inclusive range. (range req 1 3) returns rows 2, 3, 4.
0-based inclusive range. `(range req 1 3)` returns rows 2, 3, 4.
(returning req)(returning req columns)Selects which columns are returned for INSERT/UPDATE/UPSERT/DELETE.
columns is [] (all columns), a vector of names, or "*".
Selects which columns are returned for INSERT/UPDATE/UPSERT/DELETE. `columns` is `[]` (all columns), a vector of names, or `"*"`.
(rollback req)Run the query without committing. Data still returned.
Run the query without committing. Data still returned.
(set-accept req media-type)Replaces the request's accept header with the value mapped to
media-type (a keyword from accept-headers).
Replaces the request's `accept` header with the value mapped to `media-type` (a keyword from `accept-headers`).
(single req)Return data as a single object instead of an array. Errors if rows != 1.
Return data as a single object instead of an array. Errors if rows != 1.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |