From 9675ab239b54f36db2187fb06fc56a1851f06f5a Mon Sep 17 00:00:00 2001 From: Taimoor Zaeem Date: Wed, 2 Jul 2025 11:09:39 +0500 Subject: [PATCH] docs: horizontal filtering on table-valued functions --- docs/postgrest.dict | 1 + docs/references/api/functions.rst | 17 +++++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/postgrest.dict b/docs/postgrest.dict index 9e0590952..a49a0c688 100644 --- a/docs/postgrest.dict +++ b/docs/postgrest.dict @@ -168,6 +168,7 @@ unikernel unix updatable unfulfillable +unselected Untyped UPSERT Upsert diff --git a/docs/references/api/functions.rst b/docs/references/api/functions.rst index c251db27c..b6eb9ed25 100644 --- a/docs/references/api/functions.rst +++ b/docs/references/api/functions.rst @@ -298,6 +298,23 @@ Let's get its :ref:`explain_plan` when calling it with filters applied: Notice there's no "Function Scan" node in the plan, which tells us it has been inlined. +Horizontal Filtering +~~~~~~~~~~~~~~~~~~~~ + +Table-valued functions support horizontal filtering on selected and unselected columns. + +For example, the following RPC with filter on unselected column returns: + +.. code-block:: bash + + curl "http://localhost:3000/rpc/getallprojects?select=id,client_id&name=like.OSX" + +.. code-block:: json + + [ + { "id": 4, "client_id": 2 } + ] + .. _scalar_functions: Scalar functions