summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2022-08-31 22:12:30 +0200
committerGitHub <noreply@github.com>2022-08-31 22:12:30 +0200
commitcb06f5ef8c80fc6a610db0fc36fb9dc7c625335a (patch)
tree9e527b5c2e01022362d55902f2b8436e09e0df4a /docs
parent838cc0f449f96c157cb44eb91984a2753edc7f42 (diff)
Reverted "Fixed #30711 -- Doc'd django.contrib.postgres.fields.hstore.KeyTransform()."
This reverts commit 7faf25d682b8e8f4fd2006eb7dfc71ed2a2193b7. The same can be achieved with F() so there is no need to expose an extra API.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/postgres/fields.txt23
1 files changed, 7 insertions, 16 deletions
diff --git a/docs/ref/contrib/postgres/fields.txt b/docs/ref/contrib/postgres/fields.txt
index 820f6de956..29dbc0db85 100644
--- a/docs/ref/contrib/postgres/fields.txt
+++ b/docs/ref/contrib/postgres/fields.txt
@@ -343,22 +343,6 @@ transform do not change. For example::
valid for a given field. This can be done using the
:class:`~django.contrib.postgres.validators.KeysValidator`.
-KeyTransform() expression
--------------------------
-
-.. class:: hstore.KeyTransform(key_name, *args, **kwargs)
-
-Returns the value of the given ``key_name``. This allows you to annotate a key
-value. For example::
-
- >>> from django.contrib.postgres.fields.hstore import KeyTransform
- >>> Dog.objects.create(name="Rufus", data={"breed": "labrador"})
- >>> Dog.objects.create(name="Meg", data={"breed": "collie", "owner": "Bob"})
-
- >>> rufus = Dog.objects.annotate(breed=KeyTransform("breed", "data"))[0]
- >>> rufus.breed
- 'labrador'
-
Querying ``HStoreField``
------------------------
@@ -395,6 +379,13 @@ You can chain other lookups after key lookups::
>>> Dog.objects.filter(data__breed__contains='l')
<QuerySet [<Dog: Rufus>, <Dog: Meg>]>
+or use ``F()`` expressions to annotate a key value. For example::
+
+ >>> from django.db.models import F
+ >>> rufus = Dog.objects.annotate(breed=F("data__breed"))[0]
+ >>> rufus.breed
+ 'labrador'
+
If the key you wish to query by clashes with the name of another lookup, you
need to use the :lookup:`hstorefield.contains` lookup instead.