summaryrefslogtreecommitdiff
path: root/docs/ref/contrib/postgres/functions.txt
blob: ba73d26f06e0912423f1aaceba7e306dd0a25db8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
======================================
PostgreSQL specific database functions
======================================

All of these functions are available from the
``django.contrib.postgres.functions`` module.

.. currentmodule:: django.contrib.postgres.functions

``RandomUUID``
==============

.. class:: RandomUUID()

Returns a version 4 UUID.

Usage example:

.. code-block:: pycon

    >>> from django.contrib.postgres.functions import RandomUUID
    >>> Article.objects.update(uuid=RandomUUID())

.. admonition:: Use :class:`django.db.models.functions.UUID4` instead.

    :class:`django.db.models.functions.UUID4` is a cross-database version of
    this function. ``RandomUUID`` may be deprecated in the future.

``TransactionNow``
==================

.. class:: TransactionNow()

Returns the date and time on the database server that the current transaction
started. If you are not in a transaction it will return the date and time of
the current statement. This is a complement to
:class:`django.db.models.functions.Now`, which returns the date and time of the
current statement.

Note that only the outermost call to :func:`~django.db.transaction.atomic`
sets up a transaction and thus sets the time that ``TransactionNow()`` will
return; nested calls create savepoints which do not affect the transaction
time.

Usage example:

.. code-block:: pycon

    >>> from django.contrib.postgres.functions import TransactionNow
    >>> Article.objects.filter(published__lte=TransactionNow())
    <QuerySet [<Article: How to Django>]>