summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/db-api.txt6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/db-api.txt b/docs/db-api.txt
index a83b7dad6a..bb0011d6e2 100644
--- a/docs/db-api.txt
+++ b/docs/db-api.txt
@@ -398,7 +398,11 @@ which rows are returned. Both ``limit`` and ``offset`` should be integers which
will be directly passed to the SQL ``LIMIT``/``OFFSET`` commands.
If ``distinct`` is True, only distinct rows will be returned. This is equivalent
-to a ``SELECT DISTINCT`` SQL clause.
+to a ``SELECT DISTINCT`` SQL clause. You can use this with ``get_values()`` to
+get distinct values. For example, this returns the distinct first_names::
+
+ >>> people.get_values(fields=['first_name'], distinct=True)
+ [{'first_name': 'Adrian'}, {'first_name': 'Jacob'}, {'first_name': 'Simon'}]
Other lookup options
====================