Skip to content

Commit

Permalink
docs: add a new spread operator ".."
Browse files Browse the repository at this point in the history
  • Loading branch information
laurenceisla committed Sep 25, 2024
1 parent 3b920c7 commit 87a13ef
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/references/api/resource_embedding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1235,3 +1235,33 @@ For these relationships, the spread embedded resource columns will be aggregated
The order of the values inside the resulting array is unspecified.
However, if more than one embedded column is selected, `it is safe to assume <https://www.postgresql.org/message-id/15950.1491843689%40sss.pgh.pa.us>`_ that all of them will return the values in the same unspecified order.
From the previous example, we can say that "Pulp Fiction" was made in 1994 and "Reservoir Dogs" in 1992.
It is expected to get duplicated or null values inside the aggregated array.
So you can use the ``..`` operator to solve this.
For example, a film could get nominated in the same year for different competitions.
To get only the distinct years we would do:
.. code-block:: bash
# curl "http://localhost:3000/films?select=title,..competitions(competition_years:year)"
curl --get "http://localhost:3000/films" \
-d "select=title,..competitions(competition_years:year)"
.. code-block:: json
[
{
"title": "Pulp Fiction",
"competition_years": [
1994,
1995
]
},
".."
]
The ``..`` operator works as if you were using ``...`` on:
* One-to-one or many-to-one relationships.
* :ref:`aggregate_functions`, since they will include the duplicated values in the aggregate.

0 comments on commit 87a13ef

Please sign in to comment.