diff --git a/apps/reference/_supabase_js/generated/containedby.mdx b/apps/reference/_supabase_js/generated/containedby.mdx index a31371f4b96..a67ce9f7428 100644 --- a/apps/reference/_supabase_js/generated/containedby.mdx +++ b/apps/reference/_supabase_js/generated/containedby.mdx @@ -8,8 +8,8 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose json, array, or range value on the stated `column` is -contained by the specified `value`. +Only relevant for jsonb, array, and range columns. Match only rows where +every element appearing in `column` is contained by `value`. ```js const { data, error } = await supabase @@ -36,7 +36,7 @@ const { data, error } = await supabase
-The column to filter on. +The jsonb, array, or range column to filter on
@@ -56,7 +56,7 @@ The column to filter on.
-The value to filter with. +The jsonb, array, or range value to filter with
diff --git a/apps/reference/_supabase_js/generated/contains.mdx b/apps/reference/_supabase_js/generated/contains.mdx index 36f1f707df5..cf9f1bd72ac 100644 --- a/apps/reference/_supabase_js/generated/contains.mdx +++ b/apps/reference/_supabase_js/generated/contains.mdx @@ -8,8 +8,8 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose json, array, or range value on the stated `column` -contains the values specified in `value`. +Only relevant for jsonb, array, and range columns. Match only rows where +`column` contains every element appearing in `value`. ```js const { data, error } = await supabase @@ -36,7 +36,7 @@ const { data, error } = await supabase
-The column to filter on. +The jsonb, array, or range column to filter on
@@ -56,7 +56,7 @@ The column to filter on.
-The value to filter with. +The jsonb, array, or range value to filter with
diff --git a/apps/reference/_supabase_js/generated/delete.mdx b/apps/reference/_supabase_js/generated/delete.mdx index 5d39de0c4c7..eb20f02a558 100644 --- a/apps/reference/_supabase_js/generated/delete.mdx +++ b/apps/reference/_supabase_js/generated/delete.mdx @@ -8,7 +8,10 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Performs a DELETE on the table. +Perform a DELETE on the table or view. + +By default, deleted rows are not returned. To return it, chain the call +with `.select()` after filters. ```js const { data, error } = await supabase @@ -24,7 +27,7 @@ const { data, error } = await supabase

  • - __namedParameters + options required @@ -35,7 +38,7 @@ const { data, error } = await supabase

    -No description provided. +Named parameters
    @@ -56,7 +59,16 @@ No description provided.
    -Count algorithm to use to count rows in a table. +Count algorithm to use to count deleted rows. + +`"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the +hood. + +`"planned"`: Approximated but fast count algorithm. Uses the Postgres +statistics under the hood. + +`"estimated"`: Uses exact count for low numbers and planned count for high +numbers.
    @@ -127,26 +139,6 @@ No description provided.
    • -
  • -

    - - rollback - - - optional - - - boolean - -

    -
    - -Rollback the operation - -
    - -
    • - diff --git a/apps/reference/_supabase_js/generated/eq.mdx b/apps/reference/_supabase_js/generated/eq.mdx index c073e0e8191..bfe7fcc4ecf 100644 --- a/apps/reference/_supabase_js/generated/eq.mdx +++ b/apps/reference/_supabase_js/generated/eq.mdx @@ -8,8 +8,9 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose value on the stated `column` exactly matches the -specified `value`. +Match only rows where `column` is equal to `value`. + +To check if the value of `column` is NULL, you should use `.is()` instead. ```js const { data, error } = await supabase @@ -36,7 +37,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +57,7 @@ The column to filter on.
    -The value to filter with. +The value to filter with
    diff --git a/apps/reference/_supabase_js/generated/filter.mdx b/apps/reference/_supabase_js/generated/filter.mdx index 84740a83798..388b86528f2 100644 --- a/apps/reference/_supabase_js/generated/filter.mdx +++ b/apps/reference/_supabase_js/generated/filter.mdx @@ -8,7 +8,13 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose `column` satisfies the filter. +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](https://postgrest.org/en/stable/api.html#operators). You also need +to make sure they are properly sanitized. ```js const { data, error } = await supabase @@ -35,7 +41,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -55,7 +61,7 @@ The column to filter on.
    -The operator to filter with. +The operator to filter with, following PostgREST syntax
    @@ -540,7 +546,7 @@ No description provided.
    -The value to filter with. +The value to filter with, following PostgREST syntax
    diff --git a/apps/reference/_supabase_js/generated/gt.mdx b/apps/reference/_supabase_js/generated/gt.mdx index 317fd9804df..1f9d5e09f7f 100644 --- a/apps/reference/_supabase_js/generated/gt.mdx +++ b/apps/reference/_supabase_js/generated/gt.mdx @@ -8,8 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose value on the stated `column` is greater than the -specified `value`. +Match only rows where `column` is greater than `value`. ```js const { data, error } = await supabase @@ -36,7 +35,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +55,7 @@ The column to filter on.
    -The value to filter with. +The value to filter with
    diff --git a/apps/reference/_supabase_js/generated/gte.mdx b/apps/reference/_supabase_js/generated/gte.mdx index 6a6e5e513e6..674285a8a85 100644 --- a/apps/reference/_supabase_js/generated/gte.mdx +++ b/apps/reference/_supabase_js/generated/gte.mdx @@ -8,8 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose value on the stated `column` is greater than or -equal to the specified `value`. +Match only rows where `column` is greater than or equal to `value`. ```js const { data, error } = await supabase @@ -36,7 +35,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +55,7 @@ The column to filter on.
    -The value to filter with. +The value to filter with
    diff --git a/apps/reference/_supabase_js/generated/ilike.mdx b/apps/reference/_supabase_js/generated/ilike.mdx index a3076b0b0ca..b2a0c5e332b 100644 --- a/apps/reference/_supabase_js/generated/ilike.mdx +++ b/apps/reference/_supabase_js/generated/ilike.mdx @@ -8,8 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose value in the stated `column` matches the supplied -`pattern` (case insensitive). +Match only rows where `column` matches `pattern` case-insensitively. ```js const { data, error } = await supabase @@ -36,7 +35,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +55,7 @@ The column to filter on.
    -The pattern to filter with. +The pattern to match with
    diff --git a/apps/reference/_supabase_js/generated/in.mdx b/apps/reference/_supabase_js/generated/in.mdx index 155b6f2cb2d..2a2e63afd45 100644 --- a/apps/reference/_supabase_js/generated/in.mdx +++ b/apps/reference/_supabase_js/generated/in.mdx @@ -8,8 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose value on the stated `column` is found on the -specified `values`. +Match only rows where `column` is included in the `values` array. ```js const { data, error } = await supabase @@ -36,7 +35,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +55,7 @@ The column to filter on.
    -The values to filter with. +The values array to filter with
    diff --git a/apps/reference/_supabase_js/generated/index.mdx b/apps/reference/_supabase_js/generated/index.mdx index 22955c42880..c2e0ae69ed0 100644 --- a/apps/reference/_supabase_js/generated/index.mdx +++ b/apps/reference/_supabase_js/generated/index.mdx @@ -2,7 +2,7 @@ id: index title: 'Supabase Client' slug: /supabase-client -custom_edit_url: ../../spec/supabase_js_v2_legacy.yml +custom_edit_url: ../supabase_js_v2_legacy.yml --- import Tabs from '@theme/Tabs' diff --git a/apps/reference/_supabase_js/generated/insert.mdx b/apps/reference/_supabase_js/generated/insert.mdx index 03c4f33f7c4..3672b1fc3ba 100644 --- a/apps/reference/_supabase_js/generated/insert.mdx +++ b/apps/reference/_supabase_js/generated/insert.mdx @@ -8,7 +8,10 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Performs an INSERT into the table. +Perform an INSERT into the table or view. + +By default, inserted rows are not returned. To return it, chain the call +with `.select()`. ```js const { data, error } = await supabase @@ -34,7 +37,8 @@ const { data, error } = await supabase
    -The values to insert. +The values to insert. Pass an object to insert a single row +or an array to insert multiple rows.
    @@ -88,7 +92,7 @@ No description provided.

  • - __namedParameters + options required @@ -99,7 +103,7 @@ No description provided.

    -No description provided. +Named parameters
    @@ -120,7 +124,16 @@ No description provided.
    -Count algorithm to use to count rows in a table. +Count algorithm to use to count inserted rows. + +`"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the +hood. + +`"planned"`: Approximated but fast count algorithm. Uses the Postgres +statistics under the hood. + +`"estimated"`: Uses exact count for low numbers and planned count for high +numbers.
    @@ -191,26 +204,6 @@ No description provided.
    • -
  • -

    - - rollback - - - optional - - - boolean - -

    -
    - -Rollback the operation - -
    - -
    • - diff --git a/apps/reference/_supabase_js/generated/is.mdx b/apps/reference/_supabase_js/generated/is.mdx index f1228f0c3d8..2d3cf423079 100644 --- a/apps/reference/_supabase_js/generated/is.mdx +++ b/apps/reference/_supabase_js/generated/is.mdx @@ -8,8 +8,13 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -A check for exact equality (null, true, false), finds all rows whose -value on the stated `column` exactly match the specified `value`. +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()`. ```js const { data, error } = await supabase @@ -36,7 +41,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +61,7 @@ The column to filter on.
    -The value to filter with. +The value to filter with
    diff --git a/apps/reference/_supabase_js/generated/like.mdx b/apps/reference/_supabase_js/generated/like.mdx index 213c4496032..279c21dbfb0 100644 --- a/apps/reference/_supabase_js/generated/like.mdx +++ b/apps/reference/_supabase_js/generated/like.mdx @@ -8,8 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose value in the stated `column` matches the supplied -`pattern` (case sensitive). +Match only rows where `column` matches `pattern` case-sensitively. ```js const { data, error } = await supabase @@ -36,7 +35,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +55,7 @@ The column to filter on.
    -The pattern to filter with. +The pattern to match with
    diff --git a/apps/reference/_supabase_js/generated/limit.mdx b/apps/reference/_supabase_js/generated/limit.mdx index 904fb1716b8..8c19798a775 100644 --- a/apps/reference/_supabase_js/generated/limit.mdx +++ b/apps/reference/_supabase_js/generated/limit.mdx @@ -8,7 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Limits the result with the specified `count`. +Limit the query result by `count`. ```js const { data, error } = await supabase @@ -35,7 +35,7 @@ const { data, error } = await supabase
    -The maximum no. of rows to limit to. +The maximum number of rows to return
    @@ -44,7 +44,7 @@ The maximum no. of rows to limit to.

  • - foreignTable + options required @@ -55,7 +55,7 @@ The maximum no. of rows to limit to.

    -The foreign table to use (for foreign columns). +Named parameters
    @@ -76,7 +76,8 @@ The foreign table to use (for foreign columns).
    -No description provided. +Set this to limit rows of foreign tables +instead of the current table
    diff --git a/apps/reference/_supabase_js/generated/lt.mdx b/apps/reference/_supabase_js/generated/lt.mdx index 119d5d3da9f..06e9e17587f 100644 --- a/apps/reference/_supabase_js/generated/lt.mdx +++ b/apps/reference/_supabase_js/generated/lt.mdx @@ -8,8 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose value on the stated `column` is less than the -specified `value`. +Match only rows where `column` is less than `value`. ```js const { data, error } = await supabase @@ -36,7 +35,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +55,7 @@ The column to filter on.
    -The value to filter with. +The value to filter with
    diff --git a/apps/reference/_supabase_js/generated/lte.mdx b/apps/reference/_supabase_js/generated/lte.mdx index 10caa460d38..8d0aa520815 100644 --- a/apps/reference/_supabase_js/generated/lte.mdx +++ b/apps/reference/_supabase_js/generated/lte.mdx @@ -8,8 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose value on the stated `column` is less than or equal -to the specified `value`. +Match only rows where `column` is less than or equal to `value`. ```js const { data, error } = await supabase @@ -36,7 +35,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +55,7 @@ The column to filter on.
    -The value to filter with. +The value to filter with
    diff --git a/apps/reference/_supabase_js/generated/match.mdx b/apps/reference/_supabase_js/generated/match.mdx index 546f42dee8a..e814d63ba8b 100644 --- a/apps/reference/_supabase_js/generated/match.mdx +++ b/apps/reference/_supabase_js/generated/match.mdx @@ -8,7 +8,8 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose columns match the specified `query` object. +Match only rows where each column in `query` keys is equal to its +associated value. Shorthand for multiple `.eq()`s. ```js const { data, error } = await supabase @@ -36,7 +37,7 @@ const { data, error } = await supabase
    The object to filter with, with column names as keys mapped -to their filter values. +to their filter values
    diff --git a/apps/reference/_supabase_js/generated/maybesingle.mdx b/apps/reference/_supabase_js/generated/maybesingle.mdx index 7b1d7dd0d06..77c7e0af2a1 100644 --- a/apps/reference/_supabase_js/generated/maybesingle.mdx +++ b/apps/reference/_supabase_js/generated/maybesingle.mdx @@ -8,9 +8,10 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Retrieves at most one row from the result. Result must be at most one row -(e.g. using `eq` on a UNIQUE column), otherwise this will result in an -error. +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. ```js const { data, error } = await supabase diff --git a/apps/reference/_supabase_js/generated/neq.mdx b/apps/reference/_supabase_js/generated/neq.mdx index 05d70c11258..99cdad88837 100644 --- a/apps/reference/_supabase_js/generated/neq.mdx +++ b/apps/reference/_supabase_js/generated/neq.mdx @@ -8,8 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose value on the stated `column` doesn't match the -specified `value`. +Match only rows where `column` is not equal to `value`. ```js const { data, error } = await supabase @@ -36,7 +35,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -56,7 +55,7 @@ The column to filter on.
    -The value to filter with. +The value to filter with
    diff --git a/apps/reference/_supabase_js/generated/not.mdx b/apps/reference/_supabase_js/generated/not.mdx index 4fbd74c182f..6d0acddaf52 100644 --- a/apps/reference/_supabase_js/generated/not.mdx +++ b/apps/reference/_supabase_js/generated/not.mdx @@ -8,7 +8,12 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows which doesn't satisfy the filter. +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](https://postgrest.org/en/stable/api.html#operators). You also need +to make sure they are properly sanitized. ```js const { data, error } = await supabase @@ -35,7 +40,7 @@ const { data, error } = await supabase
    -The column to filter on. +The column to filter on
    @@ -55,7 +60,8 @@ The column to filter on.
    -The operator to filter with. +The operator to be negated to filter with, following +PostgREST syntax
    @@ -75,7 +81,7 @@ The operator to filter with.
    -The value to filter with. +The value to filter with, following PostgREST syntax
    diff --git a/apps/reference/_supabase_js/generated/or.mdx b/apps/reference/_supabase_js/generated/or.mdx index f448c047085..c71a3e65727 100644 --- a/apps/reference/_supabase_js/generated/or.mdx +++ b/apps/reference/_supabase_js/generated/or.mdx @@ -8,7 +8,13 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows satisfying at least one of the filters. +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](https://postgrest.org/en/stable/api.html#operators). You also need +to make sure it's properly sanitized. + +It's currently not possible to do an `.or()` filter across multiple tables. ```js const { data, error } = await supabase @@ -35,7 +41,7 @@ const { data, error } = await supabase
    -The filters to use, separated by commas. +The filters to use, following PostgREST syntax
    @@ -55,7 +61,8 @@ The filters to use, separated by commas.
    -The foreign table to use (if `column` is a foreign column). +Set this to filter on foreign tables instead of the +current table
    diff --git a/apps/reference/_supabase_js/generated/order.mdx b/apps/reference/_supabase_js/generated/order.mdx index e5d0f3822cd..acb56ebe027 100644 --- a/apps/reference/_supabase_js/generated/order.mdx +++ b/apps/reference/_supabase_js/generated/order.mdx @@ -8,7 +8,12 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Orders the result with the specified `column`. +Order the query result by `column`. + +You can call this method multiple times to order by multiple columns. + +You can order foreign tables, but it doesn't affect the ordering of the +current table. ```js const { data, error } = await supabase @@ -35,7 +40,7 @@ const { data, error } = await supabase
    -The column to order on. +The column to order by
    @@ -55,7 +60,7 @@ The column to order on.
    -No description provided. +Named parameters
    @@ -76,7 +81,7 @@ No description provided.
    -No description provided. +If `true`, the result will be in ascending order
    @@ -96,7 +101,8 @@ No description provided.
    -No description provided. +Set this to order a foreign table by foreign +columns
    @@ -116,7 +122,8 @@ No description provided.
    -No description provided. +If `true`, `null`s appear first. If `false`, +`null`s appear last.
    diff --git a/apps/reference/_supabase_js/generated/overlaps.mdx b/apps/reference/_supabase_js/generated/overlaps.mdx index 21d92e6ad7a..230a3e74343 100644 --- a/apps/reference/_supabase_js/generated/overlaps.mdx +++ b/apps/reference/_supabase_js/generated/overlaps.mdx @@ -8,8 +8,8 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose array or range value on the stated `column` overlaps -(has a value in common) with the specified `value`. +Only relevant for array and range columns. Match only rows where +`column` and `value` have an element in common. ```js const { data, error } = await supabase @@ -36,7 +36,7 @@ const { data, error } = await supabase
    -The column to filter on. +The array or range column to filter on
    @@ -56,7 +56,7 @@ The column to filter on.
    -The value to filter with. +The array or range value to filter with
    diff --git a/apps/reference/_supabase_js/generated/range.mdx b/apps/reference/_supabase_js/generated/range.mdx index ffa3c3d597c..d993ff88901 100644 --- a/apps/reference/_supabase_js/generated/range.mdx +++ b/apps/reference/_supabase_js/generated/range.mdx @@ -8,7 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Limits the result to rows within the specified range, inclusive. +Limit the query result by `from` and `to` inclusively. ```js const { data, error } = await supabase @@ -35,7 +35,7 @@ const { data, error } = await supabase
    -The starting index from which to limit the result, inclusive. +The starting index from which to limit the result
    @@ -55,7 +55,7 @@ The starting index from which to limit the result, inclusive.
    -The last index to which to limit the result, inclusive. +The last index to which to limit the result
    @@ -64,7 +64,7 @@ The last index to which to limit the result, inclusive.

  • - foreignTable + options required @@ -75,7 +75,7 @@ The last index to which to limit the result, inclusive.

    -The foreign table to use (for foreign columns). +Named parameters
    @@ -96,7 +96,8 @@ The foreign table to use (for foreign columns).
    -No description provided. +Set this to limit rows of foreign tables +instead of the current table
    diff --git a/apps/reference/_supabase_js/generated/rangeadjacent.mdx b/apps/reference/_supabase_js/generated/rangeadjacent.mdx index 1affe88d70f..68354ef9c71 100644 --- a/apps/reference/_supabase_js/generated/rangeadjacent.mdx +++ b/apps/reference/_supabase_js/generated/rangeadjacent.mdx @@ -8,8 +8,9 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose range value on the stated `column` is adjacent to -the specified `range`. +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. ```js const { data, error } = await supabase @@ -36,7 +37,7 @@ const { data, error } = await supabase
    -The column to filter on. +The range column to filter on
    @@ -56,7 +57,7 @@ The column to filter on.
    -The range to filter with. +The range to filter with
    diff --git a/apps/reference/_supabase_js/generated/rangegt.mdx b/apps/reference/_supabase_js/generated/rangegt.mdx index 15c346bc81f..7e83b481a63 100644 --- a/apps/reference/_supabase_js/generated/rangegt.mdx +++ b/apps/reference/_supabase_js/generated/rangegt.mdx @@ -8,8 +8,8 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose range value on the stated `column` is strictly to -the right of the specified `range`. +Only relevant for range columns. Match only rows where every element in +`column` is greater than any element in `range`. ```js const { data, error } = await supabase @@ -36,7 +36,7 @@ const { data, error } = await supabase
    -The column to filter on. +The range column to filter on
    @@ -56,7 +56,7 @@ The column to filter on.
    -The range to filter with. +The range to filter with
    diff --git a/apps/reference/_supabase_js/generated/rangegte.mdx b/apps/reference/_supabase_js/generated/rangegte.mdx index 5dd689bff4d..0db21b6b434 100644 --- a/apps/reference/_supabase_js/generated/rangegte.mdx +++ b/apps/reference/_supabase_js/generated/rangegte.mdx @@ -8,8 +8,9 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose range value on the stated `column` does not extend -to the left of the specified `range`. +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`. ```js const { data, error } = await supabase @@ -36,7 +37,7 @@ const { data, error } = await supabase
    -The column to filter on. +The range column to filter on
    @@ -56,7 +57,7 @@ The column to filter on.
    -The range to filter with. +The range to filter with
    diff --git a/apps/reference/_supabase_js/generated/rangelt.mdx b/apps/reference/_supabase_js/generated/rangelt.mdx index 5252510dcf8..9137e1f8ac7 100644 --- a/apps/reference/_supabase_js/generated/rangelt.mdx +++ b/apps/reference/_supabase_js/generated/rangelt.mdx @@ -8,8 +8,8 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose range value on the stated `column` is strictly to the -left of the specified `range`. +Only relevant for range columns. Match only rows where every element in +`column` is less than any element in `range`. ```js const { data, error } = await supabase @@ -36,7 +36,7 @@ const { data, error } = await supabase
    -The column to filter on. +The range column to filter on
    @@ -56,7 +56,7 @@ The column to filter on.
    -The range to filter with. +The range to filter with
    diff --git a/apps/reference/_supabase_js/generated/rangelte.mdx b/apps/reference/_supabase_js/generated/rangelte.mdx index 495037f6a6f..f45c374282c 100644 --- a/apps/reference/_supabase_js/generated/rangelte.mdx +++ b/apps/reference/_supabase_js/generated/rangelte.mdx @@ -8,8 +8,9 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose range value on the stated `column` does not extend -to the right of the specified `range`. +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`. ```js const { data, error } = await supabase @@ -36,7 +37,7 @@ const { data, error } = await supabase
    -The column to filter on. +The range column to filter on
    @@ -56,7 +57,7 @@ The column to filter on.
    -The range to filter with. +The range to filter with
    diff --git a/apps/reference/_supabase_js/generated/rpc.mdx b/apps/reference/_supabase_js/generated/rpc.mdx index 1fe6b7dc081..d5247808471 100644 --- a/apps/reference/_supabase_js/generated/rpc.mdx +++ b/apps/reference/_supabase_js/generated/rpc.mdx @@ -41,7 +41,7 @@ const { data, error } = await supabase.rpc('hello_world')
    -The function name to call. +The function name to call
    @@ -61,7 +61,7 @@ The function name to call.
    -The parameters to pass to the function call. +The arguments to pass to the function call
    @@ -81,7 +81,7 @@ The parameters to pass to the function call.
    -Named parameters. +Named parameters
    @@ -102,7 +102,18 @@ Named parameters.
    -Count algorithm to use to count rows in a table. +Count algorithm to use to count rows returned by the +function. Only applicable for [set-returning +functions](https://www.postgresql.org/docs/current/functions-srf.html). + +`"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the +hood. + +`"planned"`: Approximated but fast count algorithm. Uses the Postgres +statistics under the hood. + +`"estimated"`: Uses exact count for low numbers and planned count for high +numbers.
    @@ -187,27 +198,8 @@ No description provided.
    -When set to true, no data will be returned. - -
    - -
    • - -
  • -

    - - rollback - - - optional - - - boolean - -

    -
    - -Rollback the operation +When set to `true`, `data` will not be returned. +Useful if you only need the count.
    diff --git a/apps/reference/_supabase_js/generated/select.mdx b/apps/reference/_supabase_js/generated/select.mdx index f857c1aa310..276461f0eb6 100644 --- a/apps/reference/_supabase_js/generated/select.mdx +++ b/apps/reference/_supabase_js/generated/select.mdx @@ -8,7 +8,7 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Performs vertical filtering with SELECT. +Perform a SELECT query on the table or view. ```js const { data, error } = await supabase.from('cities').select() @@ -32,7 +32,7 @@ const { data, error } = await supabase.from('cities').select()
    -The columns to retrieve, separated by commas. +The columns to retrieve, separated by commas
    @@ -41,7 +41,7 @@ The columns to retrieve, separated by commas.

  • - __namedParameters + options required @@ -52,7 +52,7 @@ The columns to retrieve, separated by commas.

    -No description provided. +Named parameters
    @@ -73,7 +73,16 @@ No description provided.
    -Count algorithm to use to count rows in a table. +Count algorithm to use to count rows in the table or view. + +`"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the +hood. + +`"planned"`: Approximated but fast count algorithm. Uses the Postgres +statistics under the hood. + +`"estimated"`: Uses exact count for low numbers and planned count for high +numbers.
    @@ -158,7 +167,8 @@ No description provided.
    -When set to true, select will void data. +When set to `true`, `data` will not be returned. +Useful if you only need the count.
    diff --git a/apps/reference/_supabase_js/generated/single.mdx b/apps/reference/_supabase_js/generated/single.mdx index f8c0fe17ef5..c012196ab58 100644 --- a/apps/reference/_supabase_js/generated/single.mdx +++ b/apps/reference/_supabase_js/generated/single.mdx @@ -8,8 +8,10 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Retrieves only one row from the result. Result must be one row (e.g. using -`limit`), otherwise this will result in an error. +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. ```js const { data, error } = await supabase diff --git a/apps/reference/_supabase_js/generated/textsearch.mdx b/apps/reference/_supabase_js/generated/textsearch.mdx index 14135ae9fff..d26d6b4a31b 100644 --- a/apps/reference/_supabase_js/generated/textsearch.mdx +++ b/apps/reference/_supabase_js/generated/textsearch.mdx @@ -8,8 +8,8 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Finds all rows whose text or tsvector value on the stated `column` matches -the tsquery in `query`. +Only relevant for text and tsvector columns. Match only rows where +`column` matches the query string in `query`. ## Parameters @@ -29,7 +29,7 @@ the tsquery in `query`.
    -The column to filter on. +The text or tsvector column to filter on
    @@ -49,7 +49,7 @@ The column to filter on.
    -The Postgres tsquery string to filter with. +The query text to match with
    @@ -69,7 +69,7 @@ The Postgres tsquery string to filter with.
    -No description provided. +Named parameters
    @@ -90,7 +90,7 @@ No description provided.
    -No description provided. +The text search configuration to use
    @@ -110,7 +110,7 @@ No description provided.
    -No description provided. +Change how the `query` text is interpreted
    diff --git a/apps/reference/_supabase_js/generated/update.mdx b/apps/reference/_supabase_js/generated/update.mdx index 1e01e58e41b..c2adbc12f24 100644 --- a/apps/reference/_supabase_js/generated/update.mdx +++ b/apps/reference/_supabase_js/generated/update.mdx @@ -8,7 +8,10 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Performs an UPDATE on the table. +Perform an UPDATE on the table or view. + +By default, updated rows are not returned. To return it, chain the call +with `.select()` after filters. ```js const { data, error } = await supabase @@ -35,7 +38,7 @@ const { data, error } = await supabase
    -The values to update. +The values to update with
    @@ -44,7 +47,7 @@ The values to update.

  • - __namedParameters + options required @@ -55,7 +58,7 @@ The values to update.

    -No description provided. +Named parameters
    @@ -76,7 +79,16 @@ No description provided.
    -Count algorithm to use to count rows in a table. +Count algorithm to use to count updated rows. + +`"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the +hood. + +`"planned"`: Approximated but fast count algorithm. Uses the Postgres +statistics under the hood. + +`"estimated"`: Uses exact count for low numbers and planned count for high +numbers.
    @@ -147,26 +159,6 @@ No description provided.
    • -
  • -

    - - rollback - - - optional - - - boolean - -

    -
    - -Rollback the operation - -
    - -
    • - diff --git a/apps/reference/_supabase_js/generated/upsert.mdx b/apps/reference/_supabase_js/generated/upsert.mdx index abd86057a36..038d48d1099 100644 --- a/apps/reference/_supabase_js/generated/upsert.mdx +++ b/apps/reference/_supabase_js/generated/upsert.mdx @@ -8,7 +8,14 @@ custom_edit_url: https://github.com/supabase/supabase/edit/master/spec/supabase_ import Tabs from '@theme/Tabs' import TabItem from '@theme/TabItem' -Performs an UPSERT into the table. +Perform an UPSERT on the table or view. Depending on the column(s) passed +to `onConflict`, `.upsert()` allows you to perform the equivalent of +`.insert()` if a row with the corresponding `onConflict` columns doesn't +exist, or if it does exist, perform an alternative action depending on +`ignoreDuplicates`. + +By default, upserted rows are not returned. To return it, chain the call +with `.select()`. ```js const { data, error } = await supabase @@ -34,7 +41,8 @@ const { data, error } = await supabase
    -The values to insert. +The values to upsert with. Pass an object to upsert a +single row or an array to upsert multiple rows.
    @@ -88,7 +96,7 @@ No description provided.

  • - __namedParameters + options required @@ -99,7 +107,7 @@ No description provided.

    -No description provided. +Named parameters
    @@ -120,7 +128,16 @@ No description provided.
    -Count algorithm to use to count rows in a table. +Count algorithm to use to count upserted rows. + +`"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the +hood. + +`"planned"`: Approximated but fast count algorithm. Uses the Postgres +statistics under the hood. + +`"estimated"`: Uses exact count for low numbers and planned count for high +numbers.
    @@ -205,7 +222,8 @@ No description provided.
    -Specifies if duplicate rows should be ignored and not inserted. +If `true`, duplicate rows are ignored. If +`false`, duplicate rows are merged with existing rows.
    @@ -225,27 +243,9 @@ Specifies if duplicate rows should be ignored and not inserted.
    -By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint. - -
    - -
    • - -
  • -

    - - rollback - - - optional - - - boolean - -

    -
    - -Rollback the operation +Comma-separated UNIQUE column(s) to specify how +duplicate rows are determined. Two rows are duplicates if all the +`onConflict` columns are equal.
    diff --git a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-resetpasswordforemail.mdx b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-resetpasswordforemail.mdx index a36182e2850..3f43f15a224 100644 --- a/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-resetpasswordforemail.mdx +++ b/apps/reference/_supabase_js_versioned_docs/version-v1/auth-api-resetpasswordforemail.mdx @@ -139,9 +139,9 @@ const { data, error } = await supabase.auth.api.resetPasswordForEmail( const { data, error } = await supabase.auth.api.resetPasswordForEmail( 'user@email.com' ) - + /** - * Step 2: Once the user is redirected back to your application, + * Step 2: Once the user is redirected back to your application, * ask the user to reset their password. */ useEffect(() => { @@ -151,10 +151,10 @@ useEffect(() => { const { data, error } = await supabase.auth.update({ password: newPassword, }) - + if (data) alert('Password updated successfully!') if (error) alert('There was an error updating your password.') - } + } }) }, []) ``` diff --git a/spec/README.md b/spec/README.md index 5c2dc30f9c9..53d57168430 100644 --- a/spec/README.md +++ b/spec/README.md @@ -13,4 +13,4 @@ To get started, run `make init`. This installs all dependencies. make # download latest specs and add enrichments make.generate # transform the specs into docs -``` \ No newline at end of file +``` diff --git a/spec/enrichments/tsdoc_v2/combined.json b/spec/enrichments/tsdoc_v2/combined.json index ec34e38365b..a081431e174 100644 --- a/spec/enrichments/tsdoc_v2/combined.json +++ b/spec/enrichments/tsdoc_v2/combined.json @@ -61917,7 +61917,7 @@ "originalName": "", "children": [ { - "id": 481, + "id": 486, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -61926,7 +61926,7 @@ }, "children": [ { - "id": 482, + "id": 487, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -61940,14 +61940,14 @@ ], "signatures": [ { - "id": 483, + "id": 488, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 484, + "id": 489, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -61956,24 +61956,24 @@ ], "parameters": [ { - "id": 485, + "id": 490, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], "name": "default", "dereferenced": { - "id": 481, + "id": 486, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -61985,17 +61985,17 @@ { "title": "Constructors", "kind": 512, - "children": [482] + "children": [487] }, { "title": "Properties", "kind": 1024, - "children": [498, 490, 493, 488, 486, 489, 491, 492, 487] + "children": [503, 495, 498, 493, 491, 494, 496, 497, 492] }, { "title": "Methods", "kind": 2048, - "children": [501, 499] + "children": [506, 504] } ], "sources": [ @@ -62007,7 +62007,7 @@ ], "typeParameter": [ { - "id": 513, + "id": 518, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -62017,7 +62017,7 @@ "extendedBy": [ { "type": "reference", - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder" } ], @@ -62027,11 +62027,11 @@ "typeArguments": [ { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -62049,11 +62049,11 @@ ], "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -62063,7 +62063,7 @@ ] }, { - "id": 498, + "id": 503, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -62083,7 +62083,7 @@ } }, { - "id": 490, + "id": 495, "name": "body", "kind": 1024, "kindString": "Property", @@ -62104,7 +62104,7 @@ } }, { - "id": 493, + "id": 498, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -62121,34 +62121,45 @@ "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 499, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 495, + "id": 500, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 501, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 497, + "id": 502, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -62183,7 +62194,7 @@ } }, { - "id": 488, + "id": 493, "name": "headers", "kind": 1024, "kindString": "Property", @@ -62215,7 +62226,7 @@ } }, { - "id": 486, + "id": 491, "name": "method", "kind": 1024, "kindString": "Property", @@ -62256,7 +62267,7 @@ } }, { - "id": 489, + "id": 494, "name": "schema", "kind": 1024, "kindString": "Property", @@ -62277,7 +62288,7 @@ } }, { - "id": 491, + "id": 496, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -62298,7 +62309,7 @@ "defaultValue": "false" }, { - "id": 492, + "id": 497, "name": "signal", "kind": 1024, "kindString": "Property", @@ -62321,7 +62332,7 @@ } }, { - "id": 487, + "id": 492, "name": "url", "kind": 1024, "kindString": "Property", @@ -62343,7 +62354,7 @@ } }, { - "id": 501, + "id": 506, "name": "then", "kind": 2048, "kindString": "Method", @@ -62357,25 +62368,25 @@ ], "signatures": [ { - "id": 502, + "id": 507, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 503, + "id": 508, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -62383,7 +62394,7 @@ } }, { - "id": 504, + "id": 509, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -62396,7 +62407,7 @@ ], "parameters": [ { - "id": 505, + "id": 510, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -62413,32 +62424,32 @@ { "type": "reflection", "declaration": { - "id": 506, + "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 507, + "id": 512, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 508, + "id": 513, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -62451,7 +62462,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -62459,7 +62470,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -62477,7 +62488,7 @@ } }, { - "id": 509, + "id": 514, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -62494,21 +62505,21 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 515, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 511, + "id": 516, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 512, + "id": 517, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -62524,7 +62535,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -62532,7 +62543,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -62558,12 +62569,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -62585,7 +62596,7 @@ } }, { - "id": 499, + "id": 504, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -62599,7 +62610,7 @@ ], "signatures": [ { - "id": 500, + "id": 505, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -62610,11 +62621,11 @@ }, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -62628,17 +62639,17 @@ { "title": "Constructors", "kind": 512, - "children": [482] + "children": [487] }, { "title": "Properties", "kind": 1024, - "children": [498, 490, 493, 488, 486, 489, 491, 492, 487] + "children": [503, 495, 498, 493, 491, 494, 496, 497, 492] }, { "title": "Methods", "kind": 2048, - "children": [501, 499] + "children": [506, 504] } ], "sources": [ @@ -62650,7 +62661,7 @@ ], "typeParameter": [ { - "id": 513, + "id": 518, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -62660,7 +62671,7 @@ "extendedBy": [ { "type": "reference", - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder" } ], @@ -62670,11 +62681,11 @@ "typeArguments": [ { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -62693,6 +62704,9 @@ "kind": 128, "kindString": "Class", "flags": {}, + "comment": { + "shortText": "PostgREST client." + }, "children": [ { "id": 2, @@ -62703,7 +62717,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 29, + "line": 41, "character": 2 } ], @@ -62833,7 +62847,7 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "URL of the PostgREST endpoint." + "shortText": "URL of the PostgREST endpoint" }, "type": { "type": "intrinsic", @@ -62842,10 +62856,14 @@ }, { "id": 8, - "name": "__namedParameters", + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { @@ -62866,7 +62884,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 38, + "line": 50, "character": 6 } ], @@ -62885,6 +62903,9 @@ "kind": 4096, "kindString": "Call signature", "flags": {}, + "comment": { + "shortText": "Custom fetch\n" + }, "parameters": [ { "id": 15, @@ -62893,10 +62914,21 @@ "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { @@ -62942,10 +62974,13 @@ "flags": { "isOptional": true }, + "comment": { + "shortText": "Custom headers" + }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 36, + "line": 48, "character": 6 } ], @@ -62974,10 +63009,13 @@ "flags": { "isOptional": true }, + "comment": { + "shortText": "Postgres schema to switch to" + }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 37, + "line": 49, "character": 6 } ], @@ -63036,7 +63074,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 19, + "line": 29, "character": 2 } ], @@ -63063,10 +63101,21 @@ "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { @@ -63113,7 +63162,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 17, + "line": 27, "character": 2 } ], @@ -63145,7 +63194,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 18, + "line": 28, "character": 2 } ], @@ -63164,7 +63213,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 16, + "line": 26, "character": 2 } ], @@ -63182,7 +63231,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 52, + "line": 64, "character": 2 } ], @@ -63194,7 +63243,7 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a table operation." + "shortText": "Perform a query on a table or a view." }, "typeParameter": [ { @@ -63223,12 +63272,12 @@ "parameters": [ { "id": 29, - "name": "table", + "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table name to operate on.\n" + "shortText": "The table or view name to query\n" }, "type": { "type": "reference", @@ -63240,7 +63289,7 @@ ], "type": { "type": "reference", - "id": 46, + "id": 49, "typeArguments": [ { "type": "reference", @@ -63257,10 +63306,68 @@ "kind": 4096, "kindString": "Call signature", "flags": {}, - "parameters": [ + "typeParameter": [ { "id": 31, - "name": "table", + "name": "ViewName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 32, + "name": "View", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericView" + } + } + ], + "parameters": [ + { + "id": 33, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 31, + "name": "ViewName", + "dereferenced": {} + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 32, + "name": "View" + } + ], + "name": "default" + } + }, + { + "id": 34, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 35, + "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, @@ -63272,7 +63379,7 @@ ], "type": { "type": "reference", - "id": 46, + "id": 49, "typeArguments": [ { "type": "intrinsic", @@ -63285,7 +63392,7 @@ ] }, { - "id": 32, + "id": 36, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -63293,13 +63400,13 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 73, + "line": 102, "character": 2 } ], "signatures": [ { - "id": 33, + "id": 37, "name": "rpc", "kind": 4096, "kindString": "Call signature", @@ -63309,7 +63416,7 @@ }, "typeParameter": [ { - "id": 34, + "id": 38, "name": "FunctionName", "kind": 131072, "kindString": "Type parameter", @@ -63320,7 +63427,7 @@ } }, { - "id": 35, + "id": 39, "name": "Function_", "kind": 131072, "kindString": "Type parameter", @@ -63333,29 +63440,29 @@ ], "parameters": [ { - "id": 36, + "id": 40, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The function name to call." + "shortText": "The function name to call" }, "type": { "type": "reference", - "id": 34, + "id": 38, "name": "FunctionName", "dereferenced": {} } }, { - "id": 37, + "id": 41, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The parameters to pass to the function call." + "shortText": "The arguments to pass to the function call" }, "type": { "type": "indexedAccess", @@ -63365,33 +63472,33 @@ }, "objectType": { "type": "reference", - "id": 35, + "id": 39, "name": "Function_" } }, "defaultValue": "{}" }, { - "id": 38, + "id": 42, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters.\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 39, + "id": 43, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 41, + "id": 45, "name": "count", "kind": 1024, "kindString": "Property", @@ -63399,12 +63506,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 87, + "line": 113, "character": 6 } ], @@ -63427,7 +63534,7 @@ } }, { - "id": 40, + "id": 44, "name": "head", "kind": 1024, "kindString": "Property", @@ -63435,35 +63542,12 @@ "isOptional": true }, "comment": { - "shortText": "When set to true, no data will be returned." + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 85, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 42, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 89, + "line": 112, "character": 6 } ], @@ -63477,7 +63561,7 @@ { "title": "Properties", "kind": 1024, - "children": [41, 40, 42] + "children": [45, 44] } ] } @@ -63487,7 +63571,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "conditional", @@ -63499,7 +63583,7 @@ }, "objectType": { "type": "reference", - "id": 35, + "id": 39, "name": "Function_" } }, @@ -63575,7 +63659,7 @@ }, "objectType": { "type": "reference", - "id": 35, + "id": 39, "name": "Function_" } } @@ -63600,34 +63684,40 @@ { "title": "Methods", "kind": 2048, - "children": [25, 32] + "children": [25, 36] } ], "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 7, + "line": 17, "character": 21 } ], "typeParameter": [ { - "id": 43, + "id": 46, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, + "comment": { + "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" + }, "default": { "type": "intrinsic", "name": "any" } }, { - "id": 44, + "id": 47, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, + "comment": { + "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" + }, "type": { "type": "intersection", "types": [ @@ -63686,7 +63776,7 @@ } }, { - "id": 45, + "id": 48, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -63736,29 +63826,29 @@ ] }, { - "id": 111, + "id": 110, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 112, + "id": 111, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 113, + "id": 112, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 114, - "name": "Table", + "id": 113, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -63780,7 +63870,7 @@ } }, { - "id": 115, + "id": 114, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -63789,24 +63879,24 @@ ], "parameters": [ { - "id": 116, + "id": 115, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], "name": "default", "dereferenced": { - "id": 481, + "id": 486, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -63815,7 +63905,7 @@ }, "children": [ { - "id": 482, + "id": 487, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -63829,14 +63919,14 @@ ], "signatures": [ { - "id": 483, + "id": 488, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 484, + "id": 489, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -63845,18 +63935,18 @@ ], "parameters": [ { - "id": 485, + "id": 490, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -63867,11 +63957,11 @@ ], "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -63881,7 +63971,7 @@ ] }, { - "id": 498, + "id": 503, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -63901,7 +63991,7 @@ } }, { - "id": 490, + "id": 495, "name": "body", "kind": 1024, "kindString": "Property", @@ -63922,7 +64012,7 @@ } }, { - "id": 493, + "id": 498, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -63939,34 +64029,45 @@ "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 499, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 495, + "id": 500, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 501, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 497, + "id": 502, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -64001,7 +64102,7 @@ } }, { - "id": 488, + "id": 493, "name": "headers", "kind": 1024, "kindString": "Property", @@ -64033,7 +64134,7 @@ } }, { - "id": 486, + "id": 491, "name": "method", "kind": 1024, "kindString": "Property", @@ -64074,7 +64175,7 @@ } }, { - "id": 489, + "id": 494, "name": "schema", "kind": 1024, "kindString": "Property", @@ -64095,7 +64196,7 @@ } }, { - "id": 491, + "id": 496, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -64116,7 +64217,7 @@ "defaultValue": "false" }, { - "id": 492, + "id": 497, "name": "signal", "kind": 1024, "kindString": "Property", @@ -64139,7 +64240,7 @@ } }, { - "id": 487, + "id": 492, "name": "url", "kind": 1024, "kindString": "Property", @@ -64161,7 +64262,7 @@ } }, { - "id": 501, + "id": 506, "name": "then", "kind": 2048, "kindString": "Method", @@ -64175,25 +64276,25 @@ ], "signatures": [ { - "id": 502, + "id": 507, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 503, + "id": 508, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -64201,7 +64302,7 @@ } }, { - "id": 504, + "id": 509, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -64214,7 +64315,7 @@ ], "parameters": [ { - "id": 505, + "id": 510, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -64231,32 +64332,32 @@ { "type": "reflection", "declaration": { - "id": 506, + "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 507, + "id": 512, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 508, + "id": 513, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -64269,7 +64370,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -64277,7 +64378,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -64295,7 +64396,7 @@ } }, { - "id": 509, + "id": 514, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -64312,21 +64413,21 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 515, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 511, + "id": 516, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 512, + "id": 517, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -64342,7 +64443,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -64350,7 +64451,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -64376,12 +64477,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -64403,7 +64504,7 @@ } }, { - "id": 499, + "id": 504, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -64417,7 +64518,7 @@ ], "signatures": [ { - "id": 500, + "id": 505, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -64428,11 +64529,11 @@ }, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -64446,17 +64547,17 @@ { "title": "Constructors", "kind": 512, - "children": [482] + "children": [487] }, { "title": "Properties", "kind": 1024, - "children": [498, 490, 493, 488, 486, 489, 491, 492, 487] + "children": [503, 495, 498, 493, 491, 494, 496, 497, 492] }, { "title": "Methods", "kind": 2048, - "children": [501, 499] + "children": [506, 504] } ], "sources": [ @@ -64468,7 +64569,7 @@ ], "typeParameter": [ { - "id": 513, + "id": 518, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -64478,7 +64579,7 @@ "extendedBy": [ { "type": "reference", - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder" } ], @@ -64488,11 +64589,11 @@ "typeArguments": [ { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -64510,16 +64611,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -64527,19 +64628,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 394, + "id": 396, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 393, + "id": 395, "name": "default.constructor" } }, { - "id": 375, + "id": 377, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -64559,12 +64660,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 464, + "id": 469, "name": "default.allowEmpty" } }, { - "id": 367, + "id": 369, "name": "body", "kind": 1024, "kindString": "Property", @@ -64585,12 +64686,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 456, + "id": 461, "name": "default.body" } }, { - "id": 370, + "id": 372, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -64607,34 +64708,45 @@ "type": { "type": "reflection", "declaration": { - "id": 371, + "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 372, + "id": 374, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 373, + "id": 375, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 374, + "id": 376, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -64669,12 +64781,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 459, + "id": 464, "name": "default.fetch" } }, { - "id": 365, + "id": 367, "name": "headers", "kind": 1024, "kindString": "Property", @@ -64706,12 +64818,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 454, + "id": 459, "name": "default.headers" } }, { - "id": 363, + "id": 365, "name": "method", "kind": 1024, "kindString": "Property", @@ -64752,12 +64864,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 452, + "id": 457, "name": "default.method" } }, { - "id": 366, + "id": 368, "name": "schema", "kind": 1024, "kindString": "Property", @@ -64778,12 +64890,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 455, + "id": 460, "name": "default.schema" } }, { - "id": 368, + "id": 370, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -64804,12 +64916,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 457, + "id": 462, "name": "default.shouldThrowOnError" } }, { - "id": 369, + "id": 371, "name": "signal", "kind": 1024, "kindString": "Property", @@ -64832,12 +64944,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 458, + "id": 463, "name": "default.signal" } }, { - "id": 364, + "id": 366, "name": "url", "kind": 1024, "kindString": "Property", @@ -64859,12 +64971,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 453, + "id": 458, "name": "default.url" } }, { - "id": 343, + "id": 342, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -64872,27 +64984,30 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 110, + "line": 124, "character": 2 } ], "signatures": [ { - "id": 344, + "id": 343, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the AbortSignal for the fetch request." + "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { - "id": 345, + "id": 344, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -64903,16 +65018,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -64920,19 +65035,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 433, + "id": 435, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 432, + "id": 434, "name": "default.abortSignal" } }, { - "id": 221, + "id": 204, "name": "containedBy", "kind": 2048, "kindString": "Method", @@ -64940,23 +65055,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 250, + "line": 214, "character": 2 } ], "signatures": [ { - "id": 222, + "id": 205, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose json, array, or range value on the stated `column` is\ncontained by the specified `value`." + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." }, "typeParameter": [ { - "id": 223, + "id": 206, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -64969,29 +65084,29 @@ ], "parameters": [ { - "id": 224, + "id": 207, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", - "id": 223, + "id": 206, "name": "ColumnName", "dereferenced": {} } }, { - "id": 225, + "id": 208, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", @@ -65022,13 +65137,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 223, + "id": 206, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -65038,16 +65153,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -65055,14 +65170,14 @@ } }, { - "id": 226, + "id": 209, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 210, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -65073,7 +65188,7 @@ } }, { - "id": 228, + "id": 211, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -65085,6 +65200,13 @@ "type": "intrinsic", "name": "string" }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, { "type": "reference", "typeArguments": [ @@ -65100,13 +65222,6 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } } ] } @@ -65114,16 +65229,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -65133,7 +65248,7 @@ ] }, { - "id": 213, + "id": 196, "name": "contains", "kind": 2048, "kindString": "Method", @@ -65141,23 +65256,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 223, + "line": 187, "character": 2 } ], "signatures": [ { - "id": 214, + "id": 197, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose json, array, or range value on the stated `column`\ncontains the values specified in `value`." + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." }, "typeParameter": [ { - "id": 215, + "id": 198, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -65170,29 +65285,29 @@ ], "parameters": [ { - "id": 216, + "id": 199, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", - "id": 215, + "id": 198, "name": "ColumnName", "dereferenced": {} } }, { - "id": 217, + "id": 200, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", @@ -65223,13 +65338,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 215, + "id": 198, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -65239,16 +65354,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -65256,14 +65371,14 @@ } }, { - "id": 218, + "id": 201, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 219, + "id": 202, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -65274,7 +65389,7 @@ } }, { - "id": 220, + "id": 203, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -65286,6 +65401,13 @@ "type": "intrinsic", "name": "string" }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, { "type": "reference", "typeArguments": [ @@ -65301,13 +65423,6 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } } ] } @@ -65315,16 +65430,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -65334,7 +65449,7 @@ ] }, { - "id": 350, + "id": 349, "name": "csv", "kind": 2048, "kindString": "Method", @@ -65342,26 +65457,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 138, + "line": 155, "character": 2 } ], "signatures": [ { - "id": 351, + "id": 350, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to CSV." + "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "intrinsic", @@ -65377,19 +65492,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 440, + "id": 442, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 439, + "id": 441, "name": "default.csv" } }, { - "id": 133, + "id": 116, "name": "eq", "kind": 2048, "kindString": "Method", @@ -65397,23 +65512,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 72, + "line": 39, "character": 2 } ], "signatures": [ { - "id": 134, + "id": 117, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` exactly matches the\nspecified `value`." + "shortText": "Match only rows where `column` is equal to `value`.", + "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" }, "typeParameter": [ { - "id": 135, + "id": 118, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -65426,57 +65542,57 @@ ], "parameters": [ { - "id": 136, + "id": 119, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 135, + "id": 118, "name": "ColumnName", "dereferenced": {} } }, { - "id": 137, + "id": 120, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 135, + "id": 118, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -65484,14 +65600,14 @@ } }, { - "id": 138, + "id": 121, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 139, + "id": 122, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -65502,7 +65618,7 @@ } }, { - "id": 140, + "id": 123, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -65515,16 +65631,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -65534,7 +65650,7 @@ ] }, { - "id": 354, + "id": 353, "name": "explain", "kind": 2048, "kindString": "Method", @@ -65542,68 +65658,55 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 189, "character": 2 } ], "signatures": [ { - "id": 355, + "id": 354, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Obtains the EXPLAIN plan for this request." + "shortText": "Return `data` as the EXPLAIN plan for the query." }, "parameters": [ { - "id": 356, - "name": "__namedParameters", + "id": 355, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 357, + "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 358, + "id": 357, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 167, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 361, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 170, + "line": 197, "character": 4 } ], @@ -65614,36 +65717,19 @@ }, { "id": 360, - "name": "settings", + "name": "buffers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 359, - "name": "verbose", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true + "comment": { + "shortText": "If `true`, include information on buffer usage\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 200, "character": 4 } ], @@ -65654,16 +65740,97 @@ }, { "id": 362, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 202, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 359, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 199, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 358, + "name": "verbose", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 198, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 361, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 171, + "line": 201, "character": 4 } ], @@ -65677,7 +65844,7 @@ { "title": "Properties", "kind": 1024, - "children": [358, 361, 360, 359, 362] + "children": [357, 360, 362, 359, 358, 361] } ] } @@ -65686,51 +65853,75 @@ } ], "type": { - "type": "reference", - "typeArguments": [ + "type": "union", + "types": [ { "type": "reference", - "id": 514, "typeArguments": [ { "type": "reference", + "id": 521, "typeArguments": [ { "type": "intrinsic", "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" } ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "name": "PostgrestSingleResponse" } ], - "name": "PostgrestResponse" + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 519, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + ] }, "inheritedFrom": { "type": "reference", - "id": 444, + "id": 446, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 443, + "id": 445, "name": "default.explain" } }, { - "id": 293, + "id": 298, "name": "filter", "kind": 2048, "kindString": "Method", @@ -65738,23 +65929,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 406, + "line": 439, "character": 2 } ], "signatures": [ { - "id": 294, + "id": 299, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose `column` satisfies the filter." + "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { - "id": 295, + "id": 300, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -65767,29 +65959,29 @@ ], "parameters": [ { - "id": 296, + "id": 301, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 295, + "id": 300, "name": "ColumnName", "dereferenced": {} } }, { - "id": 297, + "id": 302, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with." + "shortText": "The operator to filter with, following PostgREST syntax" }, "type": { "type": "union", @@ -65890,13 +66082,13 @@ } }, { - "id": 298, + "id": 303, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "intrinsic", @@ -65906,16 +66098,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -65923,14 +66115,14 @@ } }, { - "id": 299, + "id": 304, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 300, + "id": 305, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -65941,7 +66133,7 @@ } }, { - "id": 301, + "id": 306, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -65952,7 +66144,7 @@ } }, { - "id": 302, + "id": 307, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -65965,16 +66157,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -65984,7 +66176,7 @@ ] }, { - "id": 352, + "id": 351, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -65992,26 +66184,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 146, + "line": 163, "character": 2 } ], "signatures": [ { - "id": 353, + "id": 352, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to GeoJSON." + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", @@ -66039,19 +66231,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 442, + "id": 444, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 441, + "id": 443, "name": "default.geojson" } }, { - "id": 149, + "id": 132, "name": "gt", "kind": 2048, "kindString": "Method", @@ -66059,23 +66251,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 100, + "line": 65, "character": 2 } ], "signatures": [ { - "id": 150, + "id": 133, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is greater than the\nspecified `value`." + "shortText": "Match only rows where `column` is greater than `value`." }, "typeParameter": [ { - "id": 151, + "id": 134, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -66088,57 +66280,57 @@ ], "parameters": [ { - "id": 152, + "id": 135, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 151, + "id": 134, "name": "ColumnName", "dereferenced": {} } }, { - "id": 153, + "id": 136, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 151, + "id": 134, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66146,14 +66338,14 @@ } }, { - "id": 154, + "id": 137, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 155, + "id": 138, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -66164,7 +66356,7 @@ } }, { - "id": 156, + "id": 139, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -66177,16 +66369,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66196,7 +66388,7 @@ ] }, { - "id": 157, + "id": 140, "name": "gte", "kind": 2048, "kindString": "Method", @@ -66204,23 +66396,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 114, + "line": 78, "character": 2 } ], "signatures": [ { - "id": 158, + "id": 141, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is greater than or\nequal to the specified `value`." + "shortText": "Match only rows where `column` is greater than or equal to `value`." }, "typeParameter": [ { - "id": 159, + "id": 142, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -66233,57 +66425,57 @@ ], "parameters": [ { - "id": 160, + "id": 143, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 159, + "id": 142, "name": "ColumnName", "dereferenced": {} } }, { - "id": 161, + "id": 144, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 159, + "id": 142, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66291,14 +66483,14 @@ } }, { - "id": 162, + "id": 145, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 163, + "id": 146, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -66309,7 +66501,7 @@ } }, { - "id": 164, + "id": 147, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -66322,16 +66514,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66341,7 +66533,7 @@ ] }, { - "id": 189, + "id": 172, "name": "ilike", "kind": 2048, "kindString": "Method", @@ -66349,23 +66541,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 170, + "line": 130, "character": 2 } ], "signatures": [ { - "id": 190, + "id": 173, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case insensitive)." + "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "typeParameter": [ { - "id": 191, + "id": 174, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -66378,29 +66570,29 @@ ], "parameters": [ { - "id": 192, + "id": 175, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 191, + "id": 174, "name": "ColumnName", "dereferenced": {} } }, { - "id": 193, + "id": 176, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to filter with.\n" + "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", @@ -66410,16 +66602,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66427,14 +66619,14 @@ } }, { - "id": 194, + "id": 177, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 178, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -66445,7 +66637,7 @@ } }, { - "id": 196, + "id": 179, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -66458,16 +66650,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66477,7 +66669,7 @@ ] }, { - "id": 205, + "id": 188, "name": "in", "kind": 2048, "kindString": "Method", @@ -66485,23 +66677,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 201, + "line": 165, "character": 2 } ], "signatures": [ { - "id": 206, + "id": 189, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is found on the\nspecified `values`." + "shortText": "Match only rows where `column` is included in the `values` array." }, "typeParameter": [ { - "id": 207, + "id": 190, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -66514,29 +66706,29 @@ ], "parameters": [ { - "id": 208, + "id": 191, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 207, + "id": 190, "name": "ColumnName", "dereferenced": {} } }, { - "id": 209, + "id": 192, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to filter with.\n" + "shortText": "The values array to filter with\n" }, "type": { "type": "array", @@ -66544,13 +66736,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 207, + "id": 190, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -66558,16 +66750,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66575,14 +66767,14 @@ } }, { - "id": 210, + "id": 193, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 211, + "id": 194, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -66593,7 +66785,7 @@ } }, { - "id": 212, + "id": 195, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -66609,16 +66801,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66628,7 +66820,7 @@ ] }, { - "id": 197, + "id": 180, "name": "is", "kind": 2048, "kindString": "Method", @@ -66636,23 +66828,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 184, + "line": 149, "character": 2 } ], "signatures": [ { - "id": 198, + "id": 181, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "A check for exact equality (null, true, false), finds all rows whose\nvalue on the stated `column` exactly match the specified `value`." + "shortText": "Match only rows where `column` IS `value`.", + "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" }, "typeParameter": [ { - "id": 199, + "id": 182, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -66665,29 +66858,29 @@ ], "parameters": [ { - "id": 200, + "id": 183, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName", "dereferenced": {} } }, { - "id": 201, + "id": 184, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "intersection", @@ -66699,13 +66892,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } }, { @@ -66721,13 +66914,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } }, { @@ -66743,13 +66936,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } }, { @@ -66764,16 +66957,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66781,14 +66974,14 @@ } }, { - "id": 202, + "id": 185, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 203, + "id": 186, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -66799,7 +66992,7 @@ } }, { - "id": 204, + "id": 187, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -66821,16 +67014,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66840,7 +67033,7 @@ ] }, { - "id": 181, + "id": 164, "name": "like", "kind": 2048, "kindString": "Method", @@ -66848,23 +67041,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 156, + "line": 117, "character": 2 } ], "signatures": [ { - "id": 182, + "id": 165, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case sensitive)." + "shortText": "Match only rows where `column` matches `pattern` case-sensitively." }, "typeParameter": [ { - "id": 183, + "id": 166, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -66877,29 +67070,29 @@ ], "parameters": [ { - "id": 184, + "id": 167, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 183, + "id": 166, "name": "ColumnName", "dereferenced": {} } }, { - "id": 185, + "id": 168, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to filter with.\n" + "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", @@ -66909,16 +67102,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66926,14 +67119,14 @@ } }, { - "id": 186, + "id": 169, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 187, + "id": 170, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -66944,7 +67137,7 @@ } }, { - "id": 188, + "id": 171, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -66957,16 +67150,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -66976,7 +67169,7 @@ ] }, { - "id": 330, + "id": 329, "name": "limit", "kind": 2048, "kindString": "Method", @@ -66984,29 +67177,29 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 2 } ], "signatures": [ { - "id": 331, + "id": 330, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result with the specified `count`." + "shortText": "Limit the query result by `count`." }, "parameters": [ { - "id": 332, + "id": 331, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum no. of rows to limit to." + "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", @@ -67014,36 +67207,39 @@ } }, { - "id": 333, - "name": "foreignTable", + "id": 332, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 334, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 335, + "id": 334, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 43 } ], @@ -67057,7 +67253,7 @@ { "title": "Properties", "kind": 1024, - "children": [335] + "children": [334] } ] } @@ -67067,16 +67263,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67084,19 +67280,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 420, + "id": 422, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 419, + "id": 421, "name": "default.limit" } }, { - "id": 165, + "id": 148, "name": "lt", "kind": 2048, "kindString": "Method", @@ -67104,23 +67300,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 128, + "line": 91, "character": 2 } ], "signatures": [ { - "id": 166, + "id": 149, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is less than the\nspecified `value`." + "shortText": "Match only rows where `column` is less than `value`." }, "typeParameter": [ { - "id": 167, + "id": 150, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -67133,57 +67329,57 @@ ], "parameters": [ { - "id": 168, + "id": 151, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 167, + "id": 150, "name": "ColumnName", "dereferenced": {} } }, { - "id": 169, + "id": 152, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 167, + "id": 150, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67191,14 +67387,14 @@ } }, { - "id": 170, + "id": 153, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 171, + "id": 154, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -67209,7 +67405,7 @@ } }, { - "id": 172, + "id": 155, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -67222,16 +67418,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67241,7 +67437,7 @@ ] }, { - "id": 173, + "id": 156, "name": "lte", "kind": 2048, "kindString": "Method", @@ -67249,23 +67445,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 142, + "line": 104, "character": 2 } ], "signatures": [ { - "id": 174, + "id": 157, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is less than or equal\nto the specified `value`." + "shortText": "Match only rows where `column` is less than or equal to `value`." }, "typeParameter": [ { - "id": 175, + "id": 158, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -67278,57 +67474,57 @@ ], "parameters": [ { - "id": 176, + "id": 159, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 175, + "id": 158, "name": "ColumnName", "dereferenced": {} } }, { - "id": 177, + "id": 160, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 175, + "id": 158, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67336,14 +67532,14 @@ } }, { - "id": 178, + "id": 161, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 179, + "id": 162, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -67354,7 +67550,7 @@ } }, { - "id": 180, + "id": 163, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -67367,16 +67563,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67386,7 +67582,7 @@ ] }, { - "id": 303, + "id": 276, "name": "match", "kind": 2048, "kindString": "Method", @@ -67394,23 +67590,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 423, + "line": 374, "character": 2 } ], "signatures": [ { - "id": 304, + "id": 277, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose columns match the specified `query` object." + "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." }, "typeParameter": [ { - "id": 305, + "id": 278, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -67423,33 +67619,33 @@ ], "parameters": [ { - "id": 306, + "id": 279, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\n to their filter values.\n" + "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 305, + "id": 278, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 305, + "id": 278, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } ], @@ -67461,16 +67657,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67478,14 +67674,14 @@ } }, { - "id": 307, + "id": 280, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 308, + "id": 281, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -67510,16 +67706,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67529,7 +67725,7 @@ ] }, { - "id": 348, + "id": 347, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -67537,30 +67733,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 129, + "line": 146, "character": 2 } ], "signatures": [ { - "id": 349, + "id": 348, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 518, + "id": 523, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67573,19 +67770,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 438, + "id": 440, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 437, + "id": 439, "name": "default.maybeSingle" } }, { - "id": 141, + "id": 124, "name": "neq", "kind": 2048, "kindString": "Method", @@ -67593,23 +67790,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 86, + "line": 52, "character": 2 } ], "signatures": [ { - "id": 142, + "id": 125, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` doesn't match the\nspecified `value`." + "shortText": "Match only rows where `column` is not equal to `value`." }, "typeParameter": [ { - "id": 143, + "id": 126, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -67622,57 +67819,57 @@ ], "parameters": [ { - "id": 144, + "id": 127, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 143, + "id": 126, "name": "ColumnName", "dereferenced": {} } }, { - "id": 145, + "id": 128, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 143, + "id": 126, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67680,14 +67877,14 @@ } }, { - "id": 146, + "id": 129, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 130, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -67698,7 +67895,7 @@ } }, { - "id": 148, + "id": 131, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -67711,16 +67908,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67730,7 +67927,7 @@ ] }, { - "id": 117, + "id": 282, "name": "not", "kind": 2048, "kindString": "Method", @@ -67738,23 +67935,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 42, + "line": 396, "character": 2 } ], "signatures": [ { - "id": 118, + "id": 283, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows which doesn't satisfy the filter." + "shortText": "Match only rows which doesn't satisfy the filter.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { - "id": 119, + "id": 284, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -67767,29 +67965,29 @@ ], "parameters": [ { - "id": 120, + "id": 285, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 119, + "id": 284, "name": "ColumnName", "dereferenced": {} } }, { - "id": 121, + "id": 286, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with." + "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" }, "type": { "type": "reference", @@ -67797,41 +67995,41 @@ } }, { - "id": 122, + "id": 287, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 119, + "id": 284, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67839,14 +68037,14 @@ } }, { - "id": 123, + "id": 288, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 289, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -67857,7 +68055,7 @@ } }, { - "id": 125, + "id": 290, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -67868,7 +68066,7 @@ } }, { - "id": 126, + "id": 291, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -67881,16 +68079,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -67900,7 +68098,7 @@ ] }, { - "id": 127, + "id": 292, "name": "or", "kind": 2048, "kindString": "Method", @@ -67908,29 +68106,30 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 59, + "line": 420, "character": 2 } ], "signatures": [ { - "id": 128, + "id": 293, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows satisfying at least one of the filters." + "shortText": "Match only rows which satisfy at least one of the filters.", + "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" }, "parameters": [ { - "id": 129, + "id": 294, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The filters to use, separated by commas." + "shortText": "The filters to use, following PostgREST syntax" }, "type": { "type": "intrinsic", @@ -67938,26 +68137,26 @@ } }, { - "id": 130, + "id": 295, "name": "foreignTable", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (if `column` is a foreign column).\n" + "shortText": "Set this to filter on foreign tables instead of the\ncurrent table\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 131, + "id": 296, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 132, + "id": 297, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -67967,7 +68166,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 59, + "line": 420, "character": 42 } ], @@ -67981,7 +68180,7 @@ { "title": "Properties", "kind": 1024, - "children": [132] + "children": [297] } ] } @@ -67991,16 +68190,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68010,7 +68209,7 @@ ] }, { - "id": 314, + "id": 313, "name": "order", "kind": 2048, "kindString": "Method", @@ -68018,23 +68217,24 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, + "line": 59, "character": 2 } ], "signatures": [ { - "id": 315, + "id": 314, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Orders the result with the specified `column`." + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" }, "typeParameter": [ { - "id": 316, + "id": 315, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -68047,50 +68247,56 @@ ], "parameters": [ { - "id": 317, + "id": 316, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order on." + "shortText": "The column to order by" }, "type": { "type": "reference", - "id": 316, + "id": 315, "name": "ColumnName", "dereferenced": {} } }, { - "id": 318, + "id": 317, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, + "comment": { + "shortText": "Named parameters" + }, "type": { "type": "reflection", "declaration": { - "id": 319, + "id": 318, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 320, + "id": 319, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 16 } ], @@ -68100,17 +68306,20 @@ } }, { - "id": 322, + "id": 321, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 59 } ], @@ -68120,17 +68329,20 @@ } }, { - "id": 321, + "id": 320, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 37 } ], @@ -68144,7 +68356,7 @@ { "title": "Properties", "kind": 1024, - "children": [320, 322, 321] + "children": [319, 321, 320] } ] } @@ -68153,16 +68365,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68170,19 +68382,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 404, + "id": 406, "name": "default.order" } }, { - "id": 323, + "id": 322, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 324, + "id": 323, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -68193,7 +68405,7 @@ } }, { - "id": 325, + "id": 324, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -68203,14 +68415,14 @@ "type": { "type": "reflection", "declaration": { - "id": 326, + "id": 325, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 327, + "id": 326, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -68220,7 +68432,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 16 } ], @@ -68230,7 +68442,7 @@ } }, { - "id": 329, + "id": 328, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -68238,7 +68450,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 59 } ], @@ -68248,7 +68460,7 @@ } }, { - "id": 328, + "id": 327, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -68258,7 +68470,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 37 } ], @@ -68272,7 +68484,7 @@ { "title": "Properties", "kind": 1024, - "children": [327, 329, 328] + "children": [326, 328, 327] } ] } @@ -68281,16 +68493,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68298,19 +68510,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 412, + "id": 414, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 403, + "id": 405, "name": "default.order" } }, { - "id": 269, + "id": 252, "name": "overlaps", "kind": 2048, "kindString": "Method", @@ -68318,23 +68530,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 346, + "line": 313, "character": 2 } ], "signatures": [ { - "id": 270, + "id": 253, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose array or range value on the stated `column` overlaps\n(has a value in common) with the specified `value`." + "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." }, "typeParameter": [ { - "id": 271, + "id": 254, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -68347,29 +68559,29 @@ ], "parameters": [ { - "id": 272, + "id": 255, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The array or range column to filter on" }, "type": { "type": "reference", - "id": 271, + "id": 254, "name": "ColumnName", "dereferenced": {} } }, { - "id": 273, + "id": 256, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The array or range value to filter with\n" }, "type": { "type": "union", @@ -68384,13 +68596,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 271, + "id": 254, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -68400,16 +68612,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68417,14 +68629,14 @@ } }, { - "id": 274, + "id": 257, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 275, + "id": 258, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -68435,7 +68647,7 @@ } }, { - "id": 276, + "id": 259, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -68460,16 +68672,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68479,7 +68691,7 @@ ] }, { - "id": 336, + "id": 335, "name": "range", "kind": 2048, "kindString": "Method", @@ -68487,29 +68699,43 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 2 } ], "signatures": [ { - "id": 337, + "id": 336, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result to rows within the specified range, inclusive." + "shortText": "Limit the query result by `from` and `to` inclusively." }, "parameters": [ { - "id": 338, + "id": 337, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result, inclusive." + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 338, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", @@ -68518,49 +68744,38 @@ }, { "id": 339, - "name": "to", + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result, inclusive." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 340, - "name": "foreignTable", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 341, + "id": 340, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 341, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 54 } ], @@ -68574,7 +68789,7 @@ { "title": "Properties", "kind": 1024, - "children": [342] + "children": [341] } ] } @@ -68584,16 +68799,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68601,19 +68816,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 426, + "id": 428, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 425, + "id": 427, "name": "default.range" } }, { - "id": 261, + "id": 244, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", @@ -68621,23 +68836,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 332, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 262, + "id": 245, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` is adjacent to\nthe specified `range`." + "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." }, "typeParameter": [ { - "id": 263, + "id": 246, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -68650,29 +68865,29 @@ ], "parameters": [ { - "id": 264, + "id": 247, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 263, + "id": 246, "name": "ColumnName", "dereferenced": {} } }, { - "id": 265, + "id": 248, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -68682,16 +68897,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68699,14 +68914,14 @@ } }, { - "id": 266, + "id": 249, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 267, + "id": 250, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -68717,7 +68932,7 @@ } }, { - "id": 268, + "id": 251, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -68730,16 +68945,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68749,7 +68964,7 @@ ] }, { - "id": 237, + "id": 212, "name": "rangeGt", "kind": 2048, "kindString": "Method", @@ -68757,23 +68972,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 290, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 238, + "id": 213, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` is strictly to\nthe right of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." }, "typeParameter": [ { - "id": 239, + "id": 214, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -68786,29 +69001,29 @@ ], "parameters": [ { - "id": 240, + "id": 215, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 239, + "id": 214, "name": "ColumnName", "dereferenced": {} } }, { - "id": 241, + "id": 216, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -68818,16 +69033,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68835,14 +69050,14 @@ } }, { - "id": 242, + "id": 217, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 243, + "id": 218, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -68853,7 +69068,7 @@ } }, { - "id": 244, + "id": 219, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -68866,16 +69081,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68885,7 +69100,7 @@ ] }, { - "id": 245, + "id": 220, "name": "rangeGte", "kind": 2048, "kindString": "Method", @@ -68893,23 +69108,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 304, + "line": 255, "character": 2 } ], "signatures": [ { - "id": 246, + "id": 221, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the left of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." }, "typeParameter": [ { - "id": 247, + "id": 222, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -68922,29 +69137,29 @@ ], "parameters": [ { - "id": 248, + "id": 223, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 247, + "id": 222, "name": "ColumnName", "dereferenced": {} } }, { - "id": 249, + "id": 224, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -68954,16 +69169,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -68971,14 +69186,14 @@ } }, { - "id": 250, + "id": 225, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 251, + "id": 226, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -68989,7 +69204,7 @@ } }, { - "id": 252, + "id": 227, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -69002,16 +69217,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69021,7 +69236,7 @@ ] }, { - "id": 229, + "id": 228, "name": "rangeLt", "kind": 2048, "kindString": "Method", @@ -69029,23 +69244,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 276, + "line": 269, "character": 2 } ], "signatures": [ { - "id": 230, + "id": 229, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` is strictly to the\nleft of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." }, "typeParameter": [ { - "id": 231, + "id": 230, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -69058,29 +69273,29 @@ ], "parameters": [ { - "id": 232, + "id": 231, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 231, + "id": 230, "name": "ColumnName", "dereferenced": {} } }, { - "id": 233, + "id": 232, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -69090,16 +69305,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69107,14 +69322,14 @@ } }, { - "id": 234, + "id": 233, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 235, + "id": 234, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -69125,7 +69340,7 @@ } }, { - "id": 236, + "id": 235, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -69138,16 +69353,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69157,7 +69372,7 @@ ] }, { - "id": 253, + "id": 236, "name": "rangeLte", "kind": 2048, "kindString": "Method", @@ -69165,23 +69380,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 318, + "line": 284, "character": 2 } ], "signatures": [ { - "id": 254, + "id": 237, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the right of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." }, "typeParameter": [ { - "id": 255, + "id": 238, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -69194,29 +69409,29 @@ ], "parameters": [ { - "id": 256, + "id": 239, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 255, + "id": 238, "name": "ColumnName", "dereferenced": {} } }, { - "id": 257, + "id": 240, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -69226,16 +69441,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69243,14 +69458,14 @@ } }, { - "id": 258, + "id": 241, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 259, + "id": 242, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -69261,7 +69476,7 @@ } }, { - "id": 260, + "id": 243, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -69274,16 +69489,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69293,7 +69508,61 @@ ] }, { - "id": 309, + "id": 363, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 229, + "character": 2 + } + ], + "signatures": [ + { + "id": 364, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 110, + "typeArguments": [ + { + "type": "reference", + "id": 113, + "name": "Row" + }, + { + "type": "reference", + "id": 114, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 456, + "name": "default.rollback" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 455, + "name": "default.rollback" + } + }, + { + "id": 308, "name": "select", "kind": 2048, "kindString": "Method", @@ -69307,17 +69576,18 @@ ], "signatures": [ { - "id": 310, + "id": 309, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs vertical filtering with SELECT." + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { - "id": 311, + "id": 310, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -69332,7 +69602,7 @@ } }, { - "id": 312, + "id": 311, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -69342,14 +69612,14 @@ "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" }, "extendsType": { @@ -69362,7 +69632,7 @@ }, "falseType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" } } @@ -69373,7 +69643,7 @@ ], "parameters": [ { - "id": 313, + "id": 312, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -69381,11 +69651,11 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas.\n" + "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", - "id": 311, + "id": 310, "name": "Query", "dereferenced": {} } @@ -69393,16 +69663,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 312, + "id": 311, "name": "NewResult" } ], @@ -69410,19 +69680,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 399, + "id": 401, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 398, + "id": 400, "name": "default.select" } }, { - "id": 346, + "id": 345, "name": "single", "kind": 2048, "kindString": "Method", @@ -69430,30 +69700,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 119, + "line": 135, "character": 2 } ], "signatures": [ { - "id": 347, + "id": 346, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69466,19 +69737,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 436, + "id": 438, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 435, + "id": 437, "name": "default.single" } }, { - "id": 277, + "id": 260, "name": "textSearch", "kind": 2048, "kindString": "Method", @@ -69486,23 +69757,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 371, + "line": 339, "character": 2 } ], "signatures": [ { - "id": 278, + "id": 261, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose text or tsvector value on the stated `column` matches\nthe tsquery in `query`." + "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." }, "typeParameter": [ { - "id": 279, + "id": 262, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -69515,29 +69786,29 @@ ], "parameters": [ { - "id": 280, + "id": 263, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The text or tsvector column to filter on" }, "type": { "type": "reference", - "id": 279, + "id": 262, "name": "ColumnName", "dereferenced": {} } }, { - "id": 281, + "id": 264, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The Postgres tsquery string to filter with." + "shortText": "The query text to match with" }, "type": { "type": "intrinsic", @@ -69545,34 +69816,40 @@ } }, { - "id": 282, + "id": 265, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, + "comment": { + "shortText": "Named parameters" + }, "type": { "type": "reflection", "declaration": { - "id": 283, + "id": 266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 284, + "id": 267, "name": "config", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "The text search configuration to use" + }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 374, + "line": 342, "character": 16 } ], @@ -69582,17 +69859,20 @@ } }, { - "id": 285, + "id": 268, "name": "type", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Change how the `query` text is interpreted\n" + }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 374, + "line": 342, "character": 33 } ], @@ -69619,7 +69899,7 @@ { "title": "Properties", "kind": 1024, - "children": [284, 285] + "children": [267, 268] } ] } @@ -69628,16 +69908,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69645,14 +69925,14 @@ } }, { - "id": 286, + "id": 269, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 287, + "id": 270, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -69663,7 +69943,7 @@ } }, { - "id": 288, + "id": 271, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -69674,7 +69954,7 @@ } }, { - "id": 289, + "id": 272, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -69684,14 +69964,14 @@ "type": { "type": "reflection", "declaration": { - "id": 290, + "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 291, + "id": 274, "name": "config", "kind": 1024, "kindString": "Property", @@ -69701,7 +69981,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 379, + "line": 347, "character": 16 } ], @@ -69711,7 +69991,7 @@ } }, { - "id": 292, + "id": 275, "name": "type", "kind": 1024, "kindString": "Property", @@ -69721,7 +70001,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 379, + "line": 347, "character": 33 } ], @@ -69748,7 +70028,7 @@ { "title": "Properties", "kind": 1024, - "children": [291, 292] + "children": [274, 275] } ] } @@ -69757,16 +70037,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69776,7 +70056,7 @@ ] }, { - "id": 378, + "id": 380, "name": "then", "kind": 2048, "kindString": "Method", @@ -69790,25 +70070,25 @@ ], "signatures": [ { - "id": 379, + "id": 381, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 380, + "id": 382, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69816,7 +70096,7 @@ } }, { - "id": 381, + "id": 383, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -69829,7 +70109,7 @@ ], "parameters": [ { - "id": 382, + "id": 384, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -69846,32 +70126,32 @@ { "type": "reflection", "declaration": { - "id": 383, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 384, + "id": 386, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 385, + "id": 387, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -69884,7 +70164,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -69892,7 +70172,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -69910,7 +70190,7 @@ } }, { - "id": 386, + "id": 388, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -69927,21 +70207,21 @@ { "type": "reflection", "declaration": { - "id": 387, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 388, + "id": 390, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 389, + "id": 391, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -69957,7 +70237,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -69965,7 +70245,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -69991,12 +70271,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -70008,19 +70288,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 468, + "id": 473, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 467, + "id": 472, "name": "default.then" } }, { - "id": 376, + "id": 378, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -70034,7 +70314,7 @@ ], "signatures": [ { - "id": 377, + "id": 379, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -70045,16 +70325,16 @@ }, "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -70062,14 +70342,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 466, + "id": 471, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 465, + "id": 470, "name": "default.throwOnError" } } @@ -70078,34 +70358,34 @@ { "title": "Constructors", "kind": 512, - "children": [112] + "children": [111] }, { "title": "Properties", "kind": 1024, - "children": [375, 367, 370, 365, 363, 366, 368, 369, 364] + "children": [377, 369, 372, 367, 365, 368, 370, 371, 366] }, { "title": "Methods", "kind": 2048, "children": [ - 343, 221, 213, 350, 133, 354, 293, 352, 149, 157, 189, 205, 197, 181, 330, 165, 173, - 303, 348, 141, 117, 127, 314, 269, 336, 261, 237, 245, 229, 253, 309, 346, 277, 378, - 376 + 342, 204, 196, 349, 116, 353, 298, 351, 132, 140, 172, 188, 180, 164, 329, 148, 156, + 276, 347, 124, 282, 292, 313, 252, 335, 244, 212, 220, 228, 236, 363, 308, 345, 260, + 380, 378 ] } ], "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 31, + "line": 27, "character": 21 } ], "typeParameter": [ { - "id": 390, - "name": "Table", + "id": 392, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -70127,7 +70407,7 @@ } }, { - "id": 391, + "id": 393, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -70137,16 +70417,16 @@ "extendedTypes": [ { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -70155,14 +70435,14 @@ ] }, { - "id": 46, + "id": 49, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 47, + "id": 50, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -70176,27 +70456,36 @@ ], "signatures": [ { - "id": 48, + "id": 51, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 49, - "name": "Table", + "id": 52, + "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "reference", - "name": "GenericTable" + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] } } ], "parameters": [ { - "id": 50, + "id": 53, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -70209,7 +70498,7 @@ } }, { - "id": 51, + "id": 54, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -70217,14 +70506,14 @@ "type": { "type": "reflection", "declaration": { - "id": 52, + "id": 55, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 55, + "id": 58, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -70241,34 +70530,45 @@ "type": { "type": "reflection", "declaration": { - "id": 56, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 57, + "id": 60, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 58, + "id": 61, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 59, + "id": 62, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -70303,7 +70603,7 @@ } }, { - "id": 53, + "id": 56, "name": "headers", "kind": 1024, "kindString": "Property", @@ -70335,7 +70635,7 @@ } }, { - "id": 54, + "id": 57, "name": "schema", "kind": 1024, "kindString": "Property", @@ -70359,7 +70659,7 @@ { "title": "Properties", "kind": 1024, - "children": [55, 53, 54] + "children": [58, 56, 57] } ] } @@ -70368,12 +70668,12 @@ ], "type": { "type": "reference", - "id": 46, + "id": 49, "typeArguments": [ { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } ], "name": "default" @@ -70382,7 +70682,7 @@ ] }, { - "id": 64, + "id": 67, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -70399,34 +70699,45 @@ "type": { "type": "reflection", "declaration": { - "id": 65, + "id": 68, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 66, + "id": 69, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 67, + "id": 70, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 68, + "id": 71, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -70461,7 +70772,7 @@ } }, { - "id": 61, + "id": 64, "name": "headers", "kind": 1024, "kindString": "Property", @@ -70491,7 +70802,7 @@ } }, { - "id": 62, + "id": 65, "name": "schema", "kind": 1024, "kindString": "Property", @@ -70511,7 +70822,7 @@ } }, { - "id": 63, + "id": 66, "name": "signal", "kind": 1024, "kindString": "Property", @@ -70533,7 +70844,7 @@ } }, { - "id": 60, + "id": 63, "name": "url", "kind": 1024, "kindString": "Property", @@ -70561,7 +70872,7 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 228, + "line": 296, "character": 2 } ], @@ -70573,15 +70884,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs a DELETE on the table." + "shortText": "Perform a DELETE on the table or view.", + "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "parameters": [ { "id": 106, - "name": "__namedParameters", + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { @@ -70600,12 +70916,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 233, + "line": 299, "character": 4 } ], @@ -70626,36 +70942,13 @@ } ] } - }, - { - "id": 109, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 235, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [108, 109] + "children": [108] } ] } @@ -70665,7 +70958,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -70675,8 +70968,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -70690,7 +70983,7 @@ ] }, { - "id": 78, + "id": 81, "name": "insert", "kind": 2048, "kindString": "Method", @@ -70698,23 +70991,24 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 86, + "line": 117, "character": 2 } ], "signatures": [ { - "id": 79, + "id": 82, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs an INSERT into the table." + "shortText": "Perform an INSERT into the table or view.", + "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { - "id": 80, + "id": 83, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -70739,27 +71033,27 @@ ], "parameters": [ { - "id": 81, + "id": 84, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert.\n" + "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" }, "type": { "type": "union", "types": [ { "type": "reference", - "id": 80, + "id": 83, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 80, + "id": 83, "name": "Row" } } @@ -70767,22 +71061,26 @@ } }, { - "id": 82, - "name": "__namedParameters", + "id": 85, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 83, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 84, + "id": 87, "name": "count", "kind": 1024, "kindString": "Property", @@ -70790,12 +71088,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 93, + "line": 122, "character": 6 } ], @@ -70816,36 +71114,13 @@ } ] } - }, - { - "id": 85, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 95, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [84, 85] + "children": [87] } ] } @@ -70855,7 +71130,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -70865,8 +71140,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -70880,7 +71155,7 @@ ] }, { - "id": 69, + "id": 72, "name": "select", "kind": 2048, "kindString": "Method", @@ -70888,23 +71163,23 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 36, + "line": 52, "character": 2 } ], "signatures": [ { - "id": 70, + "id": 73, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs vertical filtering with SELECT." + "shortText": "Perform a SELECT query on the table or view." }, "typeParameter": [ { - "id": 71, + "id": 74, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -70919,7 +71194,7 @@ } }, { - "id": 72, + "id": 75, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -70935,15 +71210,15 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { "type": "conditional", "checkType": { "type": "reference", - "id": 71, + "id": 74, "name": "Query" }, "extendsType": { @@ -70956,7 +71231,7 @@ }, "falseType": { "type": "reference", - "id": 71, + "id": 74, "name": "Query" } } @@ -70967,7 +71242,7 @@ ], "parameters": [ { - "id": 73, + "id": 76, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -70975,32 +71250,36 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas.\n" + "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", - "id": 71, + "id": 74, "name": "Query", "dereferenced": {} } }, { - "id": 74, - "name": "__namedParameters", + "id": 77, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 75, + "id": 78, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, + "id": 80, "name": "count", "kind": 1024, "kindString": "Property", @@ -71008,12 +71287,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 48, + "line": 62, "character": 6 } ], @@ -71036,7 +71315,7 @@ } }, { - "id": 76, + "id": 79, "name": "head", "kind": 1024, "kindString": "Property", @@ -71044,12 +71323,12 @@ "isOptional": true }, "comment": { - "shortText": "When set to true, select will void data." + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 46, + "line": 61, "character": 6 } ], @@ -71063,7 +71342,7 @@ { "title": "Properties", "kind": 1024, - "children": [77, 76] + "children": [80, 79] } ] } @@ -71073,7 +71352,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -71083,13 +71362,13 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { "type": "reference", - "id": 72, + "id": 75, "name": "Result" } ], @@ -71099,7 +71378,7 @@ ] }, { - "id": 96, + "id": 97, "name": "update", "kind": 2048, "kindString": "Method", @@ -71107,23 +71386,24 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 188, + "line": 247, "character": 2 } ], "signatures": [ { - "id": 97, + "id": 98, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs an UPDATE on the table." + "shortText": "Perform an UPDATE on the table or view.", + "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "typeParameter": [ { - "id": 98, + "id": 99, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -71148,38 +71428,42 @@ ], "parameters": [ { - "id": 99, + "id": 100, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to update.\n" + "shortText": "The values to update with\n" }, "type": { "type": "reference", - "id": 98, + "id": 99, "name": "Row", "dereferenced": {} } }, { - "id": 100, - "name": "__namedParameters", + "id": 101, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 102, + "id": 103, "name": "count", "kind": 1024, "kindString": "Property", @@ -71187,12 +71471,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 195, + "line": 252, "character": 6 } ], @@ -71213,36 +71497,13 @@ } ] } - }, - { - "id": 103, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 197, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [102, 103] + "children": [103] } ] } @@ -71252,7 +71513,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -71262,8 +71523,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -71277,7 +71538,7 @@ ] }, { - "id": 86, + "id": 88, "name": "upsert", "kind": 2048, "kindString": "Method", @@ -71285,23 +71546,24 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 137, + "line": 189, "character": 2 } ], "signatures": [ { - "id": 87, + "id": 89, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs an UPSERT into the table." + "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", + "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { - "id": 88, + "id": 90, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -71326,27 +71588,27 @@ ], "parameters": [ { - "id": 89, + "id": 91, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert.\n" + "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { "type": "union", "types": [ { "type": "reference", - "id": 88, + "id": 90, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 88, + "id": 90, "name": "Row" } } @@ -71354,22 +71616,26 @@ } }, { - "id": 90, - "name": "__namedParameters", + "id": 92, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 91, + "id": 93, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 93, + "id": 96, "name": "count", "kind": 1024, "kindString": "Property", @@ -71377,12 +71643,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 148, + "line": 198, "character": 6 } ], @@ -71405,7 +71671,7 @@ } }, { - "id": 94, + "id": 95, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", @@ -71413,12 +71679,12 @@ "isOptional": true }, "comment": { - "shortText": "Specifies if duplicate rows should be ignored and not inserted." + "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 150, + "line": 197, "character": 6 } ], @@ -71428,7 +71694,7 @@ } }, { - "id": 92, + "id": 94, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -71436,12 +71702,12 @@ "isOptional": true }, "comment": { - "shortText": "By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint." + "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 146, + "line": 196, "character": 6 } ], @@ -71449,36 +71715,13 @@ "type": "intrinsic", "name": "string" } - }, - { - "id": 95, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 152, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [93, 94, 92, 95] + "children": [96, 95, 94] } ] } @@ -71488,7 +71731,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -71498,8 +71741,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -71517,17 +71760,17 @@ { "title": "Constructors", "kind": 512, - "children": [47] + "children": [50] }, { "title": "Properties", "kind": 1024, - "children": [64, 61, 62, 63, 60] + "children": [67, 64, 65, 66, 63] }, { "title": "Methods", "kind": 2048, - "children": [104, 78, 69, 96, 86] + "children": [104, 81, 72, 97, 88] } ], "sources": [ @@ -71539,45 +71782,51 @@ ], "typeParameter": [ { - "id": 110, - "name": "Table", + "id": 109, + "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "reference", - "name": "GenericTable" + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] } } ] }, { - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, - "comment": { - "shortText": "Post-filters (transforms)" - }, "children": [ { - "id": 393, + "id": 395, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 394, + "id": 396, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 395, - "name": "Table", + "id": 397, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -71599,7 +71848,7 @@ } }, { - "id": 396, + "id": 398, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -71608,24 +71857,24 @@ ], "parameters": [ { - "id": 397, + "id": 399, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], "name": "default", "dereferenced": { - "id": 481, + "id": 486, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -71634,7 +71883,7 @@ }, "children": [ { - "id": 482, + "id": 487, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -71648,14 +71897,14 @@ ], "signatures": [ { - "id": 483, + "id": 488, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 484, + "id": 489, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -71664,18 +71913,18 @@ ], "parameters": [ { - "id": 485, + "id": 490, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -71686,11 +71935,11 @@ ], "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -71700,7 +71949,7 @@ ] }, { - "id": 498, + "id": 503, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -71720,7 +71969,7 @@ } }, { - "id": 490, + "id": 495, "name": "body", "kind": 1024, "kindString": "Property", @@ -71741,7 +71990,7 @@ } }, { - "id": 493, + "id": 498, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -71758,34 +72007,45 @@ "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 499, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 495, + "id": 500, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 501, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 497, + "id": 502, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -71820,7 +72080,7 @@ } }, { - "id": 488, + "id": 493, "name": "headers", "kind": 1024, "kindString": "Property", @@ -71852,7 +72112,7 @@ } }, { - "id": 486, + "id": 491, "name": "method", "kind": 1024, "kindString": "Property", @@ -71893,7 +72153,7 @@ } }, { - "id": 489, + "id": 494, "name": "schema", "kind": 1024, "kindString": "Property", @@ -71914,7 +72174,7 @@ } }, { - "id": 491, + "id": 496, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -71935,7 +72195,7 @@ "defaultValue": "false" }, { - "id": 492, + "id": 497, "name": "signal", "kind": 1024, "kindString": "Property", @@ -71958,7 +72218,7 @@ } }, { - "id": 487, + "id": 492, "name": "url", "kind": 1024, "kindString": "Property", @@ -71980,7 +72240,7 @@ } }, { - "id": 501, + "id": 506, "name": "then", "kind": 2048, "kindString": "Method", @@ -71994,25 +72254,25 @@ ], "signatures": [ { - "id": 502, + "id": 507, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 503, + "id": 508, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -72020,7 +72280,7 @@ } }, { - "id": 504, + "id": 509, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -72033,7 +72293,7 @@ ], "parameters": [ { - "id": 505, + "id": 510, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -72050,32 +72310,32 @@ { "type": "reflection", "declaration": { - "id": 506, + "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 507, + "id": 512, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 508, + "id": 513, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -72088,7 +72348,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -72096,7 +72356,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -72114,7 +72374,7 @@ } }, { - "id": 509, + "id": 514, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -72131,21 +72391,21 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 515, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 511, + "id": 516, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 512, + "id": 517, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -72161,7 +72421,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -72169,7 +72429,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -72195,12 +72455,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -72222,7 +72482,7 @@ } }, { - "id": 499, + "id": 504, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -72236,7 +72496,7 @@ ], "signatures": [ { - "id": 500, + "id": 505, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -72247,11 +72507,11 @@ }, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -72265,17 +72525,17 @@ { "title": "Constructors", "kind": 512, - "children": [482] + "children": [487] }, { "title": "Properties", "kind": 1024, - "children": [498, 490, 493, 488, 486, 489, 491, 492, 487] + "children": [503, 495, 498, 493, 491, 494, 496, 497, 492] }, { "title": "Methods", "kind": 2048, - "children": [501, 499] + "children": [506, 504] } ], "sources": [ @@ -72287,7 +72547,7 @@ ], "typeParameter": [ { - "id": 513, + "id": 518, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -72297,7 +72557,7 @@ "extendedBy": [ { "type": "reference", - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder" } ], @@ -72307,11 +72567,11 @@ "typeArguments": [ { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -72329,16 +72589,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -72346,19 +72606,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 483, + "id": 488, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 482, + "id": 487, "name": "default.constructor" } }, { - "id": 464, + "id": 469, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -72378,12 +72638,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 498, + "id": 503, "name": "default.allowEmpty" } }, { - "id": 456, + "id": 461, "name": "body", "kind": 1024, "kindString": "Property", @@ -72404,12 +72664,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 490, + "id": 495, "name": "default.body" } }, { - "id": 459, + "id": 464, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -72426,34 +72686,45 @@ "type": { "type": "reflection", "declaration": { - "id": 460, + "id": 465, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 461, + "id": 466, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 462, + "id": 467, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 463, + "id": 468, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -72488,12 +72759,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 493, + "id": 498, "name": "default.fetch" } }, { - "id": 454, + "id": 459, "name": "headers", "kind": 1024, "kindString": "Property", @@ -72525,12 +72796,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 488, + "id": 493, "name": "default.headers" } }, { - "id": 452, + "id": 457, "name": "method", "kind": 1024, "kindString": "Property", @@ -72571,12 +72842,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 486, + "id": 491, "name": "default.method" } }, { - "id": 455, + "id": 460, "name": "schema", "kind": 1024, "kindString": "Property", @@ -72597,12 +72868,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 489, + "id": 494, "name": "default.schema" } }, { - "id": 457, + "id": 462, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -72623,12 +72894,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 491, + "id": 496, "name": "default.shouldThrowOnError" } }, { - "id": 458, + "id": 463, "name": "signal", "kind": 1024, "kindString": "Property", @@ -72651,12 +72922,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 492, + "id": 497, "name": "default.signal" } }, { - "id": 453, + "id": 458, "name": "url", "kind": 1024, "kindString": "Property", @@ -72678,12 +72949,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 487, + "id": 492, "name": "default.url" } }, { - "id": 432, + "id": 434, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -72691,27 +72962,30 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 110, + "line": 124, "character": 2 } ], "signatures": [ { - "id": 433, + "id": 435, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the AbortSignal for the fetch request." + "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { - "id": 434, + "id": 436, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -72722,16 +72996,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -72741,7 +73015,7 @@ ] }, { - "id": 439, + "id": 441, "name": "csv", "kind": 2048, "kindString": "Method", @@ -72749,26 +73023,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 138, + "line": 155, "character": 2 } ], "signatures": [ { - "id": 440, + "id": 442, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to CSV." + "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "intrinsic", @@ -72786,7 +73060,7 @@ ] }, { - "id": 443, + "id": 445, "name": "explain", "kind": 2048, "kindString": "Method", @@ -72794,48 +73068,133 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 189, "character": 2 } ], "signatures": [ { - "id": 444, + "id": 446, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Obtains the EXPLAIN plan for this request." + "shortText": "Return `data` as the EXPLAIN plan for the query." }, "parameters": [ { - "id": 445, - "name": "__namedParameters", + "id": 447, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 446, + "id": 448, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 447, + "id": 449, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 167, + "line": 197, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 452, + "name": "buffers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on buffer usage\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 200, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 454, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 202, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 451, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 199, "character": 4 } ], @@ -72846,56 +73205,19 @@ }, { "id": 450, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 170, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 449, - "name": "settings", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 448, "name": "verbose", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 198, "character": 4 } ], @@ -72905,17 +73227,20 @@ } }, { - "id": 451, + "id": 453, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 171, + "line": 201, "character": 4 } ], @@ -72929,7 +73254,7 @@ { "title": "Properties", "kind": 1024, - "children": [447, 450, 449, 448, 451] + "children": [449, 452, 454, 451, 450, 453] } ] } @@ -72938,41 +73263,65 @@ } ], "type": { - "type": "reference", - "typeArguments": [ + "type": "union", + "types": [ { "type": "reference", - "id": 514, "typeArguments": [ { "type": "reference", + "id": 521, "typeArguments": [ { "type": "intrinsic", "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" } ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "name": "PostgrestSingleResponse" } ], - "name": "PostgrestResponse" + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 519, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + ] } } ] }, { - "id": 441, + "id": 443, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -72980,26 +73329,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 146, + "line": 163, "character": 2 } ], "signatures": [ { - "id": 442, + "id": 444, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to GeoJSON." + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", @@ -73029,7 +73378,7 @@ ] }, { - "id": 419, + "id": 421, "name": "limit", "kind": 2048, "kindString": "Method", @@ -73037,29 +73386,29 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 2 } ], "signatures": [ { - "id": 420, + "id": 422, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result with the specified `count`." + "shortText": "Limit the query result by `count`." }, "parameters": [ { - "id": 421, + "id": 423, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum no. of rows to limit to." + "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", @@ -73067,36 +73416,39 @@ } }, { - "id": 422, - "name": "foreignTable", + "id": 424, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 423, + "id": 425, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 424, + "id": 426, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 43 } ], @@ -73110,7 +73462,7 @@ { "title": "Properties", "kind": 1024, - "children": [424] + "children": [426] } ] } @@ -73120,16 +73472,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -73139,7 +73491,7 @@ ] }, { - "id": 437, + "id": 439, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -73147,30 +73499,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 129, + "line": 146, "character": 2 } ], "signatures": [ { - "id": 438, + "id": 440, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 518, + "id": 523, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -73185,7 +73538,7 @@ ] }, { - "id": 403, + "id": 405, "name": "order", "kind": 2048, "kindString": "Method", @@ -73193,23 +73546,24 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, + "line": 59, "character": 2 } ], "signatures": [ { - "id": 404, + "id": 406, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Orders the result with the specified `column`." + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" }, "typeParameter": [ { - "id": 405, + "id": 407, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -73222,50 +73576,56 @@ ], "parameters": [ { - "id": 406, + "id": 408, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order on." + "shortText": "The column to order by" }, "type": { "type": "reference", - "id": 316, + "id": 315, "name": "ColumnName", "dereferenced": {} } }, { - "id": 407, + "id": 409, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, + "comment": { + "shortText": "Named parameters" + }, "type": { "type": "reflection", "declaration": { - "id": 408, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 409, + "id": 411, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 16 } ], @@ -73275,17 +73635,20 @@ } }, { - "id": 411, + "id": 413, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 59 } ], @@ -73295,17 +73658,20 @@ } }, { - "id": 410, + "id": 412, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 37 } ], @@ -73319,7 +73685,7 @@ { "title": "Properties", "kind": 1024, - "children": [409, 411, 410] + "children": [411, 413, 412] } ] } @@ -73328,16 +73694,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -73345,14 +73711,14 @@ } }, { - "id": 412, + "id": 414, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 413, + "id": 415, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -73363,7 +73729,7 @@ } }, { - "id": 414, + "id": 416, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -73373,14 +73739,14 @@ "type": { "type": "reflection", "declaration": { - "id": 415, + "id": 417, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 416, + "id": 418, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -73390,7 +73756,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 16 } ], @@ -73400,7 +73766,7 @@ } }, { - "id": 418, + "id": 420, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -73408,7 +73774,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 59 } ], @@ -73418,7 +73784,7 @@ } }, { - "id": 417, + "id": 419, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -73428,7 +73794,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 37 } ], @@ -73442,7 +73808,7 @@ { "title": "Properties", "kind": 1024, - "children": [416, 418, 417] + "children": [418, 420, 419] } ] } @@ -73451,16 +73817,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -73470,7 +73836,7 @@ ] }, { - "id": 425, + "id": 427, "name": "range", "kind": 2048, "kindString": "Method", @@ -73478,29 +73844,29 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 2 } ], "signatures": [ { - "id": 426, + "id": 428, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result to rows within the specified range, inclusive." + "shortText": "Limit the query result by `from` and `to` inclusively." }, "parameters": [ { - "id": 427, + "id": 429, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result, inclusive." + "shortText": "The starting index from which to limit the result" }, "type": { "type": "intrinsic", @@ -73508,13 +73874,13 @@ } }, { - "id": 428, + "id": 430, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result, inclusive." + "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", @@ -73522,36 +73888,39 @@ } }, { - "id": 429, - "name": "foreignTable", + "id": 431, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 430, + "id": 432, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 431, + "id": 433, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 54 } ], @@ -73565,7 +73934,7 @@ { "title": "Properties", "kind": 1024, - "children": [431] + "children": [433] } ] } @@ -73575,16 +73944,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -73594,7 +73963,51 @@ ] }, { - "id": 398, + "id": 455, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 229, + "character": 2 + } + ], + "signatures": [ + { + "id": 456, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 394, + "typeArguments": [ + { + "type": "reference", + "id": 397, + "name": "Row" + }, + { + "type": "reference", + "id": 398, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 400, "name": "select", "kind": 2048, "kindString": "Method", @@ -73608,17 +74021,18 @@ ], "signatures": [ { - "id": 399, + "id": 401, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs vertical filtering with SELECT." + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { - "id": 400, + "id": 402, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -73633,7 +74047,7 @@ } }, { - "id": 401, + "id": 403, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -73643,14 +74057,14 @@ "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" }, "extendsType": { @@ -73663,7 +74077,7 @@ }, "falseType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" } } @@ -73674,7 +74088,7 @@ ], "parameters": [ { - "id": 402, + "id": 404, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -73682,11 +74096,11 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas.\n" + "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", - "id": 311, + "id": 310, "name": "Query", "dereferenced": {} } @@ -73694,16 +74108,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 312, + "id": 311, "name": "NewResult" } ], @@ -73713,7 +74127,7 @@ ] }, { - "id": 435, + "id": 437, "name": "single", "kind": 2048, "kindString": "Method", @@ -73721,30 +74135,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 119, + "line": 135, "character": 2 } ], "signatures": [ { - "id": 436, + "id": 438, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -73759,7 +74174,7 @@ ] }, { - "id": 467, + "id": 472, "name": "then", "kind": 2048, "kindString": "Method", @@ -73773,25 +74188,25 @@ ], "signatures": [ { - "id": 468, + "id": 473, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 469, + "id": 474, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -73799,7 +74214,7 @@ } }, { - "id": 470, + "id": 475, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -73812,7 +74227,7 @@ ], "parameters": [ { - "id": 471, + "id": 476, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -73829,32 +74244,32 @@ { "type": "reflection", "declaration": { - "id": 472, + "id": 477, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 473, + "id": 478, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 474, + "id": 479, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -73867,7 +74282,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -73875,7 +74290,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -73893,7 +74308,7 @@ } }, { - "id": 475, + "id": 480, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -73910,21 +74325,21 @@ { "type": "reflection", "declaration": { - "id": 476, + "id": 481, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 477, + "id": 482, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 478, + "id": 483, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -73940,7 +74355,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -73948,7 +74363,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -73974,12 +74389,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -73991,19 +74406,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 502, + "id": 507, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 501, + "id": 506, "name": "default.then" } }, { - "id": 465, + "id": 470, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -74017,7 +74432,7 @@ ], "signatures": [ { - "id": 466, + "id": 471, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -74028,16 +74443,16 @@ }, "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -74045,14 +74460,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 500, + "id": 505, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 499, + "id": 504, "name": "default.throwOnError" } } @@ -74061,30 +74476,30 @@ { "title": "Constructors", "kind": 512, - "children": [393] + "children": [395] }, { "title": "Properties", "kind": 1024, - "children": [464, 456, 459, 454, 452, 455, 457, 458, 453] + "children": [469, 461, 464, 459, 457, 460, 462, 463, 458] }, { "title": "Methods", "kind": 2048, - "children": [432, 439, 443, 441, 419, 437, 403, 425, 398, 435, 467, 465] + "children": [434, 441, 445, 443, 421, 439, 405, 427, 455, 400, 437, 472, 470] } ], "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 9, + "line": 5, "character": 21 } ], "typeParameter": [ { - "id": 479, - "name": "Table", + "id": 484, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -74106,7 +74521,7 @@ } }, { - "id": 480, + "id": 485, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -74116,11 +74531,11 @@ "extendedTypes": [ { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -74130,13 +74545,13 @@ "extendedBy": [ { "type": "reference", - "id": 111, + "id": 110, "name": "PostgrestFilterBuilder" } ] }, { - "id": 520, + "id": 525, "name": "PostgrestError", "kind": 4194304, "kindString": "Type alias", @@ -74155,14 +74570,14 @@ "type": { "type": "reflection", "declaration": { - "id": 521, + "id": 526, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 525, + "id": 530, "name": "code", "kind": 1024, "kindString": "Property", @@ -74180,7 +74595,7 @@ } }, { - "id": 523, + "id": 528, "name": "details", "kind": 1024, "kindString": "Property", @@ -74198,7 +74613,7 @@ } }, { - "id": 524, + "id": 529, "name": "hint", "kind": 1024, "kindString": "Property", @@ -74216,7 +74631,7 @@ } }, { - "id": 522, + "id": 527, "name": "message", "kind": 1024, "kindString": "Property", @@ -74238,7 +74653,7 @@ { "title": "Properties", "kind": 1024, - "children": [525, 523, 524, 522] + "children": [530, 528, 529, 527] } ], "sources": [ @@ -74252,7 +74667,7 @@ } }, { - "id": 518, + "id": 523, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -74266,7 +74681,7 @@ ], "typeParameter": [ { - "id": 519, + "id": 524, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -74275,14 +74690,14 @@ ], "type": { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 519, + "id": 524, "name": "T" }, { @@ -74296,7 +74711,7 @@ } }, { - "id": 514, + "id": 519, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", @@ -74310,7 +74725,7 @@ ], "typeParameter": [ { - "id": 515, + "id": 520, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -74325,7 +74740,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 520, "name": "T" } ], @@ -74339,7 +74754,7 @@ } }, { - "id": 516, + "id": 521, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -74353,7 +74768,7 @@ ], "typeParameter": [ { - "id": 517, + "id": 522, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -74368,7 +74783,7 @@ "typeArguments": [ { "type": "reference", - "id": 517, + "id": 522, "name": "T" } ], @@ -74386,12 +74801,12 @@ { "title": "Classes", "kind": 128, - "children": [481, 1, 111, 46, 392] + "children": [486, 1, 110, 49, 394] }, { "title": "Type Aliases", "kind": 4194304, - "children": [520, 518, 514, 516] + "children": [525, 523, 519, 521] } ], "sources": [ diff --git a/spec/enrichments/tsdoc_v2/postgrest.json b/spec/enrichments/tsdoc_v2/postgrest.json index 4421702943e..7be98a509dd 100644 --- a/spec/enrichments/tsdoc_v2/postgrest.json +++ b/spec/enrichments/tsdoc_v2/postgrest.json @@ -7,7 +7,7 @@ "originalName": "", "children": [ { - "id": 481, + "id": 486, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -16,7 +16,7 @@ }, "children": [ { - "id": 482, + "id": 487, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -30,14 +30,14 @@ ], "signatures": [ { - "id": 483, + "id": 488, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 484, + "id": 489, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -46,18 +46,18 @@ ], "parameters": [ { - "id": 485, + "id": 490, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -67,11 +67,11 @@ ], "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -81,7 +81,7 @@ ] }, { - "id": 498, + "id": 503, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -101,7 +101,7 @@ } }, { - "id": 490, + "id": 495, "name": "body", "kind": 1024, "kindString": "Property", @@ -122,7 +122,7 @@ } }, { - "id": 493, + "id": 498, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -139,34 +139,45 @@ "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 499, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 495, + "id": 500, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 501, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 497, + "id": 502, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -201,7 +212,7 @@ } }, { - "id": 488, + "id": 493, "name": "headers", "kind": 1024, "kindString": "Property", @@ -233,7 +244,7 @@ } }, { - "id": 486, + "id": 491, "name": "method", "kind": 1024, "kindString": "Property", @@ -274,7 +285,7 @@ } }, { - "id": 489, + "id": 494, "name": "schema", "kind": 1024, "kindString": "Property", @@ -295,7 +306,7 @@ } }, { - "id": 491, + "id": 496, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -316,7 +327,7 @@ "defaultValue": "false" }, { - "id": 492, + "id": 497, "name": "signal", "kind": 1024, "kindString": "Property", @@ -339,7 +350,7 @@ } }, { - "id": 487, + "id": 492, "name": "url", "kind": 1024, "kindString": "Property", @@ -361,7 +372,7 @@ } }, { - "id": 501, + "id": 506, "name": "then", "kind": 2048, "kindString": "Method", @@ -375,25 +386,25 @@ ], "signatures": [ { - "id": 502, + "id": 507, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 503, + "id": 508, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -401,7 +412,7 @@ } }, { - "id": 504, + "id": 509, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -414,7 +425,7 @@ ], "parameters": [ { - "id": 505, + "id": 510, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -431,32 +442,32 @@ { "type": "reflection", "declaration": { - "id": 506, + "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 507, + "id": 512, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 508, + "id": 513, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -469,7 +480,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -477,7 +488,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -495,7 +506,7 @@ } }, { - "id": 509, + "id": 514, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -512,21 +523,21 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 515, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 511, + "id": 516, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 512, + "id": 517, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -542,7 +553,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -550,7 +561,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -576,12 +587,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -603,7 +614,7 @@ } }, { - "id": 499, + "id": 504, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -617,7 +628,7 @@ ], "signatures": [ { - "id": 500, + "id": 505, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -628,11 +639,11 @@ }, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -646,17 +657,17 @@ { "title": "Constructors", "kind": 512, - "children": [482] + "children": [487] }, { "title": "Properties", "kind": 1024, - "children": [498, 490, 493, 488, 486, 489, 491, 492, 487] + "children": [503, 495, 498, 493, 491, 494, 496, 497, 492] }, { "title": "Methods", "kind": 2048, - "children": [501, 499] + "children": [506, 504] } ], "sources": [ @@ -668,7 +679,7 @@ ], "typeParameter": [ { - "id": 513, + "id": 518, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -678,7 +689,7 @@ "extendedBy": [ { "type": "reference", - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder" } ], @@ -688,11 +699,11 @@ "typeArguments": [ { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -711,6 +722,9 @@ "kind": 128, "kindString": "Class", "flags": {}, + "comment": { + "shortText": "PostgREST client." + }, "children": [ { "id": 2, @@ -721,7 +735,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 29, + "line": 41, "character": 2 } ], @@ -851,7 +865,7 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "URL of the PostgREST endpoint." + "shortText": "URL of the PostgREST endpoint" }, "type": { "type": "intrinsic", @@ -860,10 +874,14 @@ }, { "id": 8, - "name": "__namedParameters", + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { @@ -884,7 +902,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 38, + "line": 50, "character": 6 } ], @@ -903,6 +921,9 @@ "kind": 4096, "kindString": "Call signature", "flags": {}, + "comment": { + "shortText": "Custom fetch\n" + }, "parameters": [ { "id": 15, @@ -911,10 +932,21 @@ "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { @@ -960,10 +992,13 @@ "flags": { "isOptional": true }, + "comment": { + "shortText": "Custom headers" + }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 36, + "line": 48, "character": 6 } ], @@ -992,10 +1027,13 @@ "flags": { "isOptional": true }, + "comment": { + "shortText": "Postgres schema to switch to" + }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 37, + "line": 49, "character": 6 } ], @@ -1054,7 +1092,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 19, + "line": 29, "character": 2 } ], @@ -1081,10 +1119,21 @@ "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { @@ -1131,7 +1180,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 17, + "line": 27, "character": 2 } ], @@ -1163,7 +1212,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 18, + "line": 28, "character": 2 } ], @@ -1182,7 +1231,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 16, + "line": 26, "character": 2 } ], @@ -1200,7 +1249,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 52, + "line": 64, "character": 2 } ], @@ -1212,7 +1261,7 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a table operation." + "shortText": "Perform a query on a table or a view." }, "typeParameter": [ { @@ -1241,12 +1290,12 @@ "parameters": [ { "id": 29, - "name": "table", + "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table name to operate on.\n" + "shortText": "The table or view name to query\n" }, "type": { "type": "reference", @@ -1257,7 +1306,7 @@ ], "type": { "type": "reference", - "id": 46, + "id": 49, "typeArguments": [ { "type": "reference", @@ -1274,10 +1323,67 @@ "kind": 4096, "kindString": "Call signature", "flags": {}, - "parameters": [ + "typeParameter": [ { "id": 31, - "name": "table", + "name": "ViewName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 32, + "name": "View", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericView" + } + } + ], + "parameters": [ + { + "id": 33, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 31, + "name": "ViewName" + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 32, + "name": "View" + } + ], + "name": "default" + } + }, + { + "id": 34, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 35, + "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, @@ -1289,7 +1395,7 @@ ], "type": { "type": "reference", - "id": 46, + "id": 49, "typeArguments": [ { "type": "intrinsic", @@ -1302,7 +1408,7 @@ ] }, { - "id": 32, + "id": 36, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -1310,13 +1416,13 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 73, + "line": 102, "character": 2 } ], "signatures": [ { - "id": 33, + "id": 37, "name": "rpc", "kind": 4096, "kindString": "Call signature", @@ -1326,7 +1432,7 @@ }, "typeParameter": [ { - "id": 34, + "id": 38, "name": "FunctionName", "kind": 131072, "kindString": "Type parameter", @@ -1337,7 +1443,7 @@ } }, { - "id": 35, + "id": 39, "name": "Function_", "kind": 131072, "kindString": "Type parameter", @@ -1350,28 +1456,28 @@ ], "parameters": [ { - "id": 36, + "id": 40, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The function name to call." + "shortText": "The function name to call" }, "type": { "type": "reference", - "id": 34, + "id": 38, "name": "FunctionName" } }, { - "id": 37, + "id": 41, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The parameters to pass to the function call." + "shortText": "The arguments to pass to the function call" }, "type": { "type": "indexedAccess", @@ -1381,33 +1487,33 @@ }, "objectType": { "type": "reference", - "id": 35, + "id": 39, "name": "Function_" } }, "defaultValue": "{}" }, { - "id": 38, + "id": 42, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters.\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 39, + "id": 43, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 41, + "id": 45, "name": "count", "kind": 1024, "kindString": "Property", @@ -1415,12 +1521,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 87, + "line": 113, "character": 6 } ], @@ -1443,7 +1549,7 @@ } }, { - "id": 40, + "id": 44, "name": "head", "kind": 1024, "kindString": "Property", @@ -1451,35 +1557,12 @@ "isOptional": true }, "comment": { - "shortText": "When set to true, no data will be returned." + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 85, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 42, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 89, + "line": 112, "character": 6 } ], @@ -1493,7 +1576,7 @@ { "title": "Properties", "kind": 1024, - "children": [41, 40, 42] + "children": [45, 44] } ] } @@ -1503,7 +1586,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "conditional", @@ -1515,7 +1598,7 @@ }, "objectType": { "type": "reference", - "id": 35, + "id": 39, "name": "Function_" } }, @@ -1591,7 +1674,7 @@ }, "objectType": { "type": "reference", - "id": 35, + "id": 39, "name": "Function_" } } @@ -1616,34 +1699,40 @@ { "title": "Methods", "kind": 2048, - "children": [25, 32] + "children": [25, 36] } ], "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 7, + "line": 17, "character": 21 } ], "typeParameter": [ { - "id": 43, + "id": 46, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, + "comment": { + "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" + }, "default": { "type": "intrinsic", "name": "any" } }, { - "id": 44, + "id": 47, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, + "comment": { + "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" + }, "type": { "type": "intersection", "types": [ @@ -1702,7 +1791,7 @@ } }, { - "id": 45, + "id": 48, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -1752,29 +1841,29 @@ ] }, { - "id": 111, + "id": 110, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 112, + "id": 111, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 113, + "id": 112, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 114, - "name": "Table", + "id": 113, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -1796,7 +1885,7 @@ } }, { - "id": 115, + "id": 114, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -1805,18 +1894,18 @@ ], "parameters": [ { - "id": 116, + "id": 115, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -1826,16 +1915,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -1843,19 +1932,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 394, + "id": 396, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 393, + "id": 395, "name": "default.constructor" } }, { - "id": 375, + "id": 377, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -1875,12 +1964,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 464, + "id": 469, "name": "default.allowEmpty" } }, { - "id": 367, + "id": 369, "name": "body", "kind": 1024, "kindString": "Property", @@ -1901,12 +1990,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 456, + "id": 461, "name": "default.body" } }, { - "id": 370, + "id": 372, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -1923,34 +2012,45 @@ "type": { "type": "reflection", "declaration": { - "id": 371, + "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 372, + "id": 374, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 373, + "id": 375, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 374, + "id": 376, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -1985,12 +2085,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 459, + "id": 464, "name": "default.fetch" } }, { - "id": 365, + "id": 367, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2022,12 +2122,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 454, + "id": 459, "name": "default.headers" } }, { - "id": 363, + "id": 365, "name": "method", "kind": 1024, "kindString": "Property", @@ -2068,12 +2168,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 452, + "id": 457, "name": "default.method" } }, { - "id": 366, + "id": 368, "name": "schema", "kind": 1024, "kindString": "Property", @@ -2094,12 +2194,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 455, + "id": 460, "name": "default.schema" } }, { - "id": 368, + "id": 370, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -2120,12 +2220,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 457, + "id": 462, "name": "default.shouldThrowOnError" } }, { - "id": 369, + "id": 371, "name": "signal", "kind": 1024, "kindString": "Property", @@ -2148,12 +2248,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 458, + "id": 463, "name": "default.signal" } }, { - "id": 364, + "id": 366, "name": "url", "kind": 1024, "kindString": "Property", @@ -2175,12 +2275,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 453, + "id": 458, "name": "default.url" } }, { - "id": 343, + "id": 342, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -2188,27 +2288,30 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 110, + "line": 124, "character": 2 } ], "signatures": [ { - "id": 344, + "id": 343, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the AbortSignal for the fetch request." + "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { - "id": 345, + "id": 344, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -2219,16 +2322,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -2236,19 +2339,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 433, + "id": 435, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 432, + "id": 434, "name": "default.abortSignal" } }, { - "id": 221, + "id": 204, "name": "containedBy", "kind": 2048, "kindString": "Method", @@ -2256,23 +2359,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 250, + "line": 214, "character": 2 } ], "signatures": [ { - "id": 222, + "id": 205, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose json, array, or range value on the stated `column` is\ncontained by the specified `value`." + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." }, "typeParameter": [ { - "id": 223, + "id": 206, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -2285,28 +2388,28 @@ ], "parameters": [ { - "id": 224, + "id": 207, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", - "id": 223, + "id": 206, "name": "ColumnName" } }, { - "id": 225, + "id": 208, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", @@ -2337,13 +2440,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 223, + "id": 206, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -2353,16 +2456,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -2370,14 +2473,14 @@ } }, { - "id": 226, + "id": 209, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 210, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -2388,7 +2491,7 @@ } }, { - "id": 228, + "id": 211, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -2400,6 +2503,13 @@ "type": "intrinsic", "name": "string" }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, { "type": "reference", "typeArguments": [ @@ -2415,13 +2525,6 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } } ] } @@ -2429,16 +2532,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -2448,7 +2551,7 @@ ] }, { - "id": 213, + "id": 196, "name": "contains", "kind": 2048, "kindString": "Method", @@ -2456,23 +2559,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 223, + "line": 187, "character": 2 } ], "signatures": [ { - "id": 214, + "id": 197, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose json, array, or range value on the stated `column`\ncontains the values specified in `value`." + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." }, "typeParameter": [ { - "id": 215, + "id": 198, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -2485,28 +2588,28 @@ ], "parameters": [ { - "id": 216, + "id": 199, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", - "id": 215, + "id": 198, "name": "ColumnName" } }, { - "id": 217, + "id": 200, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", @@ -2537,13 +2640,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 215, + "id": 198, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -2553,16 +2656,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -2570,14 +2673,14 @@ } }, { - "id": 218, + "id": 201, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 219, + "id": 202, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -2588,7 +2691,7 @@ } }, { - "id": 220, + "id": 203, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -2600,6 +2703,13 @@ "type": "intrinsic", "name": "string" }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, { "type": "reference", "typeArguments": [ @@ -2615,13 +2725,6 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } } ] } @@ -2629,16 +2732,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -2648,7 +2751,7 @@ ] }, { - "id": 350, + "id": 349, "name": "csv", "kind": 2048, "kindString": "Method", @@ -2656,26 +2759,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 138, + "line": 155, "character": 2 } ], "signatures": [ { - "id": 351, + "id": 350, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to CSV." + "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "intrinsic", @@ -2691,19 +2794,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 440, + "id": 442, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 439, + "id": 441, "name": "default.csv" } }, { - "id": 133, + "id": 116, "name": "eq", "kind": 2048, "kindString": "Method", @@ -2711,23 +2814,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 72, + "line": 39, "character": 2 } ], "signatures": [ { - "id": 134, + "id": 117, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` exactly matches the\nspecified `value`." + "shortText": "Match only rows where `column` is equal to `value`.", + "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" }, "typeParameter": [ { - "id": 135, + "id": 118, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -2740,56 +2844,56 @@ ], "parameters": [ { - "id": 136, + "id": 119, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 135, + "id": 118, "name": "ColumnName" } }, { - "id": 137, + "id": 120, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 135, + "id": 118, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -2797,14 +2901,14 @@ } }, { - "id": 138, + "id": 121, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 139, + "id": 122, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -2815,7 +2919,7 @@ } }, { - "id": 140, + "id": 123, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -2828,16 +2932,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -2847,7 +2951,7 @@ ] }, { - "id": 354, + "id": 353, "name": "explain", "kind": 2048, "kindString": "Method", @@ -2855,68 +2959,55 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 189, "character": 2 } ], "signatures": [ { - "id": 355, + "id": 354, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Obtains the EXPLAIN plan for this request." + "shortText": "Return `data` as the EXPLAIN plan for the query." }, "parameters": [ { - "id": 356, - "name": "__namedParameters", + "id": 355, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 357, + "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 358, + "id": 357, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 167, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 361, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 170, + "line": 197, "character": 4 } ], @@ -2927,36 +3018,19 @@ }, { "id": 360, - "name": "settings", + "name": "buffers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 359, - "name": "verbose", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true + "comment": { + "shortText": "If `true`, include information on buffer usage\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 200, "character": 4 } ], @@ -2967,16 +3041,97 @@ }, { "id": 362, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 202, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 359, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 199, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 358, + "name": "verbose", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 198, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 361, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 171, + "line": 201, "character": 4 } ], @@ -2990,7 +3145,7 @@ { "title": "Properties", "kind": 1024, - "children": [358, 361, 360, 359, 362] + "children": [357, 360, 362, 359, 358, 361] } ] } @@ -2999,51 +3154,75 @@ } ], "type": { - "type": "reference", - "typeArguments": [ + "type": "union", + "types": [ { "type": "reference", - "id": 514, "typeArguments": [ { "type": "reference", + "id": 521, "typeArguments": [ { "type": "intrinsic", "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" } ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "name": "PostgrestSingleResponse" } ], - "name": "PostgrestResponse" + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 519, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + ] }, "inheritedFrom": { "type": "reference", - "id": 444, + "id": 446, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 443, + "id": 445, "name": "default.explain" } }, { - "id": 293, + "id": 298, "name": "filter", "kind": 2048, "kindString": "Method", @@ -3051,23 +3230,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 406, + "line": 439, "character": 2 } ], "signatures": [ { - "id": 294, + "id": 299, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose `column` satisfies the filter." + "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { - "id": 295, + "id": 300, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3080,28 +3260,28 @@ ], "parameters": [ { - "id": 296, + "id": 301, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 295, + "id": 300, "name": "ColumnName" } }, { - "id": 297, + "id": 302, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with." + "shortText": "The operator to filter with, following PostgREST syntax" }, "type": { "type": "union", @@ -3202,13 +3382,13 @@ } }, { - "id": 298, + "id": 303, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "intrinsic", @@ -3218,16 +3398,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3235,14 +3415,14 @@ } }, { - "id": 299, + "id": 304, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 300, + "id": 305, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3253,7 +3433,7 @@ } }, { - "id": 301, + "id": 306, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -3264,7 +3444,7 @@ } }, { - "id": 302, + "id": 307, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3277,16 +3457,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3296,7 +3476,7 @@ ] }, { - "id": 352, + "id": 351, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -3304,26 +3484,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 146, + "line": 163, "character": 2 } ], "signatures": [ { - "id": 353, + "id": 352, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to GeoJSON." + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", @@ -3351,19 +3531,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 442, + "id": 444, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 441, + "id": 443, "name": "default.geojson" } }, { - "id": 149, + "id": 132, "name": "gt", "kind": 2048, "kindString": "Method", @@ -3371,23 +3551,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 100, + "line": 65, "character": 2 } ], "signatures": [ { - "id": 150, + "id": 133, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is greater than the\nspecified `value`." + "shortText": "Match only rows where `column` is greater than `value`." }, "typeParameter": [ { - "id": 151, + "id": 134, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3400,56 +3580,56 @@ ], "parameters": [ { - "id": 152, + "id": 135, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 151, + "id": 134, "name": "ColumnName" } }, { - "id": 153, + "id": 136, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 151, + "id": 134, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3457,14 +3637,14 @@ } }, { - "id": 154, + "id": 137, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 155, + "id": 138, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3475,7 +3655,7 @@ } }, { - "id": 156, + "id": 139, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3488,16 +3668,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3507,7 +3687,7 @@ ] }, { - "id": 157, + "id": 140, "name": "gte", "kind": 2048, "kindString": "Method", @@ -3515,23 +3695,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 114, + "line": 78, "character": 2 } ], "signatures": [ { - "id": 158, + "id": 141, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is greater than or\nequal to the specified `value`." + "shortText": "Match only rows where `column` is greater than or equal to `value`." }, "typeParameter": [ { - "id": 159, + "id": 142, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3544,56 +3724,56 @@ ], "parameters": [ { - "id": 160, + "id": 143, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 159, + "id": 142, "name": "ColumnName" } }, { - "id": 161, + "id": 144, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 159, + "id": 142, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3601,14 +3781,14 @@ } }, { - "id": 162, + "id": 145, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 163, + "id": 146, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3619,7 +3799,7 @@ } }, { - "id": 164, + "id": 147, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3632,16 +3812,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3651,7 +3831,7 @@ ] }, { - "id": 189, + "id": 172, "name": "ilike", "kind": 2048, "kindString": "Method", @@ -3659,23 +3839,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 170, + "line": 130, "character": 2 } ], "signatures": [ { - "id": 190, + "id": 173, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case insensitive)." + "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "typeParameter": [ { - "id": 191, + "id": 174, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3688,28 +3868,28 @@ ], "parameters": [ { - "id": 192, + "id": 175, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 191, + "id": 174, "name": "ColumnName" } }, { - "id": 193, + "id": 176, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to filter with.\n" + "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", @@ -3719,16 +3899,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3736,14 +3916,14 @@ } }, { - "id": 194, + "id": 177, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 178, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3754,7 +3934,7 @@ } }, { - "id": 196, + "id": 179, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -3767,16 +3947,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3786,7 +3966,7 @@ ] }, { - "id": 205, + "id": 188, "name": "in", "kind": 2048, "kindString": "Method", @@ -3794,23 +3974,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 201, + "line": 165, "character": 2 } ], "signatures": [ { - "id": 206, + "id": 189, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is found on the\nspecified `values`." + "shortText": "Match only rows where `column` is included in the `values` array." }, "typeParameter": [ { - "id": 207, + "id": 190, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3823,28 +4003,28 @@ ], "parameters": [ { - "id": 208, + "id": 191, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 207, + "id": 190, "name": "ColumnName" } }, { - "id": 209, + "id": 192, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to filter with.\n" + "shortText": "The values array to filter with\n" }, "type": { "type": "array", @@ -3852,13 +4032,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 207, + "id": 190, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -3866,16 +4046,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3883,14 +4063,14 @@ } }, { - "id": 210, + "id": 193, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 211, + "id": 194, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3901,7 +4081,7 @@ } }, { - "id": 212, + "id": 195, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -3917,16 +4097,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3936,7 +4116,7 @@ ] }, { - "id": 197, + "id": 180, "name": "is", "kind": 2048, "kindString": "Method", @@ -3944,23 +4124,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 184, + "line": 149, "character": 2 } ], "signatures": [ { - "id": 198, + "id": 181, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "A check for exact equality (null, true, false), finds all rows whose\nvalue on the stated `column` exactly match the specified `value`." + "shortText": "Match only rows where `column` IS `value`.", + "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" }, "typeParameter": [ { - "id": 199, + "id": 182, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3973,28 +4154,28 @@ ], "parameters": [ { - "id": 200, + "id": 183, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" } }, { - "id": 201, + "id": 184, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "intersection", @@ -4006,13 +4187,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } }, { @@ -4028,13 +4209,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } }, { @@ -4050,13 +4231,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } }, { @@ -4071,16 +4252,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4088,14 +4269,14 @@ } }, { - "id": 202, + "id": 185, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 203, + "id": 186, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4106,7 +4287,7 @@ } }, { - "id": 204, + "id": 187, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4128,16 +4309,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4147,7 +4328,7 @@ ] }, { - "id": 181, + "id": 164, "name": "like", "kind": 2048, "kindString": "Method", @@ -4155,23 +4336,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 156, + "line": 117, "character": 2 } ], "signatures": [ { - "id": 182, + "id": 165, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case sensitive)." + "shortText": "Match only rows where `column` matches `pattern` case-sensitively." }, "typeParameter": [ { - "id": 183, + "id": 166, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4184,28 +4365,28 @@ ], "parameters": [ { - "id": 184, + "id": 167, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 183, + "id": 166, "name": "ColumnName" } }, { - "id": 185, + "id": 168, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to filter with.\n" + "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", @@ -4215,16 +4396,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4232,14 +4413,14 @@ } }, { - "id": 186, + "id": 169, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 187, + "id": 170, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4250,7 +4431,7 @@ } }, { - "id": 188, + "id": 171, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -4263,16 +4444,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4282,7 +4463,7 @@ ] }, { - "id": 330, + "id": 329, "name": "limit", "kind": 2048, "kindString": "Method", @@ -4290,29 +4471,29 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 2 } ], "signatures": [ { - "id": 331, + "id": 330, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result with the specified `count`." + "shortText": "Limit the query result by `count`." }, "parameters": [ { - "id": 332, + "id": 331, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum no. of rows to limit to." + "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", @@ -4320,36 +4501,39 @@ } }, { - "id": 333, - "name": "foreignTable", + "id": 332, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 334, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 335, + "id": 334, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 43 } ], @@ -4363,7 +4547,7 @@ { "title": "Properties", "kind": 1024, - "children": [335] + "children": [334] } ] } @@ -4373,16 +4557,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4390,19 +4574,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 420, + "id": 422, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 419, + "id": 421, "name": "default.limit" } }, { - "id": 165, + "id": 148, "name": "lt", "kind": 2048, "kindString": "Method", @@ -4410,23 +4594,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 128, + "line": 91, "character": 2 } ], "signatures": [ { - "id": 166, + "id": 149, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is less than the\nspecified `value`." + "shortText": "Match only rows where `column` is less than `value`." }, "typeParameter": [ { - "id": 167, + "id": 150, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4439,56 +4623,56 @@ ], "parameters": [ { - "id": 168, + "id": 151, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 167, + "id": 150, "name": "ColumnName" } }, { - "id": 169, + "id": 152, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 167, + "id": 150, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4496,14 +4680,14 @@ } }, { - "id": 170, + "id": 153, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 171, + "id": 154, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4514,7 +4698,7 @@ } }, { - "id": 172, + "id": 155, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4527,16 +4711,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4546,7 +4730,7 @@ ] }, { - "id": 173, + "id": 156, "name": "lte", "kind": 2048, "kindString": "Method", @@ -4554,23 +4738,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 142, + "line": 104, "character": 2 } ], "signatures": [ { - "id": 174, + "id": 157, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is less than or equal\nto the specified `value`." + "shortText": "Match only rows where `column` is less than or equal to `value`." }, "typeParameter": [ { - "id": 175, + "id": 158, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4583,56 +4767,56 @@ ], "parameters": [ { - "id": 176, + "id": 159, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 175, + "id": 158, "name": "ColumnName" } }, { - "id": 177, + "id": 160, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 175, + "id": 158, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4640,14 +4824,14 @@ } }, { - "id": 178, + "id": 161, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 179, + "id": 162, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4658,7 +4842,7 @@ } }, { - "id": 180, + "id": 163, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4671,16 +4855,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4690,7 +4874,7 @@ ] }, { - "id": 303, + "id": 276, "name": "match", "kind": 2048, "kindString": "Method", @@ -4698,23 +4882,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 423, + "line": 374, "character": 2 } ], "signatures": [ { - "id": 304, + "id": 277, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose columns match the specified `query` object." + "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." }, "typeParameter": [ { - "id": 305, + "id": 278, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4727,33 +4911,33 @@ ], "parameters": [ { - "id": 306, + "id": 279, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\n to their filter values.\n" + "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 305, + "id": 278, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 305, + "id": 278, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } ], @@ -4765,16 +4949,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4782,14 +4966,14 @@ } }, { - "id": 307, + "id": 280, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 308, + "id": 281, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -4814,16 +4998,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4833,7 +5017,7 @@ ] }, { - "id": 348, + "id": 347, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -4841,30 +5025,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 129, + "line": 146, "character": 2 } ], "signatures": [ { - "id": 349, + "id": 348, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 518, + "id": 523, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4877,19 +5062,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 438, + "id": 440, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 437, + "id": 439, "name": "default.maybeSingle" } }, { - "id": 141, + "id": 124, "name": "neq", "kind": 2048, "kindString": "Method", @@ -4897,23 +5082,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 86, + "line": 52, "character": 2 } ], "signatures": [ { - "id": 142, + "id": 125, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` doesn't match the\nspecified `value`." + "shortText": "Match only rows where `column` is not equal to `value`." }, "typeParameter": [ { - "id": 143, + "id": 126, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4926,56 +5111,56 @@ ], "parameters": [ { - "id": 144, + "id": 127, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 143, + "id": 126, "name": "ColumnName" } }, { - "id": 145, + "id": 128, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 143, + "id": 126, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4983,14 +5168,14 @@ } }, { - "id": 146, + "id": 129, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 130, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5001,7 +5186,7 @@ } }, { - "id": 148, + "id": 131, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5014,16 +5199,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5033,7 +5218,7 @@ ] }, { - "id": 117, + "id": 282, "name": "not", "kind": 2048, "kindString": "Method", @@ -5041,23 +5226,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 42, + "line": 396, "character": 2 } ], "signatures": [ { - "id": 118, + "id": 283, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows which doesn't satisfy the filter." + "shortText": "Match only rows which doesn't satisfy the filter.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { - "id": 119, + "id": 284, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5070,28 +5256,28 @@ ], "parameters": [ { - "id": 120, + "id": 285, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 119, + "id": 284, "name": "ColumnName" } }, { - "id": 121, + "id": 286, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with." + "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" }, "type": { "type": "reference", @@ -5099,41 +5285,41 @@ } }, { - "id": 122, + "id": 287, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 119, + "id": 284, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5141,14 +5327,14 @@ } }, { - "id": 123, + "id": 288, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 289, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5159,7 +5345,7 @@ } }, { - "id": 125, + "id": 290, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -5170,7 +5356,7 @@ } }, { - "id": 126, + "id": 291, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5183,16 +5369,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5202,7 +5388,7 @@ ] }, { - "id": 127, + "id": 292, "name": "or", "kind": 2048, "kindString": "Method", @@ -5210,29 +5396,30 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 59, + "line": 420, "character": 2 } ], "signatures": [ { - "id": 128, + "id": 293, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows satisfying at least one of the filters." + "shortText": "Match only rows which satisfy at least one of the filters.", + "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" }, "parameters": [ { - "id": 129, + "id": 294, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The filters to use, separated by commas." + "shortText": "The filters to use, following PostgREST syntax" }, "type": { "type": "intrinsic", @@ -5240,26 +5427,26 @@ } }, { - "id": 130, + "id": 295, "name": "foreignTable", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (if `column` is a foreign column).\n" + "shortText": "Set this to filter on foreign tables instead of the\ncurrent table\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 131, + "id": 296, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 132, + "id": 297, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -5269,7 +5456,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 59, + "line": 420, "character": 42 } ], @@ -5283,7 +5470,7 @@ { "title": "Properties", "kind": 1024, - "children": [132] + "children": [297] } ] } @@ -5293,16 +5480,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5312,7 +5499,7 @@ ] }, { - "id": 314, + "id": 313, "name": "order", "kind": 2048, "kindString": "Method", @@ -5320,23 +5507,24 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, + "line": 59, "character": 2 } ], "signatures": [ { - "id": 315, + "id": 314, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Orders the result with the specified `column`." + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" }, "typeParameter": [ { - "id": 316, + "id": 315, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5349,49 +5537,55 @@ ], "parameters": [ { - "id": 317, + "id": 316, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order on." + "shortText": "The column to order by" }, "type": { "type": "reference", - "id": 316, + "id": 315, "name": "ColumnName" } }, { - "id": 318, + "id": 317, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, + "comment": { + "shortText": "Named parameters" + }, "type": { "type": "reflection", "declaration": { - "id": 319, + "id": 318, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 320, + "id": 319, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 16 } ], @@ -5401,17 +5595,20 @@ } }, { - "id": 322, + "id": 321, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 59 } ], @@ -5421,17 +5618,20 @@ } }, { - "id": 321, + "id": 320, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 37 } ], @@ -5445,7 +5645,7 @@ { "title": "Properties", "kind": 1024, - "children": [320, 322, 321] + "children": [319, 321, 320] } ] } @@ -5454,16 +5654,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5471,19 +5671,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 404, + "id": 406, "name": "default.order" } }, { - "id": 323, + "id": 322, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 324, + "id": 323, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5494,7 +5694,7 @@ } }, { - "id": 325, + "id": 324, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -5504,14 +5704,14 @@ "type": { "type": "reflection", "declaration": { - "id": 326, + "id": 325, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 327, + "id": 326, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -5521,7 +5721,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 16 } ], @@ -5531,7 +5731,7 @@ } }, { - "id": 329, + "id": 328, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -5539,7 +5739,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 59 } ], @@ -5549,7 +5749,7 @@ } }, { - "id": 328, + "id": 327, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -5559,7 +5759,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 37 } ], @@ -5573,7 +5773,7 @@ { "title": "Properties", "kind": 1024, - "children": [327, 329, 328] + "children": [326, 328, 327] } ] } @@ -5582,16 +5782,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5599,19 +5799,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 412, + "id": 414, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 403, + "id": 405, "name": "default.order" } }, { - "id": 269, + "id": 252, "name": "overlaps", "kind": 2048, "kindString": "Method", @@ -5619,23 +5819,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 346, + "line": 313, "character": 2 } ], "signatures": [ { - "id": 270, + "id": 253, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose array or range value on the stated `column` overlaps\n(has a value in common) with the specified `value`." + "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." }, "typeParameter": [ { - "id": 271, + "id": 254, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5648,28 +5848,28 @@ ], "parameters": [ { - "id": 272, + "id": 255, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The array or range column to filter on" }, "type": { "type": "reference", - "id": 271, + "id": 254, "name": "ColumnName" } }, { - "id": 273, + "id": 256, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The array or range value to filter with\n" }, "type": { "type": "union", @@ -5684,13 +5884,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 271, + "id": 254, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -5700,16 +5900,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5717,14 +5917,14 @@ } }, { - "id": 274, + "id": 257, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 275, + "id": 258, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5735,7 +5935,7 @@ } }, { - "id": 276, + "id": 259, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5760,16 +5960,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5779,7 +5979,7 @@ ] }, { - "id": 336, + "id": 335, "name": "range", "kind": 2048, "kindString": "Method", @@ -5787,29 +5987,43 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 2 } ], "signatures": [ { - "id": 337, + "id": 336, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result to rows within the specified range, inclusive." + "shortText": "Limit the query result by `from` and `to` inclusively." }, "parameters": [ { - "id": 338, + "id": 337, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result, inclusive." + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 338, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", @@ -5818,49 +6032,38 @@ }, { "id": 339, - "name": "to", + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result, inclusive." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 340, - "name": "foreignTable", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 341, + "id": 340, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 341, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 54 } ], @@ -5874,7 +6077,7 @@ { "title": "Properties", "kind": 1024, - "children": [342] + "children": [341] } ] } @@ -5884,16 +6087,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5901,19 +6104,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 426, + "id": 428, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 425, + "id": 427, "name": "default.range" } }, { - "id": 261, + "id": 244, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", @@ -5921,23 +6124,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 332, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 262, + "id": 245, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` is adjacent to\nthe specified `range`." + "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." }, "typeParameter": [ { - "id": 263, + "id": 246, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5950,28 +6153,28 @@ ], "parameters": [ { - "id": 264, + "id": 247, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 263, + "id": 246, "name": "ColumnName" } }, { - "id": 265, + "id": 248, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -5981,16 +6184,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5998,14 +6201,14 @@ } }, { - "id": 266, + "id": 249, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 267, + "id": 250, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6016,7 +6219,7 @@ } }, { - "id": 268, + "id": 251, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -6029,16 +6232,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6048,7 +6251,7 @@ ] }, { - "id": 237, + "id": 212, "name": "rangeGt", "kind": 2048, "kindString": "Method", @@ -6056,23 +6259,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 290, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 238, + "id": 213, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` is strictly to\nthe right of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." }, "typeParameter": [ { - "id": 239, + "id": 214, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6085,28 +6288,28 @@ ], "parameters": [ { - "id": 240, + "id": 215, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 239, + "id": 214, "name": "ColumnName" } }, { - "id": 241, + "id": 216, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -6116,16 +6319,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6133,14 +6336,14 @@ } }, { - "id": 242, + "id": 217, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 243, + "id": 218, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6151,7 +6354,7 @@ } }, { - "id": 244, + "id": 219, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -6164,16 +6367,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6183,7 +6386,7 @@ ] }, { - "id": 245, + "id": 220, "name": "rangeGte", "kind": 2048, "kindString": "Method", @@ -6191,23 +6394,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 304, + "line": 255, "character": 2 } ], "signatures": [ { - "id": 246, + "id": 221, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the left of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." }, "typeParameter": [ { - "id": 247, + "id": 222, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6220,28 +6423,28 @@ ], "parameters": [ { - "id": 248, + "id": 223, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 247, + "id": 222, "name": "ColumnName" } }, { - "id": 249, + "id": 224, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -6251,16 +6454,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6268,14 +6471,14 @@ } }, { - "id": 250, + "id": 225, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 251, + "id": 226, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6286,7 +6489,7 @@ } }, { - "id": 252, + "id": 227, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -6299,16 +6502,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6318,7 +6521,7 @@ ] }, { - "id": 229, + "id": 228, "name": "rangeLt", "kind": 2048, "kindString": "Method", @@ -6326,23 +6529,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 276, + "line": 269, "character": 2 } ], "signatures": [ { - "id": 230, + "id": 229, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` is strictly to the\nleft of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." }, "typeParameter": [ { - "id": 231, + "id": 230, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6355,28 +6558,28 @@ ], "parameters": [ { - "id": 232, + "id": 231, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 231, + "id": 230, "name": "ColumnName" } }, { - "id": 233, + "id": 232, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -6386,16 +6589,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6403,14 +6606,14 @@ } }, { - "id": 234, + "id": 233, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 235, + "id": 234, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6421,7 +6624,7 @@ } }, { - "id": 236, + "id": 235, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -6434,16 +6637,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6453,7 +6656,7 @@ ] }, { - "id": 253, + "id": 236, "name": "rangeLte", "kind": 2048, "kindString": "Method", @@ -6461,23 +6664,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 318, + "line": 284, "character": 2 } ], "signatures": [ { - "id": 254, + "id": 237, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the right of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." }, "typeParameter": [ { - "id": 255, + "id": 238, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6490,28 +6693,28 @@ ], "parameters": [ { - "id": 256, + "id": 239, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 255, + "id": 238, "name": "ColumnName" } }, { - "id": 257, + "id": 240, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -6521,16 +6724,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6538,14 +6741,14 @@ } }, { - "id": 258, + "id": 241, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 259, + "id": 242, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6556,7 +6759,7 @@ } }, { - "id": 260, + "id": 243, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -6569,16 +6772,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6588,7 +6791,61 @@ ] }, { - "id": 309, + "id": 363, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 229, + "character": 2 + } + ], + "signatures": [ + { + "id": 364, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 110, + "typeArguments": [ + { + "type": "reference", + "id": 113, + "name": "Row" + }, + { + "type": "reference", + "id": 114, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 456, + "name": "default.rollback" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 455, + "name": "default.rollback" + } + }, + { + "id": 308, "name": "select", "kind": 2048, "kindString": "Method", @@ -6602,17 +6859,18 @@ ], "signatures": [ { - "id": 310, + "id": 309, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs vertical filtering with SELECT." + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { - "id": 311, + "id": 310, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -6627,7 +6885,7 @@ } }, { - "id": 312, + "id": 311, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -6637,14 +6895,14 @@ "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" }, "extendsType": { @@ -6657,7 +6915,7 @@ }, "falseType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" } } @@ -6668,7 +6926,7 @@ ], "parameters": [ { - "id": 313, + "id": 312, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -6676,27 +6934,27 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas.\n" + "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" } } ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 312, + "id": 311, "name": "NewResult" } ], @@ -6704,19 +6962,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 399, + "id": 401, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 398, + "id": 400, "name": "default.select" } }, { - "id": 346, + "id": 345, "name": "single", "kind": 2048, "kindString": "Method", @@ -6724,30 +6982,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 119, + "line": 135, "character": 2 } ], "signatures": [ { - "id": 347, + "id": 346, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6760,19 +7019,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 436, + "id": 438, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 435, + "id": 437, "name": "default.single" } }, { - "id": 277, + "id": 260, "name": "textSearch", "kind": 2048, "kindString": "Method", @@ -6780,23 +7039,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 371, + "line": 339, "character": 2 } ], "signatures": [ { - "id": 278, + "id": 261, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose text or tsvector value on the stated `column` matches\nthe tsquery in `query`." + "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." }, "typeParameter": [ { - "id": 279, + "id": 262, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6809,28 +7068,28 @@ ], "parameters": [ { - "id": 280, + "id": 263, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The text or tsvector column to filter on" }, "type": { "type": "reference", - "id": 279, + "id": 262, "name": "ColumnName" } }, { - "id": 281, + "id": 264, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The Postgres tsquery string to filter with." + "shortText": "The query text to match with" }, "type": { "type": "intrinsic", @@ -6838,34 +7097,40 @@ } }, { - "id": 282, + "id": 265, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, + "comment": { + "shortText": "Named parameters" + }, "type": { "type": "reflection", "declaration": { - "id": 283, + "id": 266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 284, + "id": 267, "name": "config", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "The text search configuration to use" + }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 374, + "line": 342, "character": 16 } ], @@ -6875,17 +7140,20 @@ } }, { - "id": 285, + "id": 268, "name": "type", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Change how the `query` text is interpreted\n" + }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 374, + "line": 342, "character": 33 } ], @@ -6912,7 +7180,7 @@ { "title": "Properties", "kind": 1024, - "children": [284, 285] + "children": [267, 268] } ] } @@ -6921,16 +7189,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6938,14 +7206,14 @@ } }, { - "id": 286, + "id": 269, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 287, + "id": 270, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6956,7 +7224,7 @@ } }, { - "id": 288, + "id": 271, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -6967,7 +7235,7 @@ } }, { - "id": 289, + "id": 272, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6977,14 +7245,14 @@ "type": { "type": "reflection", "declaration": { - "id": 290, + "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 291, + "id": 274, "name": "config", "kind": 1024, "kindString": "Property", @@ -6994,7 +7262,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 379, + "line": 347, "character": 16 } ], @@ -7004,7 +7272,7 @@ } }, { - "id": 292, + "id": 275, "name": "type", "kind": 1024, "kindString": "Property", @@ -7014,7 +7282,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 379, + "line": 347, "character": 33 } ], @@ -7041,7 +7309,7 @@ { "title": "Properties", "kind": 1024, - "children": [291, 292] + "children": [274, 275] } ] } @@ -7050,16 +7318,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7069,7 +7337,7 @@ ] }, { - "id": 378, + "id": 380, "name": "then", "kind": 2048, "kindString": "Method", @@ -7083,25 +7351,25 @@ ], "signatures": [ { - "id": 379, + "id": 381, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 380, + "id": 382, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7109,7 +7377,7 @@ } }, { - "id": 381, + "id": 383, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -7122,7 +7390,7 @@ ], "parameters": [ { - "id": 382, + "id": 384, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -7139,32 +7407,32 @@ { "type": "reflection", "declaration": { - "id": 383, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 384, + "id": 386, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 385, + "id": 387, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7177,7 +7445,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -7185,7 +7453,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -7203,7 +7471,7 @@ } }, { - "id": 386, + "id": 388, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -7220,21 +7488,21 @@ { "type": "reflection", "declaration": { - "id": 387, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 388, + "id": 390, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 389, + "id": 391, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -7250,7 +7518,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -7258,7 +7526,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -7284,12 +7552,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -7301,19 +7569,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 468, + "id": 473, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 467, + "id": 472, "name": "default.then" } }, { - "id": 376, + "id": 378, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -7327,7 +7595,7 @@ ], "signatures": [ { - "id": 377, + "id": 379, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -7338,16 +7606,16 @@ }, "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7355,14 +7623,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 466, + "id": 471, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 465, + "id": 470, "name": "default.throwOnError" } } @@ -7371,33 +7639,34 @@ { "title": "Constructors", "kind": 512, - "children": [112] + "children": [111] }, { "title": "Properties", "kind": 1024, - "children": [375, 367, 370, 365, 363, 366, 368, 369, 364] + "children": [377, 369, 372, 367, 365, 368, 370, 371, 366] }, { "title": "Methods", "kind": 2048, "children": [ - 343, 221, 213, 350, 133, 354, 293, 352, 149, 157, 189, 205, 197, 181, 330, 165, 173, - 303, 348, 141, 117, 127, 314, 269, 336, 261, 237, 245, 229, 253, 309, 346, 277, 378, 376 + 342, 204, 196, 349, 116, 353, 298, 351, 132, 140, 172, 188, 180, 164, 329, 148, 156, + 276, 347, 124, 282, 292, 313, 252, 335, 244, 212, 220, 228, 236, 363, 308, 345, 260, + 380, 378 ] } ], "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 31, + "line": 27, "character": 21 } ], "typeParameter": [ { - "id": 390, - "name": "Table", + "id": 392, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -7419,7 +7688,7 @@ } }, { - "id": 391, + "id": 393, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -7429,16 +7698,16 @@ "extendedTypes": [ { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7447,14 +7716,14 @@ ] }, { - "id": 46, + "id": 49, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 47, + "id": 50, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -7468,27 +7737,36 @@ ], "signatures": [ { - "id": 48, + "id": 51, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 49, - "name": "Table", + "id": 52, + "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "reference", - "name": "GenericTable" + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] } } ], "parameters": [ { - "id": 50, + "id": 53, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -7501,7 +7779,7 @@ } }, { - "id": 51, + "id": 54, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -7509,14 +7787,14 @@ "type": { "type": "reflection", "declaration": { - "id": 52, + "id": 55, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 55, + "id": 58, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -7533,34 +7811,45 @@ "type": { "type": "reflection", "declaration": { - "id": 56, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 57, + "id": 60, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 58, + "id": 61, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 59, + "id": 62, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -7595,7 +7884,7 @@ } }, { - "id": 53, + "id": 56, "name": "headers", "kind": 1024, "kindString": "Property", @@ -7627,7 +7916,7 @@ } }, { - "id": 54, + "id": 57, "name": "schema", "kind": 1024, "kindString": "Property", @@ -7651,7 +7940,7 @@ { "title": "Properties", "kind": 1024, - "children": [55, 53, 54] + "children": [58, 56, 57] } ] } @@ -7660,12 +7949,12 @@ ], "type": { "type": "reference", - "id": 46, + "id": 49, "typeArguments": [ { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } ], "name": "default" @@ -7674,7 +7963,7 @@ ] }, { - "id": 64, + "id": 67, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -7691,34 +7980,45 @@ "type": { "type": "reflection", "declaration": { - "id": 65, + "id": 68, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 66, + "id": 69, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 67, + "id": 70, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 68, + "id": 71, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -7753,7 +8053,7 @@ } }, { - "id": 61, + "id": 64, "name": "headers", "kind": 1024, "kindString": "Property", @@ -7783,7 +8083,7 @@ } }, { - "id": 62, + "id": 65, "name": "schema", "kind": 1024, "kindString": "Property", @@ -7803,7 +8103,7 @@ } }, { - "id": 63, + "id": 66, "name": "signal", "kind": 1024, "kindString": "Property", @@ -7825,7 +8125,7 @@ } }, { - "id": 60, + "id": 63, "name": "url", "kind": 1024, "kindString": "Property", @@ -7853,7 +8153,7 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 228, + "line": 296, "character": 2 } ], @@ -7865,15 +8165,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs a DELETE on the table." + "shortText": "Perform a DELETE on the table or view.", + "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "parameters": [ { "id": 106, - "name": "__namedParameters", + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { @@ -7892,12 +8197,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 233, + "line": 299, "character": 4 } ], @@ -7918,36 +8223,13 @@ } ] } - }, - { - "id": 109, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 235, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [108, 109] + "children": [108] } ] } @@ -7957,7 +8239,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -7967,8 +8249,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -7982,7 +8264,7 @@ ] }, { - "id": 78, + "id": 81, "name": "insert", "kind": 2048, "kindString": "Method", @@ -7990,23 +8272,24 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 86, + "line": 117, "character": 2 } ], "signatures": [ { - "id": 79, + "id": 82, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs an INSERT into the table." + "shortText": "Perform an INSERT into the table or view.", + "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { - "id": 80, + "id": 83, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -8031,27 +8314,27 @@ ], "parameters": [ { - "id": 81, + "id": 84, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert.\n" + "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" }, "type": { "type": "union", "types": [ { "type": "reference", - "id": 80, + "id": 83, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 80, + "id": 83, "name": "Row" } } @@ -8059,22 +8342,26 @@ } }, { - "id": 82, - "name": "__namedParameters", + "id": 85, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 83, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 84, + "id": 87, "name": "count", "kind": 1024, "kindString": "Property", @@ -8082,12 +8369,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 93, + "line": 122, "character": 6 } ], @@ -8108,36 +8395,13 @@ } ] } - }, - { - "id": 85, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 95, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [84, 85] + "children": [87] } ] } @@ -8147,7 +8411,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -8157,8 +8421,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -8172,7 +8436,7 @@ ] }, { - "id": 69, + "id": 72, "name": "select", "kind": 2048, "kindString": "Method", @@ -8180,23 +8444,23 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 36, + "line": 52, "character": 2 } ], "signatures": [ { - "id": 70, + "id": 73, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs vertical filtering with SELECT." + "shortText": "Perform a SELECT query on the table or view." }, "typeParameter": [ { - "id": 71, + "id": 74, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -8211,7 +8475,7 @@ } }, { - "id": 72, + "id": 75, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -8227,15 +8491,15 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { "type": "conditional", "checkType": { "type": "reference", - "id": 71, + "id": 74, "name": "Query" }, "extendsType": { @@ -8248,7 +8512,7 @@ }, "falseType": { "type": "reference", - "id": 71, + "id": 74, "name": "Query" } } @@ -8259,7 +8523,7 @@ ], "parameters": [ { - "id": 73, + "id": 76, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -8267,31 +8531,35 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas.\n" + "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", - "id": 71, + "id": 74, "name": "Query" } }, { - "id": 74, - "name": "__namedParameters", + "id": 77, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 75, + "id": 78, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, + "id": 80, "name": "count", "kind": 1024, "kindString": "Property", @@ -8299,12 +8567,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 48, + "line": 62, "character": 6 } ], @@ -8327,7 +8595,7 @@ } }, { - "id": 76, + "id": 79, "name": "head", "kind": 1024, "kindString": "Property", @@ -8335,12 +8603,12 @@ "isOptional": true }, "comment": { - "shortText": "When set to true, select will void data." + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 46, + "line": 61, "character": 6 } ], @@ -8354,7 +8622,7 @@ { "title": "Properties", "kind": 1024, - "children": [77, 76] + "children": [80, 79] } ] } @@ -8364,7 +8632,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -8374,13 +8642,13 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { "type": "reference", - "id": 72, + "id": 75, "name": "Result" } ], @@ -8390,7 +8658,7 @@ ] }, { - "id": 96, + "id": 97, "name": "update", "kind": 2048, "kindString": "Method", @@ -8398,23 +8666,24 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 188, + "line": 247, "character": 2 } ], "signatures": [ { - "id": 97, + "id": 98, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs an UPDATE on the table." + "shortText": "Perform an UPDATE on the table or view.", + "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "typeParameter": [ { - "id": 98, + "id": 99, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -8439,37 +8708,41 @@ ], "parameters": [ { - "id": 99, + "id": 100, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to update.\n" + "shortText": "The values to update with\n" }, "type": { "type": "reference", - "id": 98, + "id": 99, "name": "Row" } }, { - "id": 100, - "name": "__namedParameters", + "id": 101, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 102, + "id": 103, "name": "count", "kind": 1024, "kindString": "Property", @@ -8477,12 +8750,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 195, + "line": 252, "character": 6 } ], @@ -8503,36 +8776,13 @@ } ] } - }, - { - "id": 103, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 197, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [102, 103] + "children": [103] } ] } @@ -8542,7 +8792,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -8552,8 +8802,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -8567,7 +8817,7 @@ ] }, { - "id": 86, + "id": 88, "name": "upsert", "kind": 2048, "kindString": "Method", @@ -8575,23 +8825,24 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 137, + "line": 189, "character": 2 } ], "signatures": [ { - "id": 87, + "id": 89, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs an UPSERT into the table." + "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", + "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { - "id": 88, + "id": 90, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -8616,27 +8867,27 @@ ], "parameters": [ { - "id": 89, + "id": 91, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert.\n" + "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { "type": "union", "types": [ { "type": "reference", - "id": 88, + "id": 90, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 88, + "id": 90, "name": "Row" } } @@ -8644,22 +8895,26 @@ } }, { - "id": 90, - "name": "__namedParameters", + "id": 92, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 91, + "id": 93, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 93, + "id": 96, "name": "count", "kind": 1024, "kindString": "Property", @@ -8667,12 +8922,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 148, + "line": 198, "character": 6 } ], @@ -8695,7 +8950,7 @@ } }, { - "id": 94, + "id": 95, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", @@ -8703,12 +8958,12 @@ "isOptional": true }, "comment": { - "shortText": "Specifies if duplicate rows should be ignored and not inserted." + "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 150, + "line": 197, "character": 6 } ], @@ -8718,7 +8973,7 @@ } }, { - "id": 92, + "id": 94, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -8726,12 +8981,12 @@ "isOptional": true }, "comment": { - "shortText": "By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint." + "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 146, + "line": 196, "character": 6 } ], @@ -8739,36 +8994,13 @@ "type": "intrinsic", "name": "string" } - }, - { - "id": 95, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 152, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [93, 94, 92, 95] + "children": [96, 95, 94] } ] } @@ -8778,7 +9010,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -8788,8 +9020,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -8807,17 +9039,17 @@ { "title": "Constructors", "kind": 512, - "children": [47] + "children": [50] }, { "title": "Properties", "kind": 1024, - "children": [64, 61, 62, 63, 60] + "children": [67, 64, 65, 66, 63] }, { "title": "Methods", "kind": 2048, - "children": [104, 78, 69, 96, 86] + "children": [104, 81, 72, 97, 88] } ], "sources": [ @@ -8829,45 +9061,51 @@ ], "typeParameter": [ { - "id": 110, - "name": "Table", + "id": 109, + "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "reference", - "name": "GenericTable" + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] } } ] }, { - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, - "comment": { - "shortText": "Post-filters (transforms)" - }, "children": [ { - "id": 393, + "id": 395, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 394, + "id": 396, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 395, - "name": "Table", + "id": 397, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -8889,7 +9127,7 @@ } }, { - "id": 396, + "id": 398, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -8898,18 +9136,18 @@ ], "parameters": [ { - "id": 397, + "id": 399, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -8919,16 +9157,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -8936,19 +9174,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 483, + "id": 488, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 482, + "id": 487, "name": "default.constructor" } }, { - "id": 464, + "id": 469, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -8968,12 +9206,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 498, + "id": 503, "name": "default.allowEmpty" } }, { - "id": 456, + "id": 461, "name": "body", "kind": 1024, "kindString": "Property", @@ -8994,12 +9232,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 490, + "id": 495, "name": "default.body" } }, { - "id": 459, + "id": 464, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -9016,34 +9254,45 @@ "type": { "type": "reflection", "declaration": { - "id": 460, + "id": 465, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 461, + "id": 466, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 462, + "id": 467, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 463, + "id": 468, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -9078,12 +9327,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 493, + "id": 498, "name": "default.fetch" } }, { - "id": 454, + "id": 459, "name": "headers", "kind": 1024, "kindString": "Property", @@ -9115,12 +9364,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 488, + "id": 493, "name": "default.headers" } }, { - "id": 452, + "id": 457, "name": "method", "kind": 1024, "kindString": "Property", @@ -9161,12 +9410,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 486, + "id": 491, "name": "default.method" } }, { - "id": 455, + "id": 460, "name": "schema", "kind": 1024, "kindString": "Property", @@ -9187,12 +9436,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 489, + "id": 494, "name": "default.schema" } }, { - "id": 457, + "id": 462, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -9213,12 +9462,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 491, + "id": 496, "name": "default.shouldThrowOnError" } }, { - "id": 458, + "id": 463, "name": "signal", "kind": 1024, "kindString": "Property", @@ -9241,12 +9490,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 492, + "id": 497, "name": "default.signal" } }, { - "id": 453, + "id": 458, "name": "url", "kind": 1024, "kindString": "Property", @@ -9268,12 +9517,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 487, + "id": 492, "name": "default.url" } }, { - "id": 432, + "id": 434, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -9281,27 +9530,30 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 110, + "line": 124, "character": 2 } ], "signatures": [ { - "id": 433, + "id": 435, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the AbortSignal for the fetch request." + "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { - "id": 434, + "id": 436, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -9312,16 +9564,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -9331,7 +9583,7 @@ ] }, { - "id": 439, + "id": 441, "name": "csv", "kind": 2048, "kindString": "Method", @@ -9339,26 +9591,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 138, + "line": 155, "character": 2 } ], "signatures": [ { - "id": 440, + "id": 442, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to CSV." + "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "intrinsic", @@ -9376,7 +9628,7 @@ ] }, { - "id": 443, + "id": 445, "name": "explain", "kind": 2048, "kindString": "Method", @@ -9384,48 +9636,133 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 189, "character": 2 } ], "signatures": [ { - "id": 444, + "id": 446, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Obtains the EXPLAIN plan for this request." + "shortText": "Return `data` as the EXPLAIN plan for the query." }, "parameters": [ { - "id": 445, - "name": "__namedParameters", + "id": 447, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 446, + "id": 448, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 447, + "id": 449, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 167, + "line": 197, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 452, + "name": "buffers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on buffer usage\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 200, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 454, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 202, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 451, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 199, "character": 4 } ], @@ -9436,56 +9773,19 @@ }, { "id": 450, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 170, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 449, - "name": "settings", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 448, "name": "verbose", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 198, "character": 4 } ], @@ -9495,17 +9795,20 @@ } }, { - "id": 451, + "id": 453, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 171, + "line": 201, "character": 4 } ], @@ -9519,7 +9822,7 @@ { "title": "Properties", "kind": 1024, - "children": [447, 450, 449, 448, 451] + "children": [449, 452, 454, 451, 450, 453] } ] } @@ -9528,41 +9831,65 @@ } ], "type": { - "type": "reference", - "typeArguments": [ + "type": "union", + "types": [ { "type": "reference", - "id": 514, "typeArguments": [ { "type": "reference", + "id": 521, "typeArguments": [ { "type": "intrinsic", "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" } ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "name": "PostgrestSingleResponse" } ], - "name": "PostgrestResponse" + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 519, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + ] } } ] }, { - "id": 441, + "id": 443, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -9570,26 +9897,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 146, + "line": 163, "character": 2 } ], "signatures": [ { - "id": 442, + "id": 444, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to GeoJSON." + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", @@ -9619,7 +9946,7 @@ ] }, { - "id": 419, + "id": 421, "name": "limit", "kind": 2048, "kindString": "Method", @@ -9627,29 +9954,29 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 2 } ], "signatures": [ { - "id": 420, + "id": 422, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result with the specified `count`." + "shortText": "Limit the query result by `count`." }, "parameters": [ { - "id": 421, + "id": 423, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum no. of rows to limit to." + "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", @@ -9657,36 +9984,39 @@ } }, { - "id": 422, - "name": "foreignTable", + "id": 424, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 423, + "id": 425, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 424, + "id": 426, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 43 } ], @@ -9700,7 +10030,7 @@ { "title": "Properties", "kind": 1024, - "children": [424] + "children": [426] } ] } @@ -9710,16 +10040,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -9729,7 +10059,7 @@ ] }, { - "id": 437, + "id": 439, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -9737,30 +10067,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 129, + "line": 146, "character": 2 } ], "signatures": [ { - "id": 438, + "id": 440, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 518, + "id": 523, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -9775,7 +10106,7 @@ ] }, { - "id": 403, + "id": 405, "name": "order", "kind": 2048, "kindString": "Method", @@ -9783,23 +10114,24 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, + "line": 59, "character": 2 } ], "signatures": [ { - "id": 404, + "id": 406, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Orders the result with the specified `column`." + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" }, "typeParameter": [ { - "id": 405, + "id": 407, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -9812,49 +10144,55 @@ ], "parameters": [ { - "id": 406, + "id": 408, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order on." + "shortText": "The column to order by" }, "type": { "type": "reference", - "id": 316, + "id": 315, "name": "ColumnName" } }, { - "id": 407, + "id": 409, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, + "comment": { + "shortText": "Named parameters" + }, "type": { "type": "reflection", "declaration": { - "id": 408, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 409, + "id": 411, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 16 } ], @@ -9864,17 +10202,20 @@ } }, { - "id": 411, + "id": 413, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 59 } ], @@ -9884,17 +10225,20 @@ } }, { - "id": 410, + "id": 412, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 37 } ], @@ -9908,7 +10252,7 @@ { "title": "Properties", "kind": 1024, - "children": [409, 411, 410] + "children": [411, 413, 412] } ] } @@ -9917,16 +10261,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -9934,14 +10278,14 @@ } }, { - "id": 412, + "id": 414, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 413, + "id": 415, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -9952,7 +10296,7 @@ } }, { - "id": 414, + "id": 416, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -9962,14 +10306,14 @@ "type": { "type": "reflection", "declaration": { - "id": 415, + "id": 417, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 416, + "id": 418, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -9979,7 +10323,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 16 } ], @@ -9989,7 +10333,7 @@ } }, { - "id": 418, + "id": 420, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -9997,7 +10341,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 59 } ], @@ -10007,7 +10351,7 @@ } }, { - "id": 417, + "id": 419, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -10017,7 +10361,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 37 } ], @@ -10031,7 +10375,7 @@ { "title": "Properties", "kind": 1024, - "children": [416, 418, 417] + "children": [418, 420, 419] } ] } @@ -10040,16 +10384,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -10059,7 +10403,7 @@ ] }, { - "id": 425, + "id": 427, "name": "range", "kind": 2048, "kindString": "Method", @@ -10067,29 +10411,29 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 2 } ], "signatures": [ { - "id": 426, + "id": 428, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result to rows within the specified range, inclusive." + "shortText": "Limit the query result by `from` and `to` inclusively." }, "parameters": [ { - "id": 427, + "id": 429, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result, inclusive." + "shortText": "The starting index from which to limit the result" }, "type": { "type": "intrinsic", @@ -10097,13 +10441,13 @@ } }, { - "id": 428, + "id": 430, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result, inclusive." + "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", @@ -10111,36 +10455,39 @@ } }, { - "id": 429, - "name": "foreignTable", + "id": 431, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 430, + "id": 432, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 431, + "id": 433, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 54 } ], @@ -10154,7 +10501,7 @@ { "title": "Properties", "kind": 1024, - "children": [431] + "children": [433] } ] } @@ -10164,16 +10511,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -10183,7 +10530,51 @@ ] }, { - "id": 398, + "id": 455, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 229, + "character": 2 + } + ], + "signatures": [ + { + "id": 456, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 394, + "typeArguments": [ + { + "type": "reference", + "id": 397, + "name": "Row" + }, + { + "type": "reference", + "id": 398, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 400, "name": "select", "kind": 2048, "kindString": "Method", @@ -10197,17 +10588,18 @@ ], "signatures": [ { - "id": 399, + "id": 401, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs vertical filtering with SELECT." + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { - "id": 400, + "id": 402, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -10222,7 +10614,7 @@ } }, { - "id": 401, + "id": 403, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -10232,14 +10624,14 @@ "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" }, "extendsType": { @@ -10252,7 +10644,7 @@ }, "falseType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" } } @@ -10263,7 +10655,7 @@ ], "parameters": [ { - "id": 402, + "id": 404, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -10271,27 +10663,27 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas.\n" + "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" } } ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 312, + "id": 311, "name": "NewResult" } ], @@ -10301,7 +10693,7 @@ ] }, { - "id": 435, + "id": 437, "name": "single", "kind": 2048, "kindString": "Method", @@ -10309,30 +10701,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 119, + "line": 135, "character": 2 } ], "signatures": [ { - "id": 436, + "id": 438, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -10347,7 +10740,7 @@ ] }, { - "id": 467, + "id": 472, "name": "then", "kind": 2048, "kindString": "Method", @@ -10361,25 +10754,25 @@ ], "signatures": [ { - "id": 468, + "id": 473, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 469, + "id": 474, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -10387,7 +10780,7 @@ } }, { - "id": 470, + "id": 475, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -10400,7 +10793,7 @@ ], "parameters": [ { - "id": 471, + "id": 476, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -10417,32 +10810,32 @@ { "type": "reflection", "declaration": { - "id": 472, + "id": 477, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 473, + "id": 478, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 474, + "id": 479, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -10455,7 +10848,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -10463,7 +10856,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -10481,7 +10874,7 @@ } }, { - "id": 475, + "id": 480, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -10498,21 +10891,21 @@ { "type": "reflection", "declaration": { - "id": 476, + "id": 481, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 477, + "id": 482, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 478, + "id": 483, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -10528,7 +10921,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -10536,7 +10929,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -10562,12 +10955,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -10579,19 +10972,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 502, + "id": 507, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 501, + "id": 506, "name": "default.then" } }, { - "id": 465, + "id": 470, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -10605,7 +10998,7 @@ ], "signatures": [ { - "id": 466, + "id": 471, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -10616,16 +11009,16 @@ }, "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -10633,14 +11026,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 500, + "id": 505, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 499, + "id": 504, "name": "default.throwOnError" } } @@ -10649,30 +11042,30 @@ { "title": "Constructors", "kind": 512, - "children": [393] + "children": [395] }, { "title": "Properties", "kind": 1024, - "children": [464, 456, 459, 454, 452, 455, 457, 458, 453] + "children": [469, 461, 464, 459, 457, 460, 462, 463, 458] }, { "title": "Methods", "kind": 2048, - "children": [432, 439, 443, 441, 419, 437, 403, 425, 398, 435, 467, 465] + "children": [434, 441, 445, 443, 421, 439, 405, 427, 455, 400, 437, 472, 470] } ], "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 9, + "line": 5, "character": 21 } ], "typeParameter": [ { - "id": 479, - "name": "Table", + "id": 484, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -10694,7 +11087,7 @@ } }, { - "id": 480, + "id": 485, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -10704,11 +11097,11 @@ "extendedTypes": [ { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -10718,13 +11111,13 @@ "extendedBy": [ { "type": "reference", - "id": 111, + "id": 110, "name": "PostgrestFilterBuilder" } ] }, { - "id": 520, + "id": 525, "name": "PostgrestError", "kind": 4194304, "kindString": "Type alias", @@ -10743,14 +11136,14 @@ "type": { "type": "reflection", "declaration": { - "id": 521, + "id": 526, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 525, + "id": 530, "name": "code", "kind": 1024, "kindString": "Property", @@ -10768,7 +11161,7 @@ } }, { - "id": 523, + "id": 528, "name": "details", "kind": 1024, "kindString": "Property", @@ -10786,7 +11179,7 @@ } }, { - "id": 524, + "id": 529, "name": "hint", "kind": 1024, "kindString": "Property", @@ -10804,7 +11197,7 @@ } }, { - "id": 522, + "id": 527, "name": "message", "kind": 1024, "kindString": "Property", @@ -10826,7 +11219,7 @@ { "title": "Properties", "kind": 1024, - "children": [525, 523, 524, 522] + "children": [530, 528, 529, 527] } ], "sources": [ @@ -10840,7 +11233,7 @@ } }, { - "id": 518, + "id": 523, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -10854,7 +11247,7 @@ ], "typeParameter": [ { - "id": 519, + "id": 524, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -10863,14 +11256,14 @@ ], "type": { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 519, + "id": 524, "name": "T" }, { @@ -10884,7 +11277,7 @@ } }, { - "id": 514, + "id": 519, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", @@ -10898,7 +11291,7 @@ ], "typeParameter": [ { - "id": 515, + "id": 520, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -10913,7 +11306,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 520, "name": "T" } ], @@ -10927,7 +11320,7 @@ } }, { - "id": 516, + "id": 521, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -10941,7 +11334,7 @@ ], "typeParameter": [ { - "id": 517, + "id": 522, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -10956,7 +11349,7 @@ "typeArguments": [ { "type": "reference", - "id": 517, + "id": 522, "name": "T" } ], @@ -10974,12 +11367,12 @@ { "title": "Classes", "kind": 128, - "children": [481, 1, 111, 46, 392] + "children": [486, 1, 110, 49, 394] }, { "title": "Type Aliases", "kind": 4194304, - "children": [520, 518, 514, 516] + "children": [525, 523, 519, 521] } ], "sources": [ diff --git a/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json b/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json index 08f0dd7d378..41afb1bd394 100644 --- a/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json +++ b/spec/enrichments/tsdoc_v2/postgrest_dereferenced.json @@ -7,7 +7,7 @@ "originalName": "", "children": [ { - "id": 481, + "id": 486, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -16,7 +16,7 @@ }, "children": [ { - "id": 482, + "id": 487, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -30,14 +30,14 @@ ], "signatures": [ { - "id": 483, + "id": 488, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 484, + "id": 489, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -46,24 +46,24 @@ ], "parameters": [ { - "id": 485, + "id": 490, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], "name": "default", "dereferenced": { - "id": 481, + "id": 486, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -75,17 +75,17 @@ { "title": "Constructors", "kind": 512, - "children": [482] + "children": [487] }, { "title": "Properties", "kind": 1024, - "children": [498, 490, 493, 488, 486, 489, 491, 492, 487] + "children": [503, 495, 498, 493, 491, 494, 496, 497, 492] }, { "title": "Methods", "kind": 2048, - "children": [501, 499] + "children": [506, 504] } ], "sources": [ @@ -97,7 +97,7 @@ ], "typeParameter": [ { - "id": 513, + "id": 518, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -107,7 +107,7 @@ "extendedBy": [ { "type": "reference", - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder" } ], @@ -117,11 +117,11 @@ "typeArguments": [ { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -139,11 +139,11 @@ ], "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -153,7 +153,7 @@ ] }, { - "id": 498, + "id": 503, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -173,7 +173,7 @@ } }, { - "id": 490, + "id": 495, "name": "body", "kind": 1024, "kindString": "Property", @@ -194,7 +194,7 @@ } }, { - "id": 493, + "id": 498, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -211,34 +211,45 @@ "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 499, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 495, + "id": 500, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 501, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 497, + "id": 502, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -273,7 +284,7 @@ } }, { - "id": 488, + "id": 493, "name": "headers", "kind": 1024, "kindString": "Property", @@ -305,7 +316,7 @@ } }, { - "id": 486, + "id": 491, "name": "method", "kind": 1024, "kindString": "Property", @@ -346,7 +357,7 @@ } }, { - "id": 489, + "id": 494, "name": "schema", "kind": 1024, "kindString": "Property", @@ -367,7 +378,7 @@ } }, { - "id": 491, + "id": 496, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -388,7 +399,7 @@ "defaultValue": "false" }, { - "id": 492, + "id": 497, "name": "signal", "kind": 1024, "kindString": "Property", @@ -411,7 +422,7 @@ } }, { - "id": 487, + "id": 492, "name": "url", "kind": 1024, "kindString": "Property", @@ -433,7 +444,7 @@ } }, { - "id": 501, + "id": 506, "name": "then", "kind": 2048, "kindString": "Method", @@ -447,25 +458,25 @@ ], "signatures": [ { - "id": 502, + "id": 507, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 503, + "id": 508, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -473,7 +484,7 @@ } }, { - "id": 504, + "id": 509, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -486,7 +497,7 @@ ], "parameters": [ { - "id": 505, + "id": 510, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -503,32 +514,32 @@ { "type": "reflection", "declaration": { - "id": 506, + "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 507, + "id": 512, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 508, + "id": 513, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -541,7 +552,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -549,7 +560,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -567,7 +578,7 @@ } }, { - "id": 509, + "id": 514, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -584,21 +595,21 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 515, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 511, + "id": 516, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 512, + "id": 517, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -614,7 +625,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -622,7 +633,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -648,12 +659,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -675,7 +686,7 @@ } }, { - "id": 499, + "id": 504, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -689,7 +700,7 @@ ], "signatures": [ { - "id": 500, + "id": 505, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -700,11 +711,11 @@ }, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -718,17 +729,17 @@ { "title": "Constructors", "kind": 512, - "children": [482] + "children": [487] }, { "title": "Properties", "kind": 1024, - "children": [498, 490, 493, 488, 486, 489, 491, 492, 487] + "children": [503, 495, 498, 493, 491, 494, 496, 497, 492] }, { "title": "Methods", "kind": 2048, - "children": [501, 499] + "children": [506, 504] } ], "sources": [ @@ -740,7 +751,7 @@ ], "typeParameter": [ { - "id": 513, + "id": 518, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -750,7 +761,7 @@ "extendedBy": [ { "type": "reference", - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder" } ], @@ -760,11 +771,11 @@ "typeArguments": [ { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -783,6 +794,9 @@ "kind": 128, "kindString": "Class", "flags": {}, + "comment": { + "shortText": "PostgREST client." + }, "children": [ { "id": 2, @@ -793,7 +807,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 29, + "line": 41, "character": 2 } ], @@ -923,7 +937,7 @@ "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "URL of the PostgREST endpoint." + "shortText": "URL of the PostgREST endpoint" }, "type": { "type": "intrinsic", @@ -932,10 +946,14 @@ }, { "id": 8, - "name": "__namedParameters", + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { @@ -956,7 +974,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 38, + "line": 50, "character": 6 } ], @@ -975,6 +993,9 @@ "kind": 4096, "kindString": "Call signature", "flags": {}, + "comment": { + "shortText": "Custom fetch\n" + }, "parameters": [ { "id": 15, @@ -983,10 +1004,21 @@ "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { @@ -1032,10 +1064,13 @@ "flags": { "isOptional": true }, + "comment": { + "shortText": "Custom headers" + }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 36, + "line": 48, "character": 6 } ], @@ -1064,10 +1099,13 @@ "flags": { "isOptional": true }, + "comment": { + "shortText": "Postgres schema to switch to" + }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 37, + "line": 49, "character": 6 } ], @@ -1126,7 +1164,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 19, + "line": 29, "character": 2 } ], @@ -1153,10 +1191,21 @@ "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { @@ -1203,7 +1252,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 17, + "line": 27, "character": 2 } ], @@ -1235,7 +1284,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 18, + "line": 28, "character": 2 } ], @@ -1254,7 +1303,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 16, + "line": 26, "character": 2 } ], @@ -1272,7 +1321,7 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 52, + "line": 64, "character": 2 } ], @@ -1284,7 +1333,7 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Perform a table operation." + "shortText": "Perform a query on a table or a view." }, "typeParameter": [ { @@ -1313,12 +1362,12 @@ "parameters": [ { "id": 29, - "name": "table", + "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The table name to operate on.\n" + "shortText": "The table or view name to query\n" }, "type": { "type": "reference", @@ -1330,7 +1379,7 @@ ], "type": { "type": "reference", - "id": 46, + "id": 49, "typeArguments": [ { "type": "reference", @@ -1347,10 +1396,68 @@ "kind": 4096, "kindString": "Call signature", "flags": {}, - "parameters": [ + "typeParameter": [ { "id": 31, - "name": "table", + "name": "ViewName", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 32, + "name": "View", + "kind": 131072, + "kindString": "Type parameter", + "flags": {}, + "type": { + "type": "reference", + "name": "GenericView" + } + } + ], + "parameters": [ + { + "id": 33, + "name": "relation", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "type": { + "type": "reference", + "id": 31, + "name": "ViewName", + "dereferenced": {} + } + } + ], + "type": { + "type": "reference", + "id": 49, + "typeArguments": [ + { + "type": "reference", + "id": 32, + "name": "View" + } + ], + "name": "default" + } + }, + { + "id": 34, + "name": "from", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "parameters": [ + { + "id": 35, + "name": "relation", "kind": 32768, "kindString": "Parameter", "flags": {}, @@ -1362,7 +1469,7 @@ ], "type": { "type": "reference", - "id": 46, + "id": 49, "typeArguments": [ { "type": "intrinsic", @@ -1375,7 +1482,7 @@ ] }, { - "id": 32, + "id": 36, "name": "rpc", "kind": 2048, "kindString": "Method", @@ -1383,13 +1490,13 @@ "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 73, + "line": 102, "character": 2 } ], "signatures": [ { - "id": 33, + "id": 37, "name": "rpc", "kind": 4096, "kindString": "Call signature", @@ -1399,7 +1506,7 @@ }, "typeParameter": [ { - "id": 34, + "id": 38, "name": "FunctionName", "kind": 131072, "kindString": "Type parameter", @@ -1410,7 +1517,7 @@ } }, { - "id": 35, + "id": 39, "name": "Function_", "kind": 131072, "kindString": "Type parameter", @@ -1423,29 +1530,29 @@ ], "parameters": [ { - "id": 36, + "id": 40, "name": "fn", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The function name to call." + "shortText": "The function name to call" }, "type": { "type": "reference", - "id": 34, + "id": 38, "name": "FunctionName", "dereferenced": {} } }, { - "id": 37, + "id": 41, "name": "args", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The parameters to pass to the function call." + "shortText": "The arguments to pass to the function call" }, "type": { "type": "indexedAccess", @@ -1455,33 +1562,33 @@ }, "objectType": { "type": "reference", - "id": 35, + "id": 39, "name": "Function_" } }, "defaultValue": "{}" }, { - "id": 38, + "id": 42, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "Named parameters.\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 39, + "id": 43, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 41, + "id": 45, "name": "count", "kind": 1024, "kindString": "Property", @@ -1489,12 +1596,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 87, + "line": 113, "character": 6 } ], @@ -1517,7 +1624,7 @@ } }, { - "id": 40, + "id": 44, "name": "head", "kind": 1024, "kindString": "Property", @@ -1525,35 +1632,12 @@ "isOptional": true }, "comment": { - "shortText": "When set to true, no data will be returned." + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count." }, "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 85, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 42, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestClient.ts", - "line": 89, + "line": 112, "character": 6 } ], @@ -1567,7 +1651,7 @@ { "title": "Properties", "kind": 1024, - "children": [41, 40, 42] + "children": [45, 44] } ] } @@ -1577,7 +1661,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "conditional", @@ -1589,7 +1673,7 @@ }, "objectType": { "type": "reference", - "id": 35, + "id": 39, "name": "Function_" } }, @@ -1665,7 +1749,7 @@ }, "objectType": { "type": "reference", - "id": 35, + "id": 39, "name": "Function_" } } @@ -1690,34 +1774,40 @@ { "title": "Methods", "kind": 2048, - "children": [25, 32] + "children": [25, 36] } ], "sources": [ { "fileName": "src/PostgrestClient.ts", - "line": 7, + "line": 17, "character": 21 } ], "typeParameter": [ { - "id": 43, + "id": 46, "name": "Database", "kind": 131072, "kindString": "Type parameter", "flags": {}, + "comment": { + "shortText": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)\n" + }, "default": { "type": "intrinsic", "name": "any" } }, { - "id": 44, + "id": 47, "name": "SchemaName", "kind": 131072, "kindString": "Type parameter", "flags": {}, + "comment": { + "shortText": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n`\"public\"`, this must be supplied manually.\n" + }, "type": { "type": "intersection", "types": [ @@ -1776,7 +1866,7 @@ } }, { - "id": 45, + "id": 48, "name": "Schema", "kind": 131072, "kindString": "Type parameter", @@ -1826,29 +1916,29 @@ ] }, { - "id": 111, + "id": 110, "name": "PostgrestFilterBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 112, + "id": 111, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 113, + "id": 112, "name": "new PostgrestFilterBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 114, - "name": "Table", + "id": 113, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -1870,7 +1960,7 @@ } }, { - "id": 115, + "id": 114, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -1879,24 +1969,24 @@ ], "parameters": [ { - "id": 116, + "id": 115, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], "name": "default", "dereferenced": { - "id": 481, + "id": 486, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -1905,7 +1995,7 @@ }, "children": [ { - "id": 482, + "id": 487, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -1919,14 +2009,14 @@ ], "signatures": [ { - "id": 483, + "id": 488, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 484, + "id": 489, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -1935,18 +2025,18 @@ ], "parameters": [ { - "id": 485, + "id": 490, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -1957,11 +2047,11 @@ ], "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -1971,7 +2061,7 @@ ] }, { - "id": 498, + "id": 503, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -1991,7 +2081,7 @@ } }, { - "id": 490, + "id": 495, "name": "body", "kind": 1024, "kindString": "Property", @@ -2012,7 +2102,7 @@ } }, { - "id": 493, + "id": 498, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -2029,34 +2119,45 @@ "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 499, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 495, + "id": 500, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 501, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 497, + "id": 502, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2091,7 +2192,7 @@ } }, { - "id": 488, + "id": 493, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2123,7 +2224,7 @@ } }, { - "id": 486, + "id": 491, "name": "method", "kind": 1024, "kindString": "Property", @@ -2164,7 +2265,7 @@ } }, { - "id": 489, + "id": 494, "name": "schema", "kind": 1024, "kindString": "Property", @@ -2185,7 +2286,7 @@ } }, { - "id": 491, + "id": 496, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -2206,7 +2307,7 @@ "defaultValue": "false" }, { - "id": 492, + "id": 497, "name": "signal", "kind": 1024, "kindString": "Property", @@ -2229,7 +2330,7 @@ } }, { - "id": 487, + "id": 492, "name": "url", "kind": 1024, "kindString": "Property", @@ -2251,7 +2352,7 @@ } }, { - "id": 501, + "id": 506, "name": "then", "kind": 2048, "kindString": "Method", @@ -2265,25 +2366,25 @@ ], "signatures": [ { - "id": 502, + "id": 507, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 503, + "id": 508, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -2291,7 +2392,7 @@ } }, { - "id": 504, + "id": 509, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -2304,7 +2405,7 @@ ], "parameters": [ { - "id": 505, + "id": 510, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -2321,32 +2422,32 @@ { "type": "reflection", "declaration": { - "id": 506, + "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 507, + "id": 512, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 508, + "id": 513, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -2359,7 +2460,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -2367,7 +2468,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -2385,7 +2486,7 @@ } }, { - "id": 509, + "id": 514, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -2402,21 +2503,21 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 515, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 511, + "id": 516, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 512, + "id": 517, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -2432,7 +2533,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -2440,7 +2541,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -2466,12 +2567,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -2493,7 +2594,7 @@ } }, { - "id": 499, + "id": 504, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -2507,7 +2608,7 @@ ], "signatures": [ { - "id": 500, + "id": 505, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -2518,11 +2619,11 @@ }, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -2536,17 +2637,17 @@ { "title": "Constructors", "kind": 512, - "children": [482] + "children": [487] }, { "title": "Properties", "kind": 1024, - "children": [498, 490, 493, 488, 486, 489, 491, 492, 487] + "children": [503, 495, 498, 493, 491, 494, 496, 497, 492] }, { "title": "Methods", "kind": 2048, - "children": [501, 499] + "children": [506, 504] } ], "sources": [ @@ -2558,7 +2659,7 @@ ], "typeParameter": [ { - "id": 513, + "id": 518, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -2568,7 +2669,7 @@ "extendedBy": [ { "type": "reference", - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder" } ], @@ -2578,11 +2679,11 @@ "typeArguments": [ { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -2600,16 +2701,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -2617,19 +2718,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 394, + "id": 396, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 393, + "id": 395, "name": "default.constructor" } }, { - "id": 375, + "id": 377, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -2649,12 +2750,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 464, + "id": 469, "name": "default.allowEmpty" } }, { - "id": 367, + "id": 369, "name": "body", "kind": 1024, "kindString": "Property", @@ -2675,12 +2776,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 456, + "id": 461, "name": "default.body" } }, { - "id": 370, + "id": 372, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -2697,34 +2798,45 @@ "type": { "type": "reflection", "declaration": { - "id": 371, + "id": 373, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 372, + "id": 374, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 373, + "id": 375, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 374, + "id": 376, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -2759,12 +2871,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 459, + "id": 464, "name": "default.fetch" } }, { - "id": 365, + "id": 367, "name": "headers", "kind": 1024, "kindString": "Property", @@ -2796,12 +2908,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 454, + "id": 459, "name": "default.headers" } }, { - "id": 363, + "id": 365, "name": "method", "kind": 1024, "kindString": "Property", @@ -2842,12 +2954,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 452, + "id": 457, "name": "default.method" } }, { - "id": 366, + "id": 368, "name": "schema", "kind": 1024, "kindString": "Property", @@ -2868,12 +2980,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 455, + "id": 460, "name": "default.schema" } }, { - "id": 368, + "id": 370, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -2894,12 +3006,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 457, + "id": 462, "name": "default.shouldThrowOnError" } }, { - "id": 369, + "id": 371, "name": "signal", "kind": 1024, "kindString": "Property", @@ -2922,12 +3034,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 458, + "id": 463, "name": "default.signal" } }, { - "id": 364, + "id": 366, "name": "url", "kind": 1024, "kindString": "Property", @@ -2949,12 +3061,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 453, + "id": 458, "name": "default.url" } }, { - "id": 343, + "id": 342, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -2962,27 +3074,30 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 110, + "line": 124, "character": 2 } ], "signatures": [ { - "id": 344, + "id": 343, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the AbortSignal for the fetch request." + "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { - "id": 345, + "id": 344, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -2993,16 +3108,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3010,19 +3125,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 433, + "id": 435, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", - "id": 432, + "id": 434, "name": "default.abortSignal" } }, { - "id": 221, + "id": 204, "name": "containedBy", "kind": 2048, "kindString": "Method", @@ -3030,23 +3145,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 250, + "line": 214, "character": 2 } ], "signatures": [ { - "id": 222, + "id": 205, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose json, array, or range value on the stated `column` is\ncontained by the specified `value`." + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in `column` is contained by `value`." }, "typeParameter": [ { - "id": 223, + "id": 206, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3059,29 +3174,29 @@ ], "parameters": [ { - "id": 224, + "id": 207, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", - "id": 223, + "id": 206, "name": "ColumnName", "dereferenced": {} } }, { - "id": 225, + "id": 208, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", @@ -3112,13 +3227,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 223, + "id": 206, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -3128,16 +3243,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3145,14 +3260,14 @@ } }, { - "id": 226, + "id": 209, "name": "containedBy", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 227, + "id": 210, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3163,7 +3278,7 @@ } }, { - "id": 228, + "id": 211, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3175,6 +3290,13 @@ "type": "intrinsic", "name": "string" }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, { "type": "reference", "typeArguments": [ @@ -3190,13 +3312,6 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } } ] } @@ -3204,16 +3319,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3223,7 +3338,7 @@ ] }, { - "id": 213, + "id": 196, "name": "contains", "kind": 2048, "kindString": "Method", @@ -3231,23 +3346,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 223, + "line": 187, "character": 2 } ], "signatures": [ { - "id": 214, + "id": 197, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose json, array, or range value on the stated `column`\ncontains the values specified in `value`." + "shortText": "Only relevant for jsonb, array, and range columns. Match only rows where\n`column` contains every element appearing in `value`." }, "typeParameter": [ { - "id": 215, + "id": 198, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3260,29 +3375,29 @@ ], "parameters": [ { - "id": 216, + "id": 199, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The jsonb, array, or range column to filter on" }, "type": { "type": "reference", - "id": 215, + "id": 198, "name": "ColumnName", "dereferenced": {} } }, { - "id": 217, + "id": 200, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The jsonb, array, or range value to filter with\n" }, "type": { "type": "union", @@ -3313,13 +3428,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 215, + "id": 198, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -3329,16 +3444,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3346,14 +3461,14 @@ } }, { - "id": 218, + "id": 201, "name": "contains", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 219, + "id": 202, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3364,7 +3479,7 @@ } }, { - "id": 220, + "id": 203, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3376,6 +3491,13 @@ "type": "intrinsic", "name": "string" }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, { "type": "reference", "typeArguments": [ @@ -3391,13 +3513,6 @@ "qualifiedName": "Record", "package": "typescript", "name": "Record" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } } ] } @@ -3405,16 +3520,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3424,7 +3539,7 @@ ] }, { - "id": 350, + "id": 349, "name": "csv", "kind": 2048, "kindString": "Method", @@ -3432,26 +3547,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 138, + "line": 155, "character": 2 } ], "signatures": [ { - "id": 351, + "id": 350, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to CSV." + "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "intrinsic", @@ -3467,19 +3582,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 440, + "id": 442, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", - "id": 439, + "id": 441, "name": "default.csv" } }, { - "id": 133, + "id": 116, "name": "eq", "kind": 2048, "kindString": "Method", @@ -3487,23 +3602,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 72, + "line": 39, "character": 2 } ], "signatures": [ { - "id": 134, + "id": 117, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` exactly matches the\nspecified `value`." + "shortText": "Match only rows where `column` is equal to `value`.", + "text": "To check if the value of `column` is NULL, you should use `.is()` instead.\n" }, "typeParameter": [ { - "id": 135, + "id": 118, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3516,57 +3632,57 @@ ], "parameters": [ { - "id": 136, + "id": 119, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 135, + "id": 118, "name": "ColumnName", "dereferenced": {} } }, { - "id": 137, + "id": 120, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 135, + "id": 118, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3574,14 +3690,14 @@ } }, { - "id": 138, + "id": 121, "name": "eq", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 139, + "id": 122, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -3592,7 +3708,7 @@ } }, { - "id": 140, + "id": 123, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -3605,16 +3721,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -3624,7 +3740,7 @@ ] }, { - "id": 354, + "id": 353, "name": "explain", "kind": 2048, "kindString": "Method", @@ -3632,68 +3748,55 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 189, "character": 2 } ], "signatures": [ { - "id": 355, + "id": 354, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Obtains the EXPLAIN plan for this request." + "shortText": "Return `data` as the EXPLAIN plan for the query." }, "parameters": [ { - "id": 356, - "name": "__namedParameters", + "id": 355, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 357, + "id": 356, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 358, + "id": 357, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 167, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 361, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 170, + "line": 197, "character": 4 } ], @@ -3704,36 +3807,19 @@ }, { "id": 360, - "name": "settings", + "name": "buffers", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 359, - "name": "verbose", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true + "comment": { + "shortText": "If `true`, include information on buffer usage\n" }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 200, "character": 4 } ], @@ -3744,16 +3830,97 @@ }, { "id": 362, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 202, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 359, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 199, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 358, + "name": "verbose", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 198, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 361, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 171, + "line": 201, "character": 4 } ], @@ -3767,7 +3934,7 @@ { "title": "Properties", "kind": 1024, - "children": [358, 361, 360, 359, 362] + "children": [357, 360, 362, 359, 358, 361] } ] } @@ -3776,51 +3943,75 @@ } ], "type": { - "type": "reference", - "typeArguments": [ + "type": "union", + "types": [ { "type": "reference", - "id": 514, "typeArguments": [ { "type": "reference", + "id": 521, "typeArguments": [ { "type": "intrinsic", "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" } ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "name": "PostgrestSingleResponse" } ], - "name": "PostgrestResponse" + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 519, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + ] }, "inheritedFrom": { "type": "reference", - "id": 444, + "id": 446, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", - "id": 443, + "id": 445, "name": "default.explain" } }, { - "id": 293, + "id": 298, "name": "filter", "kind": 2048, "kindString": "Method", @@ -3828,23 +4019,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 406, + "line": 439, "character": 2 } ], "signatures": [ { - "id": 294, + "id": 299, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose `column` satisfies the filter." + "shortText": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { - "id": 295, + "id": 300, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -3857,29 +4049,29 @@ ], "parameters": [ { - "id": 296, + "id": 301, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 295, + "id": 300, "name": "ColumnName", "dereferenced": {} } }, { - "id": 297, + "id": 302, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with." + "shortText": "The operator to filter with, following PostgREST syntax" }, "type": { "type": "union", @@ -3980,13 +4172,13 @@ } }, { - "id": 298, + "id": 303, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "intrinsic", @@ -3996,16 +4188,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4013,14 +4205,14 @@ } }, { - "id": 299, + "id": 304, "name": "filter", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 300, + "id": 305, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4031,7 +4223,7 @@ } }, { - "id": 301, + "id": 306, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -4042,7 +4234,7 @@ } }, { - "id": 302, + "id": 307, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4055,16 +4247,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4074,7 +4266,7 @@ ] }, { - "id": 352, + "id": 351, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -4082,26 +4274,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 146, + "line": 163, "character": 2 } ], "signatures": [ { - "id": 353, + "id": 352, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to GeoJSON." + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", @@ -4129,19 +4321,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 442, + "id": 444, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", - "id": 441, + "id": 443, "name": "default.geojson" } }, { - "id": 149, + "id": 132, "name": "gt", "kind": 2048, "kindString": "Method", @@ -4149,23 +4341,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 100, + "line": 65, "character": 2 } ], "signatures": [ { - "id": 150, + "id": 133, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is greater than the\nspecified `value`." + "shortText": "Match only rows where `column` is greater than `value`." }, "typeParameter": [ { - "id": 151, + "id": 134, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4178,57 +4370,57 @@ ], "parameters": [ { - "id": 152, + "id": 135, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 151, + "id": 134, "name": "ColumnName", "dereferenced": {} } }, { - "id": 153, + "id": 136, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 151, + "id": 134, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4236,14 +4428,14 @@ } }, { - "id": 154, + "id": 137, "name": "gt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 155, + "id": 138, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4254,7 +4446,7 @@ } }, { - "id": 156, + "id": 139, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4267,16 +4459,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4286,7 +4478,7 @@ ] }, { - "id": 157, + "id": 140, "name": "gte", "kind": 2048, "kindString": "Method", @@ -4294,23 +4486,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 114, + "line": 78, "character": 2 } ], "signatures": [ { - "id": 158, + "id": 141, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is greater than or\nequal to the specified `value`." + "shortText": "Match only rows where `column` is greater than or equal to `value`." }, "typeParameter": [ { - "id": 159, + "id": 142, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4323,57 +4515,57 @@ ], "parameters": [ { - "id": 160, + "id": 143, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 159, + "id": 142, "name": "ColumnName", "dereferenced": {} } }, { - "id": 161, + "id": 144, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 159, + "id": 142, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4381,14 +4573,14 @@ } }, { - "id": 162, + "id": 145, "name": "gte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 163, + "id": 146, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4399,7 +4591,7 @@ } }, { - "id": 164, + "id": 147, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4412,16 +4604,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4431,7 +4623,7 @@ ] }, { - "id": 189, + "id": 172, "name": "ilike", "kind": 2048, "kindString": "Method", @@ -4439,23 +4631,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 170, + "line": 130, "character": 2 } ], "signatures": [ { - "id": 190, + "id": 173, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case insensitive)." + "shortText": "Match only rows where `column` matches `pattern` case-insensitively." }, "typeParameter": [ { - "id": 191, + "id": 174, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4468,29 +4660,29 @@ ], "parameters": [ { - "id": 192, + "id": 175, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 191, + "id": 174, "name": "ColumnName", "dereferenced": {} } }, { - "id": 193, + "id": 176, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to filter with.\n" + "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", @@ -4500,16 +4692,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4517,14 +4709,14 @@ } }, { - "id": 194, + "id": 177, "name": "ilike", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 195, + "id": 178, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4535,7 +4727,7 @@ } }, { - "id": 196, + "id": 179, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -4548,16 +4740,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4567,7 +4759,7 @@ ] }, { - "id": 205, + "id": 188, "name": "in", "kind": 2048, "kindString": "Method", @@ -4575,23 +4767,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 201, + "line": 165, "character": 2 } ], "signatures": [ { - "id": 206, + "id": 189, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is found on the\nspecified `values`." + "shortText": "Match only rows where `column` is included in the `values` array." }, "typeParameter": [ { - "id": 207, + "id": 190, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4604,29 +4796,29 @@ ], "parameters": [ { - "id": 208, + "id": 191, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 207, + "id": 190, "name": "ColumnName", "dereferenced": {} } }, { - "id": 209, + "id": 192, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to filter with.\n" + "shortText": "The values array to filter with\n" }, "type": { "type": "array", @@ -4634,13 +4826,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 207, + "id": 190, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -4648,16 +4840,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4665,14 +4857,14 @@ } }, { - "id": 210, + "id": 193, "name": "in", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 211, + "id": 194, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4683,7 +4875,7 @@ } }, { - "id": 212, + "id": 195, "name": "values", "kind": 32768, "kindString": "Parameter", @@ -4699,16 +4891,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4718,7 +4910,7 @@ ] }, { - "id": 197, + "id": 180, "name": "is", "kind": 2048, "kindString": "Method", @@ -4726,23 +4918,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 184, + "line": 149, "character": 2 } ], "signatures": [ { - "id": 198, + "id": 181, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "A check for exact equality (null, true, false), finds all rows whose\nvalue on the stated `column` exactly match the specified `value`." + "shortText": "Match only rows where `column` IS `value`.", + "text": "For non-boolean columns, this is only relevant for checking if the value of\n`column` is NULL by setting `value` to `null`.\n\nFor boolean columns, you can also set `value` to `true` or `false` and it\nwill behave the same way as `.eq()`.\n" }, "typeParameter": [ { - "id": 199, + "id": 182, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4755,29 +4948,29 @@ ], "parameters": [ { - "id": 200, + "id": 183, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName", "dereferenced": {} } }, { - "id": 201, + "id": 184, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "intersection", @@ -4789,13 +4982,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } }, { @@ -4811,13 +5004,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } }, { @@ -4833,13 +5026,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 199, + "id": 182, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } }, { @@ -4854,16 +5047,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4871,14 +5064,14 @@ } }, { - "id": 202, + "id": 185, "name": "is", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 203, + "id": 186, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -4889,7 +5082,7 @@ } }, { - "id": 204, + "id": 187, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -4911,16 +5104,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -4930,7 +5123,7 @@ ] }, { - "id": 181, + "id": 164, "name": "like", "kind": 2048, "kindString": "Method", @@ -4938,23 +5131,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 156, + "line": 117, "character": 2 } ], "signatures": [ { - "id": 182, + "id": 165, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value in the stated `column` matches the supplied\n`pattern` (case sensitive)." + "shortText": "Match only rows where `column` matches `pattern` case-sensitively." }, "typeParameter": [ { - "id": 183, + "id": 166, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -4967,29 +5160,29 @@ ], "parameters": [ { - "id": 184, + "id": 167, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 183, + "id": 166, "name": "ColumnName", "dereferenced": {} } }, { - "id": 185, + "id": 168, "name": "pattern", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The pattern to filter with.\n" + "shortText": "The pattern to match with\n" }, "type": { "type": "intrinsic", @@ -4999,16 +5192,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5016,14 +5209,14 @@ } }, { - "id": 186, + "id": 169, "name": "like", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 187, + "id": 170, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5034,7 +5227,7 @@ } }, { - "id": 188, + "id": 171, "name": "pattern", "kind": 32768, "kindString": "Parameter", @@ -5047,16 +5240,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5066,7 +5259,7 @@ ] }, { - "id": 330, + "id": 329, "name": "limit", "kind": 2048, "kindString": "Method", @@ -5074,29 +5267,29 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 2 } ], "signatures": [ { - "id": 331, + "id": 330, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result with the specified `count`." + "shortText": "Limit the query result by `count`." }, "parameters": [ { - "id": 332, + "id": 331, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum no. of rows to limit to." + "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", @@ -5104,36 +5297,39 @@ } }, { - "id": 333, - "name": "foreignTable", + "id": 332, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 334, + "id": 333, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 335, + "id": 334, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 43 } ], @@ -5147,7 +5343,7 @@ { "title": "Properties", "kind": 1024, - "children": [335] + "children": [334] } ] } @@ -5157,16 +5353,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5174,19 +5370,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 420, + "id": 422, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", - "id": 419, + "id": 421, "name": "default.limit" } }, { - "id": 165, + "id": 148, "name": "lt", "kind": 2048, "kindString": "Method", @@ -5194,23 +5390,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 128, + "line": 91, "character": 2 } ], "signatures": [ { - "id": 166, + "id": 149, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is less than the\nspecified `value`." + "shortText": "Match only rows where `column` is less than `value`." }, "typeParameter": [ { - "id": 167, + "id": 150, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5223,57 +5419,57 @@ ], "parameters": [ { - "id": 168, + "id": 151, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 167, + "id": 150, "name": "ColumnName", "dereferenced": {} } }, { - "id": 169, + "id": 152, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 167, + "id": 150, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5281,14 +5477,14 @@ } }, { - "id": 170, + "id": 153, "name": "lt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 171, + "id": 154, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5299,7 +5495,7 @@ } }, { - "id": 172, + "id": 155, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5312,16 +5508,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5331,7 +5527,7 @@ ] }, { - "id": 173, + "id": 156, "name": "lte", "kind": 2048, "kindString": "Method", @@ -5339,23 +5535,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 142, + "line": 104, "character": 2 } ], "signatures": [ { - "id": 174, + "id": 157, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` is less than or equal\nto the specified `value`." + "shortText": "Match only rows where `column` is less than or equal to `value`." }, "typeParameter": [ { - "id": 175, + "id": 158, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5368,57 +5564,57 @@ ], "parameters": [ { - "id": 176, + "id": 159, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 175, + "id": 158, "name": "ColumnName", "dereferenced": {} } }, { - "id": 177, + "id": 160, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 175, + "id": 158, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5426,14 +5622,14 @@ } }, { - "id": 178, + "id": 161, "name": "lte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 179, + "id": 162, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5444,7 +5640,7 @@ } }, { - "id": 180, + "id": 163, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5457,16 +5653,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5476,7 +5672,7 @@ ] }, { - "id": 303, + "id": 276, "name": "match", "kind": 2048, "kindString": "Method", @@ -5484,23 +5680,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 423, + "line": 374, "character": 2 } ], "signatures": [ { - "id": 304, + "id": 277, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose columns match the specified `query` object." + "shortText": "Match only rows where each column in `query` keys is equal to its\nassociated value. Shorthand for multiple `.eq()`s." }, "typeParameter": [ { - "id": 305, + "id": 278, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5513,33 +5709,33 @@ ], "parameters": [ { - "id": 306, + "id": 279, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The object to filter with, with column names as keys mapped\n to their filter values.\n" + "shortText": "The object to filter with, with column names as keys mapped\nto their filter values\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 305, + "id": 278, "name": "ColumnName" }, { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 305, + "id": 278, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } ], @@ -5551,16 +5747,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5568,14 +5764,14 @@ } }, { - "id": 307, + "id": 280, "name": "match", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 308, + "id": 281, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -5600,16 +5796,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5619,7 +5815,7 @@ ] }, { - "id": 348, + "id": 347, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -5627,30 +5823,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 129, + "line": 146, "character": 2 } ], "signatures": [ { - "id": 349, + "id": 348, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 518, + "id": 523, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5663,19 +5860,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 438, + "id": 440, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", - "id": 437, + "id": 439, "name": "default.maybeSingle" } }, { - "id": 141, + "id": 124, "name": "neq", "kind": 2048, "kindString": "Method", @@ -5683,23 +5880,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 86, + "line": 52, "character": 2 } ], "signatures": [ { - "id": 142, + "id": 125, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose value on the stated `column` doesn't match the\nspecified `value`." + "shortText": "Match only rows where `column` is not equal to `value`." }, "typeParameter": [ { - "id": 143, + "id": 126, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5712,57 +5909,57 @@ ], "parameters": [ { - "id": 144, + "id": 127, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 143, + "id": 126, "name": "ColumnName", "dereferenced": {} } }, { - "id": 145, + "id": 128, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 143, + "id": 126, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5770,14 +5967,14 @@ } }, { - "id": 146, + "id": 129, "name": "neq", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 147, + "id": 130, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5788,7 +5985,7 @@ } }, { - "id": 148, + "id": 131, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5801,16 +5998,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5820,7 +6017,7 @@ ] }, { - "id": 117, + "id": 282, "name": "not", "kind": 2048, "kindString": "Method", @@ -5828,23 +6025,24 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 42, + "line": 396, "character": 2 } ], "signatures": [ { - "id": 118, + "id": 283, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows which doesn't satisfy the filter." + "shortText": "Match only rows which doesn't satisfy the filter.", + "text": "Unlike most filters, `opearator` and `value` are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized.\n" }, "typeParameter": [ { - "id": 119, + "id": 284, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -5857,29 +6055,29 @@ ], "parameters": [ { - "id": 120, + "id": 285, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The column to filter on" }, "type": { "type": "reference", - "id": 119, + "id": 284, "name": "ColumnName", "dereferenced": {} } }, { - "id": 121, + "id": 286, "name": "operator", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The operator to filter with." + "shortText": "The operator to be negated to filter with, following\nPostgREST syntax" }, "type": { "type": "reference", @@ -5887,41 +6085,41 @@ } }, { - "id": 122, + "id": 287, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The value to filter with, following PostgREST syntax\n" }, "type": { "type": "indexedAccess", "indexType": { "type": "reference", - "id": 119, + "id": 284, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5929,14 +6127,14 @@ } }, { - "id": 123, + "id": 288, "name": "not", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 124, + "id": 289, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -5947,7 +6145,7 @@ } }, { - "id": 125, + "id": 290, "name": "operator", "kind": 32768, "kindString": "Parameter", @@ -5958,7 +6156,7 @@ } }, { - "id": 126, + "id": 291, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -5971,16 +6169,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -5990,7 +6188,7 @@ ] }, { - "id": 127, + "id": 292, "name": "or", "kind": 2048, "kindString": "Method", @@ -5998,29 +6196,30 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 59, + "line": 420, "character": 2 } ], "signatures": [ { - "id": 128, + "id": 293, "name": "or", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows satisfying at least one of the filters." + "shortText": "Match only rows which satisfy at least one of the filters.", + "text": "Unlike most filters, `filters` is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an `.or()` filter across multiple tables.\n" }, "parameters": [ { - "id": 129, + "id": 294, "name": "filters", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The filters to use, separated by commas." + "shortText": "The filters to use, following PostgREST syntax" }, "type": { "type": "intrinsic", @@ -6028,26 +6227,26 @@ } }, { - "id": 130, + "id": 295, "name": "foreignTable", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (if `column` is a foreign column).\n" + "shortText": "Set this to filter on foreign tables instead of the\ncurrent table\n" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 131, + "id": 296, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 132, + "id": 297, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -6057,7 +6256,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 59, + "line": 420, "character": 42 } ], @@ -6071,7 +6270,7 @@ { "title": "Properties", "kind": 1024, - "children": [132] + "children": [297] } ] } @@ -6081,16 +6280,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6100,7 +6299,7 @@ ] }, { - "id": 314, + "id": 313, "name": "order", "kind": 2048, "kindString": "Method", @@ -6108,23 +6307,24 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, + "line": 59, "character": 2 } ], "signatures": [ { - "id": 315, + "id": 314, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Orders the result with the specified `column`." + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" }, "typeParameter": [ { - "id": 316, + "id": 315, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6137,50 +6337,56 @@ ], "parameters": [ { - "id": 317, + "id": 316, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order on." + "shortText": "The column to order by" }, "type": { "type": "reference", - "id": 316, + "id": 315, "name": "ColumnName", "dereferenced": {} } }, { - "id": 318, + "id": 317, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, + "comment": { + "shortText": "Named parameters" + }, "type": { "type": "reflection", "declaration": { - "id": 319, + "id": 318, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 320, + "id": 319, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 16 } ], @@ -6190,17 +6396,20 @@ } }, { - "id": 322, + "id": 321, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 59 } ], @@ -6210,17 +6419,20 @@ } }, { - "id": 321, + "id": 320, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 37 } ], @@ -6234,7 +6446,7 @@ { "title": "Properties", "kind": 1024, - "children": [320, 322, 321] + "children": [319, 321, 320] } ] } @@ -6243,16 +6455,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6260,19 +6472,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 404, + "id": 406, "name": "default.order" } }, { - "id": 323, + "id": 322, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 324, + "id": 323, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6283,7 +6495,7 @@ } }, { - "id": 325, + "id": 324, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -6293,14 +6505,14 @@ "type": { "type": "reflection", "declaration": { - "id": 326, + "id": 325, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 327, + "id": 326, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -6310,7 +6522,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 16 } ], @@ -6320,7 +6532,7 @@ } }, { - "id": 329, + "id": 328, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -6328,7 +6540,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 59 } ], @@ -6338,7 +6550,7 @@ } }, { - "id": 328, + "id": 327, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -6348,7 +6560,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 37 } ], @@ -6362,7 +6574,7 @@ { "title": "Properties", "kind": 1024, - "children": [327, 329, 328] + "children": [326, 328, 327] } ] } @@ -6371,16 +6583,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6388,19 +6600,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 412, + "id": 414, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", - "id": 403, + "id": 405, "name": "default.order" } }, { - "id": 269, + "id": 252, "name": "overlaps", "kind": 2048, "kindString": "Method", @@ -6408,23 +6620,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 346, + "line": 313, "character": 2 } ], "signatures": [ { - "id": 270, + "id": 253, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose array or range value on the stated `column` overlaps\n(has a value in common) with the specified `value`." + "shortText": "Only relevant for array and range columns. Match only rows where\n`column` and `value` have an element in common." }, "typeParameter": [ { - "id": 271, + "id": 254, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6437,29 +6649,29 @@ ], "parameters": [ { - "id": 272, + "id": 255, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The array or range column to filter on" }, "type": { "type": "reference", - "id": 271, + "id": 254, "name": "ColumnName", "dereferenced": {} } }, { - "id": 273, + "id": 256, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The value to filter with.\n" + "shortText": "The array or range value to filter with\n" }, "type": { "type": "union", @@ -6474,13 +6686,13 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "id": 271, + "id": 254, "name": "ColumnName" }, "objectType": { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" } } } @@ -6490,16 +6702,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6507,14 +6719,14 @@ } }, { - "id": 274, + "id": 257, "name": "overlaps", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 275, + "id": 258, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6525,7 +6737,7 @@ } }, { - "id": 276, + "id": 259, "name": "value", "kind": 32768, "kindString": "Parameter", @@ -6550,16 +6762,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6569,7 +6781,7 @@ ] }, { - "id": 336, + "id": 335, "name": "range", "kind": 2048, "kindString": "Method", @@ -6577,29 +6789,43 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 2 } ], "signatures": [ { - "id": 337, + "id": 336, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result to rows within the specified range, inclusive." + "shortText": "Limit the query result by `from` and `to` inclusively." }, "parameters": [ { - "id": 338, + "id": 337, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result, inclusive." + "shortText": "The starting index from which to limit the result" + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 338, + "name": "to", + "kind": 32768, + "kindString": "Parameter", + "flags": {}, + "comment": { + "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", @@ -6608,49 +6834,38 @@ }, { "id": 339, - "name": "to", + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result, inclusive." - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 340, - "name": "foreignTable", - "kind": 32768, - "kindString": "Parameter", - "flags": {}, - "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 341, + "id": 340, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 342, + "id": 341, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 54 } ], @@ -6664,7 +6879,7 @@ { "title": "Properties", "kind": 1024, - "children": [342] + "children": [341] } ] } @@ -6674,16 +6889,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6691,19 +6906,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 426, + "id": 428, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", - "id": 425, + "id": 427, "name": "default.range" } }, { - "id": 261, + "id": 244, "name": "rangeAdjacent", "kind": 2048, "kindString": "Method", @@ -6711,23 +6926,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 332, + "line": 299, "character": 2 } ], "signatures": [ { - "id": 262, + "id": 245, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` is adjacent to\nthe specified `range`." + "shortText": "Only relevant for range columns. Match only rows where `column` is\nmutually exclusive to `range` and there can be no element between the two\nranges." }, "typeParameter": [ { - "id": 263, + "id": 246, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6740,29 +6955,29 @@ ], "parameters": [ { - "id": 264, + "id": 247, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 263, + "id": 246, "name": "ColumnName", "dereferenced": {} } }, { - "id": 265, + "id": 248, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -6772,16 +6987,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6789,14 +7004,14 @@ } }, { - "id": 266, + "id": 249, "name": "rangeAdjacent", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 267, + "id": 250, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6807,7 +7022,7 @@ } }, { - "id": 268, + "id": 251, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -6820,16 +7035,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6839,7 +7054,7 @@ ] }, { - "id": 237, + "id": 212, "name": "rangeGt", "kind": 2048, "kindString": "Method", @@ -6847,23 +7062,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 290, + "line": 240, "character": 2 } ], "signatures": [ { - "id": 238, + "id": 213, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` is strictly to\nthe right of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is greater than any element in `range`." }, "typeParameter": [ { - "id": 239, + "id": 214, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -6876,29 +7091,29 @@ ], "parameters": [ { - "id": 240, + "id": 215, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 239, + "id": 214, "name": "ColumnName", "dereferenced": {} } }, { - "id": 241, + "id": 216, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -6908,16 +7123,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6925,14 +7140,14 @@ } }, { - "id": 242, + "id": 217, "name": "rangeGt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 243, + "id": 218, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -6943,7 +7158,7 @@ } }, { - "id": 244, + "id": 219, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -6956,16 +7171,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -6975,7 +7190,7 @@ ] }, { - "id": 245, + "id": 220, "name": "rangeGte", "kind": 2048, "kindString": "Method", @@ -6983,23 +7198,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 304, + "line": 255, "character": 2 } ], "signatures": [ { - "id": 246, + "id": 221, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the left of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or greater than any element in\n`range`." }, "typeParameter": [ { - "id": 247, + "id": 222, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7012,29 +7227,29 @@ ], "parameters": [ { - "id": 248, + "id": 223, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 247, + "id": 222, "name": "ColumnName", "dereferenced": {} } }, { - "id": 249, + "id": 224, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -7044,16 +7259,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7061,14 +7276,14 @@ } }, { - "id": 250, + "id": 225, "name": "rangeGte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 251, + "id": 226, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7079,7 +7294,7 @@ } }, { - "id": 252, + "id": 227, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -7092,16 +7307,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7111,7 +7326,7 @@ ] }, { - "id": 229, + "id": 228, "name": "rangeLt", "kind": 2048, "kindString": "Method", @@ -7119,23 +7334,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 276, + "line": 269, "character": 2 } ], "signatures": [ { - "id": 230, + "id": 229, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` is strictly to the\nleft of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is less than any element in `range`." }, "typeParameter": [ { - "id": 231, + "id": 230, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7148,29 +7363,29 @@ ], "parameters": [ { - "id": 232, + "id": 231, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 231, + "id": 230, "name": "ColumnName", "dereferenced": {} } }, { - "id": 233, + "id": 232, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -7180,16 +7395,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7197,14 +7412,14 @@ } }, { - "id": 234, + "id": 233, "name": "rangeLt", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 235, + "id": 234, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7215,7 +7430,7 @@ } }, { - "id": 236, + "id": 235, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -7228,16 +7443,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7247,7 +7462,7 @@ ] }, { - "id": 253, + "id": 236, "name": "rangeLte", "kind": 2048, "kindString": "Method", @@ -7255,23 +7470,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 318, + "line": 284, "character": 2 } ], "signatures": [ { - "id": 254, + "id": 237, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose range value on the stated `column` does not extend\nto the right of the specified `range`." + "shortText": "Only relevant for range columns. Match only rows where every element in\n`column` is either contained in `range` or less than any element in\n`range`." }, "typeParameter": [ { - "id": 255, + "id": 238, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7284,29 +7499,29 @@ ], "parameters": [ { - "id": 256, + "id": 239, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The range column to filter on" }, "type": { "type": "reference", - "id": 255, + "id": 238, "name": "ColumnName", "dereferenced": {} } }, { - "id": 257, + "id": 240, "name": "range", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The range to filter with.\n" + "shortText": "The range to filter with\n" }, "type": { "type": "intrinsic", @@ -7316,16 +7531,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7333,14 +7548,14 @@ } }, { - "id": 258, + "id": 241, "name": "rangeLte", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 259, + "id": 242, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7351,7 +7566,7 @@ } }, { - "id": 260, + "id": 243, "name": "range", "kind": 32768, "kindString": "Parameter", @@ -7364,16 +7579,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7383,7 +7598,61 @@ ] }, { - "id": 309, + "id": 363, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 229, + "character": 2 + } + ], + "signatures": [ + { + "id": 364, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 110, + "typeArguments": [ + { + "type": "reference", + "id": 113, + "name": "Row" + }, + { + "type": "reference", + "id": 114, + "name": "Result" + } + ], + "name": "default" + }, + "inheritedFrom": { + "type": "reference", + "id": 456, + "name": "default.rollback" + } + } + ], + "inheritedFrom": { + "type": "reference", + "id": 455, + "name": "default.rollback" + } + }, + { + "id": 308, "name": "select", "kind": 2048, "kindString": "Method", @@ -7397,17 +7666,18 @@ ], "signatures": [ { - "id": 310, + "id": 309, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs vertical filtering with SELECT." + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { - "id": 311, + "id": 310, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -7422,7 +7692,7 @@ } }, { - "id": 312, + "id": 311, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -7432,14 +7702,14 @@ "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" }, "extendsType": { @@ -7452,7 +7722,7 @@ }, "falseType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" } } @@ -7463,7 +7733,7 @@ ], "parameters": [ { - "id": 313, + "id": 312, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -7471,11 +7741,11 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas.\n" + "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", - "id": 311, + "id": 310, "name": "Query", "dereferenced": {} } @@ -7483,16 +7753,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 312, + "id": 311, "name": "NewResult" } ], @@ -7500,19 +7770,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 399, + "id": 401, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", - "id": 398, + "id": 400, "name": "default.select" } }, { - "id": 346, + "id": 345, "name": "single", "kind": 2048, "kindString": "Method", @@ -7520,30 +7790,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 119, + "line": 135, "character": 2 } ], "signatures": [ { - "id": 347, + "id": 346, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7556,19 +7827,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 436, + "id": 438, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", - "id": 435, + "id": 437, "name": "default.single" } }, { - "id": 277, + "id": 260, "name": "textSearch", "kind": 2048, "kindString": "Method", @@ -7576,23 +7847,23 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 371, + "line": 339, "character": 2 } ], "signatures": [ { - "id": 278, + "id": 261, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Finds all rows whose text or tsvector value on the stated `column` matches\nthe tsquery in `query`." + "shortText": "Only relevant for text and tsvector columns. Match only rows where\n`column` matches the query string in `query`." }, "typeParameter": [ { - "id": 279, + "id": 262, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -7605,29 +7876,29 @@ ], "parameters": [ { - "id": 280, + "id": 263, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to filter on." + "shortText": "The text or tsvector column to filter on" }, "type": { "type": "reference", - "id": 279, + "id": 262, "name": "ColumnName", "dereferenced": {} } }, { - "id": 281, + "id": 264, "name": "query", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The Postgres tsquery string to filter with." + "shortText": "The query text to match with" }, "type": { "type": "intrinsic", @@ -7635,34 +7906,40 @@ } }, { - "id": 282, + "id": 265, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, + "comment": { + "shortText": "Named parameters" + }, "type": { "type": "reflection", "declaration": { - "id": 283, + "id": 266, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 284, + "id": 267, "name": "config", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "The text search configuration to use" + }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 374, + "line": 342, "character": 16 } ], @@ -7672,17 +7949,20 @@ } }, { - "id": 285, + "id": 268, "name": "type", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Change how the `query` text is interpreted\n" + }, "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 374, + "line": 342, "character": 33 } ], @@ -7709,7 +7989,7 @@ { "title": "Properties", "kind": 1024, - "children": [284, 285] + "children": [267, 268] } ] } @@ -7718,16 +7998,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7735,14 +8015,14 @@ } }, { - "id": 286, + "id": 269, "name": "textSearch", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 287, + "id": 270, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -7753,7 +8033,7 @@ } }, { - "id": 288, + "id": 271, "name": "query", "kind": 32768, "kindString": "Parameter", @@ -7764,7 +8044,7 @@ } }, { - "id": 289, + "id": 272, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -7774,14 +8054,14 @@ "type": { "type": "reflection", "declaration": { - "id": 290, + "id": 273, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 291, + "id": 274, "name": "config", "kind": 1024, "kindString": "Property", @@ -7791,7 +8071,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 379, + "line": 347, "character": 16 } ], @@ -7801,7 +8081,7 @@ } }, { - "id": 292, + "id": 275, "name": "type", "kind": 1024, "kindString": "Property", @@ -7811,7 +8091,7 @@ "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 379, + "line": 347, "character": 33 } ], @@ -7838,7 +8118,7 @@ { "title": "Properties", "kind": 1024, - "children": [291, 292] + "children": [274, 275] } ] } @@ -7847,16 +8127,16 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7866,7 +8146,7 @@ ] }, { - "id": 378, + "id": 380, "name": "then", "kind": 2048, "kindString": "Method", @@ -7880,25 +8160,25 @@ ], "signatures": [ { - "id": 379, + "id": 381, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 380, + "id": 382, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7906,7 +8186,7 @@ } }, { - "id": 381, + "id": 383, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -7919,7 +8199,7 @@ ], "parameters": [ { - "id": 382, + "id": 384, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -7936,32 +8216,32 @@ { "type": "reflection", "declaration": { - "id": 383, + "id": 385, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 384, + "id": 386, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 385, + "id": 387, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -7974,7 +8254,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -7982,7 +8262,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -8000,7 +8280,7 @@ } }, { - "id": 386, + "id": 388, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -8017,21 +8297,21 @@ { "type": "reflection", "declaration": { - "id": 387, + "id": 389, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 388, + "id": 390, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 389, + "id": 391, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -8047,7 +8327,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -8055,7 +8335,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -8081,12 +8361,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -8098,19 +8378,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 468, + "id": 473, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 467, + "id": 472, "name": "default.then" } }, { - "id": 376, + "id": 378, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -8124,7 +8404,7 @@ ], "signatures": [ { - "id": 377, + "id": 379, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -8135,16 +8415,16 @@ }, "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -8152,14 +8432,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 466, + "id": 471, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 465, + "id": 470, "name": "default.throwOnError" } } @@ -8168,33 +8448,34 @@ { "title": "Constructors", "kind": 512, - "children": [112] + "children": [111] }, { "title": "Properties", "kind": 1024, - "children": [375, 367, 370, 365, 363, 366, 368, 369, 364] + "children": [377, 369, 372, 367, 365, 368, 370, 371, 366] }, { "title": "Methods", "kind": 2048, "children": [ - 343, 221, 213, 350, 133, 354, 293, 352, 149, 157, 189, 205, 197, 181, 330, 165, 173, - 303, 348, 141, 117, 127, 314, 269, 336, 261, 237, 245, 229, 253, 309, 346, 277, 378, 376 + 342, 204, 196, 349, 116, 353, 298, 351, 132, 140, 172, 188, 180, 164, 329, 148, 156, + 276, 347, 124, 282, 292, 313, 252, 335, 244, 212, 220, 228, 236, 363, 308, 345, 260, + 380, 378 ] } ], "sources": [ { "fileName": "src/PostgrestFilterBuilder.ts", - "line": 31, + "line": 27, "character": 21 } ], "typeParameter": [ { - "id": 390, - "name": "Table", + "id": 392, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -8216,7 +8497,7 @@ } }, { - "id": 391, + "id": 393, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -8226,16 +8507,16 @@ "extendedTypes": [ { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 114, - "name": "Table" + "id": 113, + "name": "Row" }, { "type": "reference", - "id": 115, + "id": 114, "name": "Result" } ], @@ -8244,14 +8525,14 @@ ] }, { - "id": 46, + "id": 49, "name": "PostgrestQueryBuilder", "kind": 128, "kindString": "Class", "flags": {}, "children": [ { - "id": 47, + "id": 50, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -8265,27 +8546,36 @@ ], "signatures": [ { - "id": 48, + "id": 51, "name": "new PostgrestQueryBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 49, - "name": "Table", + "id": 52, + "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "reference", - "name": "GenericTable" + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] } } ], "parameters": [ { - "id": 50, + "id": 53, "name": "url", "kind": 32768, "kindString": "Parameter", @@ -8298,7 +8588,7 @@ } }, { - "id": 51, + "id": 54, "name": "__namedParameters", "kind": 32768, "kindString": "Parameter", @@ -8306,14 +8596,14 @@ "type": { "type": "reflection", "declaration": { - "id": 52, + "id": 55, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 55, + "id": 58, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -8330,34 +8620,45 @@ "type": { "type": "reflection", "declaration": { - "id": 56, + "id": 59, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 57, + "id": 60, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 58, + "id": 61, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 59, + "id": 62, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -8392,7 +8693,7 @@ } }, { - "id": 53, + "id": 56, "name": "headers", "kind": 1024, "kindString": "Property", @@ -8424,7 +8725,7 @@ } }, { - "id": 54, + "id": 57, "name": "schema", "kind": 1024, "kindString": "Property", @@ -8448,7 +8749,7 @@ { "title": "Properties", "kind": 1024, - "children": [55, 53, 54] + "children": [58, 56, 57] } ] } @@ -8457,12 +8758,12 @@ ], "type": { "type": "reference", - "id": 46, + "id": 49, "typeArguments": [ { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } ], "name": "default" @@ -8471,7 +8772,7 @@ ] }, { - "id": 64, + "id": 67, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -8488,34 +8789,45 @@ "type": { "type": "reflection", "declaration": { - "id": 65, + "id": 68, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 66, + "id": 69, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 67, + "id": 70, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 68, + "id": 71, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -8550,7 +8862,7 @@ } }, { - "id": 61, + "id": 64, "name": "headers", "kind": 1024, "kindString": "Property", @@ -8580,7 +8892,7 @@ } }, { - "id": 62, + "id": 65, "name": "schema", "kind": 1024, "kindString": "Property", @@ -8600,7 +8912,7 @@ } }, { - "id": 63, + "id": 66, "name": "signal", "kind": 1024, "kindString": "Property", @@ -8622,7 +8934,7 @@ } }, { - "id": 60, + "id": 63, "name": "url", "kind": 1024, "kindString": "Property", @@ -8650,7 +8962,7 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 228, + "line": 296, "character": 2 } ], @@ -8662,15 +8974,20 @@ "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs a DELETE on the table." + "shortText": "Perform a DELETE on the table or view.", + "text": "By default, deleted rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "parameters": [ { "id": 106, - "name": "__namedParameters", + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { @@ -8689,12 +9006,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count deleted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 233, + "line": 299, "character": 4 } ], @@ -8715,36 +9032,13 @@ } ] } - }, - { - "id": 109, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 235, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [108, 109] + "children": [108] } ] } @@ -8754,7 +9048,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -8764,8 +9058,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -8779,7 +9073,7 @@ ] }, { - "id": 78, + "id": 81, "name": "insert", "kind": 2048, "kindString": "Method", @@ -8787,23 +9081,24 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 86, + "line": 117, "character": 2 } ], "signatures": [ { - "id": 79, + "id": 82, "name": "insert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs an INSERT into the table." + "shortText": "Perform an INSERT into the table or view.", + "text": "By default, inserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { - "id": 80, + "id": 83, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -8828,27 +9123,27 @@ ], "parameters": [ { - "id": 81, + "id": 84, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert.\n" + "shortText": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows.\n" }, "type": { "type": "union", "types": [ { "type": "reference", - "id": 80, + "id": 83, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 80, + "id": 83, "name": "Row" } } @@ -8856,22 +9151,26 @@ } }, { - "id": 82, - "name": "__namedParameters", + "id": 85, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 83, + "id": 86, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 84, + "id": 87, "name": "count", "kind": 1024, "kindString": "Property", @@ -8879,12 +9178,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count inserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 93, + "line": 122, "character": 6 } ], @@ -8905,36 +9204,13 @@ } ] } - }, - { - "id": 85, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 95, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [84, 85] + "children": [87] } ] } @@ -8944,7 +9220,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -8954,8 +9230,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -8969,7 +9245,7 @@ ] }, { - "id": 69, + "id": 72, "name": "select", "kind": 2048, "kindString": "Method", @@ -8977,23 +9253,23 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 36, + "line": 52, "character": 2 } ], "signatures": [ { - "id": 70, + "id": 73, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs vertical filtering with SELECT." + "shortText": "Perform a SELECT query on the table or view." }, "typeParameter": [ { - "id": 71, + "id": 74, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -9008,7 +9284,7 @@ } }, { - "id": 72, + "id": 75, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -9024,15 +9300,15 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { "type": "conditional", "checkType": { "type": "reference", - "id": 71, + "id": 74, "name": "Query" }, "extendsType": { @@ -9045,7 +9321,7 @@ }, "falseType": { "type": "reference", - "id": 71, + "id": 74, "name": "Query" } } @@ -9056,7 +9332,7 @@ ], "parameters": [ { - "id": 73, + "id": 76, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -9064,32 +9340,36 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas.\n" + "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", - "id": 71, + "id": 74, "name": "Query", "dereferenced": {} } }, { - "id": 74, - "name": "__namedParameters", + "id": 77, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 75, + "id": 78, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 77, + "id": 80, "name": "count", "kind": 1024, "kindString": "Property", @@ -9097,12 +9377,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count rows in the table or view.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 48, + "line": 62, "character": 6 } ], @@ -9125,7 +9405,7 @@ } }, { - "id": 76, + "id": 79, "name": "head", "kind": 1024, "kindString": "Property", @@ -9133,12 +9413,12 @@ "isOptional": true }, "comment": { - "shortText": "When set to true, select will void data." + "shortText": "When set to `true`, `data` will not be returned.\nUseful if you only need the count.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 46, + "line": 61, "character": 6 } ], @@ -9152,7 +9432,7 @@ { "title": "Properties", "kind": 1024, - "children": [77, 76] + "children": [80, 79] } ] } @@ -9162,7 +9442,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -9172,13 +9452,13 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { "type": "reference", - "id": 72, + "id": 75, "name": "Result" } ], @@ -9188,7 +9468,7 @@ ] }, { - "id": 96, + "id": 97, "name": "update", "kind": 2048, "kindString": "Method", @@ -9196,23 +9476,24 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 188, + "line": 247, "character": 2 } ], "signatures": [ { - "id": 97, + "id": 98, "name": "update", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs an UPDATE on the table." + "shortText": "Perform an UPDATE on the table or view.", + "text": "By default, updated rows are not returned. To return it, chain the call\nwith `.select()` after filters.\n" }, "typeParameter": [ { - "id": 98, + "id": 99, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -9237,38 +9518,42 @@ ], "parameters": [ { - "id": 99, + "id": 100, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to update.\n" + "shortText": "The values to update with\n" }, "type": { "type": "reference", - "id": 98, + "id": 99, "name": "Row", "dereferenced": {} } }, { - "id": 100, - "name": "__namedParameters", + "id": 101, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 101, + "id": 102, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 102, + "id": 103, "name": "count", "kind": 1024, "kindString": "Property", @@ -9276,12 +9561,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count updated rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 195, + "line": 252, "character": 6 } ], @@ -9302,36 +9587,13 @@ } ] } - }, - { - "id": 103, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 197, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [102, 103] + "children": [103] } ] } @@ -9341,7 +9603,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -9351,8 +9613,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -9366,7 +9628,7 @@ ] }, { - "id": 86, + "id": 88, "name": "upsert", "kind": 2048, "kindString": "Method", @@ -9374,23 +9636,24 @@ "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 137, + "line": 189, "character": 2 } ], "signatures": [ { - "id": 87, + "id": 89, "name": "upsert", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs an UPSERT into the table." + "shortText": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto `onConflict`, `.upsert()` allows you to perform the equivalent of\n`.insert()` if a row with the corresponding `onConflict` columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n`ignoreDuplicates`.", + "text": "By default, upserted rows are not returned. To return it, chain the call\nwith `.select()`.\n" }, "typeParameter": [ { - "id": 88, + "id": 90, "name": "Row", "kind": 131072, "kindString": "Type parameter", @@ -9415,27 +9678,27 @@ ], "parameters": [ { - "id": 89, + "id": 91, "name": "values", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The values to insert.\n" + "shortText": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows.\n" }, "type": { "type": "union", "types": [ { "type": "reference", - "id": 88, + "id": 90, "name": "Row" }, { "type": "array", "elementType": { "type": "reference", - "id": 88, + "id": 90, "name": "Row" } } @@ -9443,22 +9706,26 @@ } }, { - "id": 90, - "name": "__namedParameters", + "id": 92, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 91, + "id": 93, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 93, + "id": 96, "name": "count", "kind": 1024, "kindString": "Property", @@ -9466,12 +9733,12 @@ "isOptional": true }, "comment": { - "shortText": "Count algorithm to use to count rows in a table." + "shortText": "Count algorithm to use to count upserted rows.\n\n`\"exact\"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the\nhood.\n\n`\"planned\"`: Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n`\"estimated\"`: Uses exact count for low numbers and planned count for high\nnumbers.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 148, + "line": 198, "character": 6 } ], @@ -9494,7 +9761,7 @@ } }, { - "id": 94, + "id": 95, "name": "ignoreDuplicates", "kind": 1024, "kindString": "Property", @@ -9502,12 +9769,12 @@ "isOptional": true }, "comment": { - "shortText": "Specifies if duplicate rows should be ignored and not inserted." + "shortText": "If `true`, duplicate rows are ignored. If\n`false`, duplicate rows are merged with existing rows.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 150, + "line": 197, "character": 6 } ], @@ -9517,7 +9784,7 @@ } }, { - "id": 92, + "id": 94, "name": "onConflict", "kind": 1024, "kindString": "Property", @@ -9525,12 +9792,12 @@ "isOptional": true }, "comment": { - "shortText": "By specifying the `on_conflict` query parameter, you can make UPSERT work on a column(s) that has a UNIQUE constraint." + "shortText": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n`onConflict` columns are equal.\n" }, "sources": [ { "fileName": "src/PostgrestQueryBuilder.ts", - "line": 146, + "line": 196, "character": 6 } ], @@ -9538,36 +9805,13 @@ "type": "intrinsic", "name": "string" } - }, - { - "id": 95, - "name": "rollback", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "comment": { - "shortText": "Rollback the operation" - }, - "sources": [ - { - "fileName": "src/PostgrestQueryBuilder.ts", - "line": 152, - "character": 6 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } } ], "groups": [ { "title": "Properties", "kind": 1024, - "children": [93, 94, 92, 95] + "children": [96, 95, 94] } ] } @@ -9577,7 +9821,7 @@ ], "type": { "type": "reference", - "id": 111, + "id": 110, "typeArguments": [ { "type": "indexedAccess", @@ -9587,8 +9831,8 @@ }, "objectType": { "type": "reference", - "id": 49, - "name": "Table" + "id": 52, + "name": "Relation" } }, { @@ -9606,17 +9850,17 @@ { "title": "Constructors", "kind": 512, - "children": [47] + "children": [50] }, { "title": "Properties", "kind": 1024, - "children": [64, 61, 62, 63, 60] + "children": [67, 64, 65, 66, 63] }, { "title": "Methods", "kind": 2048, - "children": [104, 78, 69, 96, 86] + "children": [104, 81, 72, 97, 88] } ], "sources": [ @@ -9628,45 +9872,51 @@ ], "typeParameter": [ { - "id": 110, - "name": "Table", + "id": 109, + "name": "Relation", "kind": 131072, "kindString": "Type parameter", "flags": {}, "type": { - "type": "reference", - "name": "GenericTable" + "type": "union", + "types": [ + { + "type": "reference", + "name": "GenericTable" + }, + { + "type": "reference", + "name": "GenericView" + } + ] } } ] }, { - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder", "kind": 128, "kindString": "Class", "flags": {}, - "comment": { - "shortText": "Post-filters (transforms)" - }, "children": [ { - "id": 393, + "id": 395, "name": "constructor", "kind": 512, "kindString": "Constructor", "flags": {}, "signatures": [ { - "id": 394, + "id": 396, "name": "new PostgrestTransformBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 395, - "name": "Table", + "id": 397, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -9688,7 +9938,7 @@ } }, { - "id": 396, + "id": 398, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -9697,24 +9947,24 @@ ], "parameters": [ { - "id": 397, + "id": 399, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], "name": "default", "dereferenced": { - "id": 481, + "id": 486, "name": "PostgrestBuilder", "kind": 128, "kindString": "Class", @@ -9723,7 +9973,7 @@ }, "children": [ { - "id": 482, + "id": 487, "name": "constructor", "kind": 512, "kindString": "Constructor", @@ -9737,14 +9987,14 @@ ], "signatures": [ { - "id": 483, + "id": 488, "name": "new PostgrestBuilder", "kind": 16384, "kindString": "Constructor signature", "flags": {}, "typeParameter": [ { - "id": 484, + "id": 489, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -9753,18 +10003,18 @@ ], "parameters": [ { - "id": 485, + "id": 490, "name": "builder", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -9775,11 +10025,11 @@ ], "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -9789,7 +10039,7 @@ ] }, { - "id": 498, + "id": 503, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -9809,7 +10059,7 @@ } }, { - "id": 490, + "id": 495, "name": "body", "kind": 1024, "kindString": "Property", @@ -9830,7 +10080,7 @@ } }, { - "id": 493, + "id": 498, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -9847,34 +10097,45 @@ "type": { "type": "reflection", "declaration": { - "id": 494, + "id": 499, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 495, + "id": 500, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 496, + "id": 501, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 497, + "id": 502, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -9909,7 +10170,7 @@ } }, { - "id": 488, + "id": 493, "name": "headers", "kind": 1024, "kindString": "Property", @@ -9941,7 +10202,7 @@ } }, { - "id": 486, + "id": 491, "name": "method", "kind": 1024, "kindString": "Property", @@ -9982,7 +10243,7 @@ } }, { - "id": 489, + "id": 494, "name": "schema", "kind": 1024, "kindString": "Property", @@ -10003,7 +10264,7 @@ } }, { - "id": 491, + "id": 496, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -10024,7 +10285,7 @@ "defaultValue": "false" }, { - "id": 492, + "id": 497, "name": "signal", "kind": 1024, "kindString": "Property", @@ -10047,7 +10308,7 @@ } }, { - "id": 487, + "id": 492, "name": "url", "kind": 1024, "kindString": "Property", @@ -10069,7 +10330,7 @@ } }, { - "id": 501, + "id": 506, "name": "then", "kind": 2048, "kindString": "Method", @@ -10083,25 +10344,25 @@ ], "signatures": [ { - "id": 502, + "id": 507, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 503, + "id": 508, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -10109,7 +10370,7 @@ } }, { - "id": 504, + "id": 509, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -10122,7 +10383,7 @@ ], "parameters": [ { - "id": 505, + "id": 510, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -10139,32 +10400,32 @@ { "type": "reflection", "declaration": { - "id": 506, + "id": 511, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 507, + "id": 512, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 508, + "id": 513, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -10177,7 +10438,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -10185,7 +10446,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -10203,7 +10464,7 @@ } }, { - "id": 509, + "id": 514, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -10220,21 +10481,21 @@ { "type": "reflection", "declaration": { - "id": 510, + "id": 515, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 511, + "id": 516, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 512, + "id": 517, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -10250,7 +10511,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -10258,7 +10519,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -10284,12 +10545,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -10311,7 +10572,7 @@ } }, { - "id": 499, + "id": 504, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -10325,7 +10586,7 @@ ], "signatures": [ { - "id": 500, + "id": 505, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -10336,11 +10597,11 @@ }, "type": { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -10354,17 +10615,17 @@ { "title": "Constructors", "kind": 512, - "children": [482] + "children": [487] }, { "title": "Properties", "kind": 1024, - "children": [498, 490, 493, 488, 486, 489, 491, 492, 487] + "children": [503, 495, 498, 493, 491, 494, 496, 497, 492] }, { "title": "Methods", "kind": 2048, - "children": [501, 499] + "children": [506, 504] } ], "sources": [ @@ -10376,7 +10637,7 @@ ], "typeParameter": [ { - "id": 513, + "id": 518, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -10386,7 +10647,7 @@ "extendedBy": [ { "type": "reference", - "id": 392, + "id": 394, "name": "PostgrestTransformBuilder" } ], @@ -10396,11 +10657,11 @@ "typeArguments": [ { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 484, + "id": 489, "name": "Result" } ], @@ -10418,16 +10679,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -10435,19 +10696,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 483, + "id": 488, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", - "id": 482, + "id": 487, "name": "default.constructor" } }, { - "id": 464, + "id": 469, "name": "allowEmpty", "kind": 1024, "kindString": "Property", @@ -10467,12 +10728,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 498, + "id": 503, "name": "default.allowEmpty" } }, { - "id": 456, + "id": 461, "name": "body", "kind": 1024, "kindString": "Property", @@ -10493,12 +10754,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 490, + "id": 495, "name": "default.body" } }, { - "id": 459, + "id": 464, "name": "fetch", "kind": 1024, "kindString": "Property", @@ -10515,34 +10776,45 @@ "type": { "type": "reflection", "declaration": { - "id": 460, + "id": 465, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 461, + "id": 466, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 462, + "id": 467, "name": "input", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { - "type": "reference", - "qualifiedName": "RequestInfo", - "package": "typescript", - "name": "RequestInfo" + "type": "union", + "types": [ + { + "type": "reference", + "qualifiedName": "RequestInfo", + "package": "typescript", + "name": "RequestInfo" + }, + { + "type": "reference", + "qualifiedName": "URL", + "package": "typescript", + "name": "URL" + } + ] } }, { - "id": 463, + "id": 468, "name": "init", "kind": 32768, "kindString": "Parameter", @@ -10577,12 +10849,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 493, + "id": 498, "name": "default.fetch" } }, { - "id": 454, + "id": 459, "name": "headers", "kind": 1024, "kindString": "Property", @@ -10614,12 +10886,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 488, + "id": 493, "name": "default.headers" } }, { - "id": 452, + "id": 457, "name": "method", "kind": 1024, "kindString": "Property", @@ -10660,12 +10932,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 486, + "id": 491, "name": "default.method" } }, { - "id": 455, + "id": 460, "name": "schema", "kind": 1024, "kindString": "Property", @@ -10686,12 +10958,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 489, + "id": 494, "name": "default.schema" } }, { - "id": 457, + "id": 462, "name": "shouldThrowOnError", "kind": 1024, "kindString": "Property", @@ -10712,12 +10984,12 @@ "defaultValue": "false", "inheritedFrom": { "type": "reference", - "id": 491, + "id": 496, "name": "default.shouldThrowOnError" } }, { - "id": 458, + "id": 463, "name": "signal", "kind": 1024, "kindString": "Property", @@ -10740,12 +11012,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 492, + "id": 497, "name": "default.signal" } }, { - "id": 453, + "id": 458, "name": "url", "kind": 1024, "kindString": "Property", @@ -10767,12 +11039,12 @@ }, "inheritedFrom": { "type": "reference", - "id": 487, + "id": 492, "name": "default.url" } }, { - "id": 432, + "id": 434, "name": "abortSignal", "kind": 2048, "kindString": "Method", @@ -10780,27 +11052,30 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 110, + "line": 124, "character": 2 } ], "signatures": [ { - "id": 433, + "id": 435, "name": "abortSignal", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Sets the AbortSignal for the fetch request." + "shortText": "Set the AbortSignal for the fetch request." }, "parameters": [ { - "id": 434, + "id": 436, "name": "signal", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "The AbortSignal to use for the fetch request\n" + }, "type": { "type": "reference", "qualifiedName": "AbortSignal", @@ -10811,16 +11086,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -10830,7 +11105,7 @@ ] }, { - "id": 439, + "id": 441, "name": "csv", "kind": 2048, "kindString": "Method", @@ -10838,26 +11113,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 138, + "line": 155, "character": 2 } ], "signatures": [ { - "id": 440, + "id": 442, "name": "csv", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to CSV." + "shortText": "Return `data` as a string in CSV format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "intrinsic", @@ -10875,7 +11150,7 @@ ] }, { - "id": 443, + "id": 445, "name": "explain", "kind": 2048, "kindString": "Method", @@ -10883,48 +11158,133 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 160, + "line": 189, "character": 2 } ], "signatures": [ { - "id": 444, + "id": 446, "name": "explain", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Obtains the EXPLAIN plan for this request." + "shortText": "Return `data` as the EXPLAIN plan for the query." }, "parameters": [ { - "id": 445, - "name": "__namedParameters", + "id": 447, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, + "comment": { + "shortText": "Named parameters\n" + }, + "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 446, + "id": 448, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 447, + "id": 449, "name": "analyze", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the query will be executed and the\nactual run time will be returned\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 167, + "line": 197, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 452, + "name": "buffers", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on buffer usage\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 200, + "character": 4 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 454, + "name": "format", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "The format of the output, can be `\"text\"` (default)\nor `\"json\"`\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 202, + "character": 4 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "text" + }, + { + "type": "literal", + "value": "json" + } + ] + } + }, + { + "id": 451, + "name": "settings", + "kind": 1024, + "kindString": "Property", + "flags": { + "isOptional": true + }, + "comment": { + "shortText": "If `true`, include information on configuration\nparameters that affect query planning\n" + }, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 199, "character": 4 } ], @@ -10935,56 +11295,19 @@ }, { "id": 450, - "name": "buffers", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 170, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 449, - "name": "settings", - "kind": 1024, - "kindString": "Property", - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/PostgrestTransformBuilder.ts", - "line": 169, - "character": 4 - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 448, "name": "verbose", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the query identifier will be returned\nand `data` will include the output columns of the query\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 168, + "line": 198, "character": 4 } ], @@ -10994,17 +11317,20 @@ } }, { - "id": 451, + "id": 453, "name": "wal", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, include information on WAL record generation\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 171, + "line": 201, "character": 4 } ], @@ -11018,7 +11344,7 @@ { "title": "Properties", "kind": 1024, - "children": [447, 450, 449, 448, 451] + "children": [449, 452, 454, 451, 450, 453] } ] } @@ -11027,41 +11353,65 @@ } ], "type": { - "type": "reference", - "typeArguments": [ + "type": "union", + "types": [ { "type": "reference", - "id": 514, "typeArguments": [ { "type": "reference", + "id": 521, "typeArguments": [ { "type": "intrinsic", "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" } ], - "qualifiedName": "Record", - "package": "typescript", - "name": "Record" + "name": "PostgrestSingleResponse" } ], - "name": "PostgrestResponse" + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" + }, + { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 519, + "typeArguments": [ + { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "qualifiedName": "Record", + "package": "typescript", + "name": "Record" + } + ], + "name": "PostgrestResponse" + } + ], + "qualifiedName": "PromiseLike", + "package": "typescript", + "name": "PromiseLike" } - ], - "qualifiedName": "PromiseLike", - "package": "typescript", - "name": "PromiseLike" + ] } } ] }, { - "id": 441, + "id": 443, "name": "geojson", "kind": 2048, "kindString": "Method", @@ -11069,26 +11419,26 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 146, + "line": 163, "character": 2 } ], "signatures": [ { - "id": 442, + "id": 444, "name": "geojson", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Set the response type to GeoJSON." + "shortText": "Return `data` as an object in [GeoJSON](https://geojson.org) format." }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", @@ -11118,7 +11468,7 @@ ] }, { - "id": 419, + "id": 421, "name": "limit", "kind": 2048, "kindString": "Method", @@ -11126,29 +11476,29 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 2 } ], "signatures": [ { - "id": 420, + "id": 422, "name": "limit", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result with the specified `count`." + "shortText": "Limit the query result by `count`." }, "parameters": [ { - "id": 421, + "id": 423, "name": "count", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The maximum no. of rows to limit to." + "shortText": "The maximum number of rows to return" }, "type": { "type": "intrinsic", @@ -11156,36 +11506,39 @@ } }, { - "id": 422, - "name": "foreignTable", + "id": 424, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 423, + "id": 425, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 424, + "id": 426, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 85, + "line": 95, "character": 43 } ], @@ -11199,7 +11552,7 @@ { "title": "Properties", "kind": 1024, - "children": [424] + "children": [426] } ] } @@ -11209,16 +11562,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -11228,7 +11581,7 @@ ] }, { - "id": 437, + "id": 439, "name": "maybeSingle", "kind": 2048, "kindString": "Method", @@ -11236,30 +11589,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 129, + "line": 146, "character": 2 } ], "signatures": [ { - "id": 438, + "id": 440, "name": "maybeSingle", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves at most one row from the result. Result must be at most one row\n(e.g. using `eq` on a UNIQUE column), otherwise this will result in an\nerror." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be zero or one row (e.g. using `.limit(1)`), otherwise\nthis returns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 518, + "id": 523, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -11274,7 +11628,7 @@ ] }, { - "id": 403, + "id": 405, "name": "order", "kind": 2048, "kindString": "Method", @@ -11282,23 +11636,24 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 51, + "line": 59, "character": 2 } ], "signatures": [ { - "id": 404, + "id": 406, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Orders the result with the specified `column`." + "shortText": "Order the query result by `column`.", + "text": "You can call this method multiple times to order by multiple columns.\n\nYou can order foreign tables, but it doesn't affect the ordering of the\ncurrent table.\n" }, "typeParameter": [ { - "id": 405, + "id": 407, "name": "ColumnName", "kind": 131072, "kindString": "Type parameter", @@ -11311,50 +11666,56 @@ ], "parameters": [ { - "id": 406, + "id": 408, "name": "column", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The column to order on." + "shortText": "The column to order by" }, "type": { "type": "reference", - "id": 316, + "id": 315, "name": "ColumnName", "dereferenced": {} } }, { - "id": 407, + "id": 409, "name": "options", "kind": 32768, "kindString": "Parameter", "flags": { "isOptional": true }, + "comment": { + "shortText": "Named parameters" + }, "type": { "type": "reflection", "declaration": { - "id": 408, + "id": 410, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 409, + "id": 411, "name": "ascending", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, the result will be in ascending order" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 16 } ], @@ -11364,17 +11725,20 @@ } }, { - "id": 411, + "id": 413, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to order a foreign table by foreign\ncolumns\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 59 } ], @@ -11384,17 +11748,20 @@ } }, { - "id": 410, + "id": 412, "name": "nullsFirst", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "If `true`, `null`s appear first. If `false`,\n`null`s appear last." + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 53, + "line": 61, "character": 37 } ], @@ -11408,7 +11775,7 @@ { "title": "Properties", "kind": 1024, - "children": [409, 411, 410] + "children": [411, 413, 412] } ] } @@ -11417,16 +11784,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -11434,14 +11801,14 @@ } }, { - "id": 412, + "id": 414, "name": "order", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 413, + "id": 415, "name": "column", "kind": 32768, "kindString": "Parameter", @@ -11452,7 +11819,7 @@ } }, { - "id": 414, + "id": 416, "name": "options", "kind": 32768, "kindString": "Parameter", @@ -11462,14 +11829,14 @@ "type": { "type": "reflection", "declaration": { - "id": 415, + "id": 417, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 416, + "id": 418, "name": "ascending", "kind": 1024, "kindString": "Property", @@ -11479,7 +11846,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 16 } ], @@ -11489,7 +11856,7 @@ } }, { - "id": 418, + "id": 420, "name": "foreignTable", "kind": 1024, "kindString": "Property", @@ -11497,7 +11864,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 59 } ], @@ -11507,7 +11874,7 @@ } }, { - "id": 417, + "id": 419, "name": "nullsFirst", "kind": 1024, "kindString": "Property", @@ -11517,7 +11884,7 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 57, + "line": 65, "character": 37 } ], @@ -11531,7 +11898,7 @@ { "title": "Properties", "kind": 1024, - "children": [416, 418, 417] + "children": [418, 420, 419] } ] } @@ -11540,16 +11907,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -11559,7 +11926,7 @@ ] }, { - "id": 425, + "id": 427, "name": "range", "kind": 2048, "kindString": "Method", @@ -11567,29 +11934,29 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 2 } ], "signatures": [ { - "id": 426, + "id": 428, "name": "range", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Limits the result to rows within the specified range, inclusive." + "shortText": "Limit the query result by `from` and `to` inclusively." }, "parameters": [ { - "id": 427, + "id": 429, "name": "from", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The starting index from which to limit the result, inclusive." + "shortText": "The starting index from which to limit the result" }, "type": { "type": "intrinsic", @@ -11597,13 +11964,13 @@ } }, { - "id": 428, + "id": 430, "name": "to", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The last index to which to limit the result, inclusive." + "shortText": "The last index to which to limit the result" }, "type": { "type": "intrinsic", @@ -11611,36 +11978,39 @@ } }, { - "id": 429, - "name": "foreignTable", + "id": 431, + "name": "options", "kind": 32768, "kindString": "Parameter", "flags": {}, "comment": { - "shortText": "The foreign table to use (for foreign columns).\n" + "shortText": "Named parameters" }, "originalName": "__namedParameters", "type": { "type": "reflection", "declaration": { - "id": 430, + "id": 432, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 431, + "id": 433, "name": "foreignTable", "kind": 1024, "kindString": "Property", "flags": { "isOptional": true }, + "comment": { + "shortText": "Set this to limit rows of foreign tables\ninstead of the current table\n" + }, "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 98, + "line": 110, "character": 54 } ], @@ -11654,7 +12024,7 @@ { "title": "Properties", "kind": 1024, - "children": [431] + "children": [433] } ] } @@ -11664,16 +12034,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -11683,7 +12053,51 @@ ] }, { - "id": 398, + "id": 455, + "name": "rollback", + "kind": 2048, + "kindString": "Method", + "flags": {}, + "sources": [ + { + "fileName": "src/PostgrestTransformBuilder.ts", + "line": 229, + "character": 2 + } + ], + "signatures": [ + { + "id": 456, + "name": "rollback", + "kind": 4096, + "kindString": "Call signature", + "flags": {}, + "comment": { + "shortText": "Rollback the query.", + "text": "`data` will still be returned, but the query is not committed.\n" + }, + "type": { + "type": "reference", + "id": 394, + "typeArguments": [ + { + "type": "reference", + "id": 397, + "name": "Row" + }, + { + "type": "reference", + "id": 398, + "name": "Result" + } + ], + "name": "default" + } + } + ] + }, + { + "id": 400, "name": "select", "kind": 2048, "kindString": "Method", @@ -11697,17 +12111,18 @@ ], "signatures": [ { - "id": 399, + "id": 401, "name": "select", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Performs vertical filtering with SELECT." + "shortText": "Perform a SELECT on the query result.", + "text": "By default, `.insert()`, `.update()`, `.upsert()`, and `.delete()` do not\nreturn modified rows. By calling this method, modified rows are returned in\n`data`.\n" }, "typeParameter": [ { - "id": 400, + "id": 402, "name": "Query", "kind": 131072, "kindString": "Type parameter", @@ -11722,7 +12137,7 @@ } }, { - "id": 401, + "id": 403, "name": "NewResult", "kind": 131072, "kindString": "Type parameter", @@ -11732,14 +12147,14 @@ "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "conditional", "checkType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" }, "extendsType": { @@ -11752,7 +12167,7 @@ }, "falseType": { "type": "reference", - "id": 311, + "id": 310, "name": "Query" } } @@ -11763,7 +12178,7 @@ ], "parameters": [ { - "id": 402, + "id": 404, "name": "columns", "kind": 32768, "kindString": "Parameter", @@ -11771,11 +12186,11 @@ "isOptional": true }, "comment": { - "shortText": "The columns to retrieve, separated by commas.\n" + "shortText": "The columns to retrieve, separated by commas\n" }, "type": { "type": "reference", - "id": 311, + "id": 310, "name": "Query", "dereferenced": {} } @@ -11783,16 +12198,16 @@ ], "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 312, + "id": 311, "name": "NewResult" } ], @@ -11802,7 +12217,7 @@ ] }, { - "id": 435, + "id": 437, "name": "single", "kind": 2048, "kindString": "Method", @@ -11810,30 +12225,31 @@ "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 119, + "line": 135, "character": 2 } ], "signatures": [ { - "id": 436, + "id": 438, "name": "single", "kind": 4096, "kindString": "Call signature", "flags": {}, "comment": { - "shortText": "Retrieves only one row from the result. Result must be one row (e.g. using\n`limit`), otherwise this will result in an error." + "shortText": "Return `data` as a single object instead of an array of objects.", + "text": "Query result must be one row (e.g. using `.limit(1)`), otherwise this\nreturns an error.\n" }, "type": { "type": "reference", "typeArguments": [ { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -11848,7 +12264,7 @@ ] }, { - "id": 467, + "id": 472, "name": "then", "kind": 2048, "kindString": "Method", @@ -11862,25 +12278,25 @@ ], "signatures": [ { - "id": 468, + "id": 473, "name": "then", "kind": 4096, "kindString": "Call signature", "flags": {}, "typeParameter": [ { - "id": 469, + "id": 474, "name": "TResult1", "kind": 131072, "kindString": "Type parameter", "flags": {}, "default": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -11888,7 +12304,7 @@ } }, { - "id": 470, + "id": 475, "name": "TResult2", "kind": 131072, "kindString": "Type parameter", @@ -11901,7 +12317,7 @@ ], "parameters": [ { - "id": 471, + "id": 476, "name": "onfulfilled", "kind": 32768, "kindString": "Parameter", @@ -11918,32 +12334,32 @@ { "type": "reflection", "declaration": { - "id": 472, + "id": 477, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 473, + "id": 478, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 474, + "id": 479, "name": "value", "kind": 32768, "kindString": "Parameter", "flags": {}, "type": { "type": "reference", - "id": 514, + "id": 519, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -11956,7 +12372,7 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { @@ -11964,7 +12380,7 @@ "typeArguments": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" } ], @@ -11982,7 +12398,7 @@ } }, { - "id": 475, + "id": 480, "name": "onrejected", "kind": 32768, "kindString": "Parameter", @@ -11999,21 +12415,21 @@ { "type": "reflection", "declaration": { - "id": 476, + "id": 481, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "signatures": [ { - "id": 477, + "id": 482, "name": "__type", "kind": 4096, "kindString": "Call signature", "flags": {}, "parameters": [ { - "id": 478, + "id": 483, "name": "reason", "kind": 32768, "kindString": "Parameter", @@ -12029,7 +12445,7 @@ "types": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" }, { @@ -12037,7 +12453,7 @@ "typeArguments": [ { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ], @@ -12063,12 +12479,12 @@ "types": [ { "type": "reference", - "id": 380, + "id": 382, "name": "TResult1" }, { "type": "reference", - "id": 381, + "id": 383, "name": "TResult2" } ] @@ -12080,19 +12496,19 @@ }, "inheritedFrom": { "type": "reference", - "id": 502, + "id": 507, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", - "id": 501, + "id": 506, "name": "default.then" } }, { - "id": 465, + "id": 470, "name": "throwOnError", "kind": 2048, "kindString": "Method", @@ -12106,7 +12522,7 @@ ], "signatures": [ { - "id": 466, + "id": 471, "name": "throwOnError", "kind": 4096, "kindString": "Call signature", @@ -12117,16 +12533,16 @@ }, "type": { "type": "reference", - "id": 392, + "id": 394, "typeArguments": [ { "type": "reference", - "id": 395, - "name": "Table" + "id": 397, + "name": "Row" }, { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -12134,14 +12550,14 @@ }, "inheritedFrom": { "type": "reference", - "id": 500, + "id": 505, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", - "id": 499, + "id": 504, "name": "default.throwOnError" } } @@ -12150,30 +12566,30 @@ { "title": "Constructors", "kind": 512, - "children": [393] + "children": [395] }, { "title": "Properties", "kind": 1024, - "children": [464, 456, 459, 454, 452, 455, 457, 458, 453] + "children": [469, 461, 464, 459, 457, 460, 462, 463, 458] }, { "title": "Methods", "kind": 2048, - "children": [432, 439, 443, 441, 419, 437, 403, 425, 398, 435, 467, 465] + "children": [434, 441, 445, 443, 421, 439, 405, 427, 455, 400, 437, 472, 470] } ], "sources": [ { "fileName": "src/PostgrestTransformBuilder.ts", - "line": 9, + "line": 5, "character": 21 } ], "typeParameter": [ { - "id": 479, - "name": "Table", + "id": 484, + "name": "Row", "kind": 131072, "kindString": "Type parameter", "flags": {}, @@ -12195,7 +12611,7 @@ } }, { - "id": 480, + "id": 485, "name": "Result", "kind": 131072, "kindString": "Type parameter", @@ -12205,11 +12621,11 @@ "extendedTypes": [ { "type": "reference", - "id": 481, + "id": 486, "typeArguments": [ { "type": "reference", - "id": 396, + "id": 398, "name": "Result" } ], @@ -12219,13 +12635,13 @@ "extendedBy": [ { "type": "reference", - "id": 111, + "id": 110, "name": "PostgrestFilterBuilder" } ] }, { - "id": 520, + "id": 525, "name": "PostgrestError", "kind": 4194304, "kindString": "Type alias", @@ -12244,14 +12660,14 @@ "type": { "type": "reflection", "declaration": { - "id": 521, + "id": 526, "name": "__type", "kind": 65536, "kindString": "Type literal", "flags": {}, "children": [ { - "id": 525, + "id": 530, "name": "code", "kind": 1024, "kindString": "Property", @@ -12269,7 +12685,7 @@ } }, { - "id": 523, + "id": 528, "name": "details", "kind": 1024, "kindString": "Property", @@ -12287,7 +12703,7 @@ } }, { - "id": 524, + "id": 529, "name": "hint", "kind": 1024, "kindString": "Property", @@ -12305,7 +12721,7 @@ } }, { - "id": 522, + "id": 527, "name": "message", "kind": 1024, "kindString": "Property", @@ -12327,7 +12743,7 @@ { "title": "Properties", "kind": 1024, - "children": [525, 523, 524, 522] + "children": [530, 528, 529, 527] } ], "sources": [ @@ -12341,7 +12757,7 @@ } }, { - "id": 518, + "id": 523, "name": "PostgrestMaybeSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -12355,7 +12771,7 @@ ], "typeParameter": [ { - "id": 519, + "id": 524, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -12364,14 +12780,14 @@ ], "type": { "type": "reference", - "id": 516, + "id": 521, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", - "id": 519, + "id": 524, "name": "T" }, { @@ -12385,7 +12801,7 @@ } }, { - "id": 514, + "id": 519, "name": "PostgrestResponse", "kind": 4194304, "kindString": "Type alias", @@ -12399,7 +12815,7 @@ ], "typeParameter": [ { - "id": 515, + "id": 520, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -12414,7 +12830,7 @@ "typeArguments": [ { "type": "reference", - "id": 515, + "id": 520, "name": "T" } ], @@ -12428,7 +12844,7 @@ } }, { - "id": 516, + "id": 521, "name": "PostgrestSingleResponse", "kind": 4194304, "kindString": "Type alias", @@ -12442,7 +12858,7 @@ ], "typeParameter": [ { - "id": 517, + "id": 522, "name": "T", "kind": 131072, "kindString": "Type parameter", @@ -12457,7 +12873,7 @@ "typeArguments": [ { "type": "reference", - "id": 517, + "id": 522, "name": "T" } ], @@ -12475,12 +12891,12 @@ { "title": "Classes", "kind": 128, - "children": [481, 1, 111, 46, 392] + "children": [486, 1, 110, 49, 394] }, { "title": "Type Aliases", "kind": 4194304, - "children": [520, 518, 514, 516] + "children": [525, 523, 519, 521] } ], "sources": [ diff --git a/spec/supabase_js_v2_legacy.yml b/spec/supabase_js_v2_legacy.yml index 67b89d38ffe..d9efbf6140f 100644 --- a/spec/supabase_js_v2_legacy.yml +++ b/spec/supabase_js_v2_legacy.yml @@ -565,7 +565,7 @@ pages: type: 'recovery', email: 'email@example.com' }) - ``` + ``` - name: Generate a link to change email addresses isSpotlight: false js: | @@ -575,7 +575,7 @@ pages: email: 'old.email@example.com', newEmail: 'new.email@example.com' }) - ``` + ``` auth.admin.updateUserById(): title: 'updateUserById()'