summaryrefslogtreecommitdiff
path: root/docs/ref/contrib/postgres
diff options
context:
space:
mode:
authorHannes Ljungberg <hannes.ljungberg@gmail.com>2020-11-20 21:35:04 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2021-07-06 07:36:52 +0200
commita06b977a91f043c509df781670fb4cf35cb437b7 (patch)
tree41cc0a5d6d8b106e2c3b4d0813a2bd88875e1d02 /docs/ref/contrib/postgres
parent49ca6bbc445cb75ee742b215f5f90465ad8e7309 (diff)
downloaddjango-a06b977a91f043c509df781670fb4cf35cb437b7.tar.gz
Fixed #32776 -- Added support for Array subqueries on PostgreSQL.
Diffstat (limited to 'docs/ref/contrib/postgres')
-rw-r--r--docs/ref/contrib/postgres/expressions.txt37
-rw-r--r--docs/ref/contrib/postgres/index.txt1
2 files changed, 38 insertions, 0 deletions
diff --git a/docs/ref/contrib/postgres/expressions.txt b/docs/ref/contrib/postgres/expressions.txt
new file mode 100644
index 0000000000..79590c2393
--- /dev/null
+++ b/docs/ref/contrib/postgres/expressions.txt
@@ -0,0 +1,37 @@
+=====================================
+PostgreSQL specific query expressions
+=====================================
+
+.. module:: django.contrib.postgres.expressions
+ :synopsis: PostgreSQL specific query expressions
+
+These expressions are available from the
+``django.contrib.postgres.expressions`` module.
+
+``ArraySubquery()`` expressions
+===============================
+
+.. class:: ArraySubquery(queryset)
+
+.. versionadded:: 4.0
+
+``ArraySubquery`` is a :class:`~django.db.models.Subquery` that uses the
+PostgreSQL ``ARRAY`` constructor to build a list of values from the queryset,
+which must use :meth:`.QuerySet.values` to return only a single column.
+
+This class differs from :class:`~django.contrib.postgres.aggregates.ArrayAgg`
+in the way that it does not act as an aggregate function and does not require
+an SQL ``GROUP BY`` clause to build the list of values.
+
+For example, if you want to annotate all related books to an author as JSON
+objects::
+
+ >>> from django.db.models import OuterRef
+ >>> from django.db.models.functions import JSONObject
+ >>> from django.contrib.postgres.expressions import ArraySubquery
+ >>> books = Book.objects.filter(author=OuterRef('pk')).values(
+ ... json=JSONObject(title='title', pages='pages')
+ ... )
+ >>> author = Author.objects.annotate(books=ArraySubquery(books)).first()
+ >>> author.books
+ [{'title': 'Solaris', 'pages': 204}, {'title': 'The Cyberiad', 'pages': 295}]
diff --git a/docs/ref/contrib/postgres/index.txt b/docs/ref/contrib/postgres/index.txt
index 03ff6da1e0..7627043037 100644
--- a/docs/ref/contrib/postgres/index.txt
+++ b/docs/ref/contrib/postgres/index.txt
@@ -30,6 +30,7 @@ a number of PostgreSQL specific data types.
aggregates
constraints
+ expressions
fields
forms
functions