summaryrefslogtreecommitdiff
path: root/docs/topics
diff options
context:
space:
mode:
authorJacob Walls <jacobtylerwalls@gmail.com>2025-01-05 10:09:46 -0500
committerSarah Boyce <42296566+sarahboyce@users.noreply.github.com>2025-01-07 11:42:06 +0100
commit470e5545e56e8510f9b9d39a96d7094fedd9c45a (patch)
tree371d33bcc1bcbbf205137aa6627b17fa4f751e6f /docs/topics
parent6eec703667505d87d1354323548943c8d546c5a2 (diff)
Refs #36042 -- Raised ValueError when providing composite expressions to aggregates.
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/composite-primary-key.txt10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/topics/composite-primary-key.txt b/docs/topics/composite-primary-key.txt
index 9e5234ca9f..f252f318c1 100644
--- a/docs/topics/composite-primary-key.txt
+++ b/docs/topics/composite-primary-key.txt
@@ -131,6 +131,8 @@ database.
``ForeignObject`` is an internal API. This means it is not covered by our
:ref:`deprecation policy <internal-release-deprecation-policy>`.
+.. _cpk-and-database-functions:
+
Composite primary keys and database functions
=============================================
@@ -141,13 +143,15 @@ Many database functions only accept a single expression.
MAX("order_id") -- OK
MAX("product_id", "order_id") -- ERROR
-As a consequence, they cannot be used with composite primary key references as
-they are composed of multiple column expressions.
+In these cases, providing a composite primary key reference raises a
+``ValueError``, since it is composed of multiple column expressions. An
+exception is made for ``Count``.
.. code-block:: python
Max("order_id") # OK
- Max("pk") # ERROR
+ Max("pk") # ValueError
+ Count("pk") # OK
Composite primary keys in forms
===============================