Skip to content

Commit 1ea94b0

Browse files
committed
docs: add note to resource embedding and vertical filtering section
Adds a note about resource embedding and vertical filtering sections when they are combined with mutation queries. This resolves #4352. Signed-off-by: Taimoor Zaeem <[email protected]>
1 parent 893e006 commit 1ea94b0

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/references/api/resource_embedding.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Resource Embedding
55

66
PostgREST allows including related resources in a single API call. This reduces the need for many API requests.
77

8+
.. note::
9+
10+
It is **not** possible to perform mutations *on* related resources. When combining mutations and resource embedding, the mutation is performed first and then the related resource is returned in combination with :ref:`prefer_return`.
11+
812
.. _fk_join:
913

1014
Foreign Key Joins

docs/references/api/tables_views.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,10 @@ When certain columns are wide (such as those holding binary data), it is more ef
246246
247247
The default is ``*``, meaning all columns. This value will become more important below in :ref:`resource_embedding`.
248248

249+
.. note::
250+
251+
It is **not** possible to perform mutations *on* filtered data. When combining mutations and vertical filtering, the mutation is performed first and then the filter is applied in combination with :ref:`prefer_return`.
252+
249253
.. _renaming_columns:
250254

251255
Renaming Columns

0 commit comments

Comments
 (0)