summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authordrd0013 <rob.davis@drdiii.com>2018-04-19 17:07:40 -0700
committerTim Graham <timograham@gmail.com>2018-04-19 20:07:40 -0400
commit5d923f2d8cadb06497d255097caa4583d66b697a (patch)
tree97729876a5e4b7d1534e3559e5b1180029707234 /docs
parent534d8d875eebac6aee278f0ffa6cc59760dac546 (diff)
Fixed #29313 -- Doc'd how to use F() to sort null values.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/models/expressions.txt17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/ref/models/expressions.txt b/docs/ref/models/expressions.txt
index 70e3a58616..1fdc5f7116 100644
--- a/docs/ref/models/expressions.txt
+++ b/docs/ref/models/expressions.txt
@@ -228,6 +228,21 @@ primary key value rather than a model instance::
>> car.built_by
3
+.. _using-f-to-sort-null-values:
+
+Using ``F()`` to sort null values
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use ``F()`` and the ``nulls_first`` or ``nulls_last`` keyword argument to
+:meth:`.Expression.asc` or :meth:`~.Expression.desc` to control the ordering of
+a field's null values. By default, the ordering depends on your database.
+
+For example, to sort companies that haven't been contacted (``last_contacted``
+is null) after companies that have been contacted::
+
+ from django.db.models import F
+ Company.object.order_by(F('last_contacted').desc(nulls_last=True))
+
.. _func-expressions:
``Func()`` expressions
@@ -971,12 +986,14 @@ calling the appropriate methods on the wrapped expression.
Returns the expression ready to be sorted in ascending order.
``nulls_first`` and ``nulls_last`` define how null values are sorted.
+ See :ref:`using-f-to-sort-null-values` for example usage.
.. method:: desc(nulls_first=False, nulls_last=False)
Returns the expression ready to be sorted in descending order.
``nulls_first`` and ``nulls_last`` define how null values are sorted.
+ See :ref:`using-f-to-sort-null-values` for example usage.
.. method:: reverse_ordering()