Skip to content

docs: add note to resource embedding and vertical filtering section #4446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: add note to resource embedding and vertical filtering section #4446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/references/api/resource_embedding.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ Resource Embedding

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

.. note::

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`.
Copy link
Member

@wolfgangwalther wolfgangwalther Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After reading the discussion about the breaking change again, I think we should not document this behavior. This is a bug that needs to be fixed by throwing an error accordingly.

Copy link
Member

@laurenceisla laurenceisla Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we consider it a bug if we are actively testing for it (and for a while now)?

postgrest/test/spec/Feature/Query/DeleteSpec.hs

Lines 73 to 78 in bccf7ac

it "can embed (parent) entities" $
request methodDelete "/tasks?id=eq.8&select=id,name,project:projects(id)" [("Prefer", "return=representation")] ""
`shouldRespondWith` [json|[{"id":8,"name":"Code OSX","project":{"id":4}}]|]
{ matchStatus = 200
, matchHeaders = ["Content-Range" <:> "*/*"]
}

Not against removing this behavior, but I think it could still be considered a breaking change due to these tests.


.. _fk_join:

Foreign Key Joins
Expand Down
4 changes: 4 additions & 0 deletions docs/references/api/tables_views.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,10 @@ When certain columns are wide (such as those holding binary data), it is more ef

The default is ``*``, meaning all columns. This value will become more important below in :ref:`resource_embedding`.

.. note::

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`.

.. _renaming_columns:

Renaming Columns
Expand Down