summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClaude Paroz <claude@2xlibre.net>2021-05-17 09:19:18 +0200
committerCarlton Gibson <carlton@noumenal.es>2021-07-07 10:13:32 +0200
commit7309393c3a7dea7a34a1446e102df7432c4e7357 (patch)
tree26e03addde3cb6ff281382277d8b49240346d9d0
parent6a5ef557f80a8eb6a758ebe99c8bb477ca47459e (diff)
downloaddjango-7309393c3a7dea7a34a1446e102df7432c4e7357.tar.gz
Documented in_bulk behavior with nonexistent id_list items.
Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
-rw-r--r--docs/ref/models/querysets.txt5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt
index 1201800567..c24079ec10 100644
--- a/docs/ref/models/querysets.txt
+++ b/docs/ref/models/querysets.txt
@@ -2294,7 +2294,10 @@ database query like ``count()`` would.
Takes a list of field values (``id_list``) and the ``field_name`` for those
values, and returns a dictionary mapping each value to an instance of the
-object with the given field value. If ``id_list`` isn't provided, all objects
+object with the given field value. No
+:exc:`django.core.exceptions.ObjectDoesNotExist` exceptions will ever be raised
+by ``in_bulk``; that is, any ``id_list`` value not matching any instance will
+simply be ignored. If ``id_list`` isn't provided, all objects
in the queryset are returned. ``field_name`` must be a unique field or a
distinct field (if there's only one field specified in :meth:`distinct`).
``field_name`` defaults to the primary key.