jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add a warning when working with computed relationships

Browse Source
This commit is contained in:
Laurence Isla
2023-04-21 17:04:31 -05:00
committed by GitHub
parent 516a4daacf
commit f55ced0306
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api.rst
+7 -1
View File
@@ -1174,7 +1174,13 @@ Taking advantage of overloaded functions, you can use the same function name for
select * from directors where film_school_id = $1.id select * from directors where film_school_id = $1.id
$$ stable language sql; $$ stable language sql;
Computed relationships have good performance as they follow the `Inlining conditions for table functions <https://wiki.postgresql.org/wiki/Inlining_of_SQL_functions#Inlining_conditions_for_table_functions>`_. Computed relationships have good performance as their intended design follow the `Inlining conditions for table functions <https://wiki.postgresql.org/wiki/Inlining_of_SQL_functions#Inlining_conditions_for_table_functions>`_.
.. warning::
- Always use ``SETOF`` when creating computed relationships. Functions can return a table without using ``SETOF``, but bear in mind that they will not be inlined.
- Make sure to correctly label the ``to-one`` part of the relationship. When using the ``ROWS 1`` estimation, PostgREST will expect a single row to be returned. If that is not the case, then it will unnest the embedding and return repeated values for the top level resource.
.. _nested_embedding: .. _nested_embedding: