diff options
Diffstat (limited to 'docs/ref/models')
| -rw-r--r-- | docs/ref/models/database-functions.txt | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/ref/models/database-functions.txt b/docs/ref/models/database-functions.txt index 5d13f47879..948ce4e3cc 100644 --- a/docs/ref/models/database-functions.txt +++ b/docs/ref/models/database-functions.txt @@ -148,6 +148,29 @@ and ``comment.modified``. The PostgreSQL behavior can be emulated using ``Coalesce`` if you know a sensible minimum value to provide as a default. +``JSONObject`` +-------------- + +.. class:: JSONObject(**fields) + +.. versionadded:: 3.2 + +Takes a list of key-value pairs and returns a JSON object containing those +pairs. + +Usage example:: + + >>> from django.db.models import F + >>> from django.db.models.functions import JSONObject, Lower + >>> Author.objects.create(name='Margaret Smith', alias='msmith', age=25) + >>> author = Author.objects.annotate(json_object=JSONObject( + ... name=Lower('name'), + ... alias='alias', + ... age=F('age') * 2, + ... )).get() + >>> author.json_object + {'name': 'margaret smith', 'alias': 'msmith', 'age': 50} + ``Least`` --------- |
