summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorahbk <alexander.holmback@gmail.com>2019-03-07 16:02:18 +0100
committerTim Graham <timograham@gmail.com>2019-03-07 10:02:18 -0500
commitd5276398046ce4a102776a1e67dcac2884d80dfe (patch)
tree99ec65f48c68bc545c666f9787ada81952c5ec5f /docs
parent38c3f7ea599d942f95a618aa25cd80395705bfa4 (diff)
Fixed #29754 -- Added is_dst parameter to Trunc database functions.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/models/database-functions.txt32
-rw-r--r--docs/releases/3.0.txt4
2 files changed, 24 insertions, 12 deletions
diff --git a/docs/ref/models/database-functions.txt b/docs/ref/models/database-functions.txt
index c6203f92c4..46b41251a0 100644
--- a/docs/ref/models/database-functions.txt
+++ b/docs/ref/models/database-functions.txt
@@ -442,7 +442,7 @@ Usage example::
``Trunc``
---------
-.. class:: Trunc(expression, kind, output_field=None, tzinfo=None, **extra)
+.. class:: Trunc(expression, kind, output_field=None, tzinfo=None, is_dst=None, **extra)
Truncates a date up to a significant component.
@@ -460,6 +460,14 @@ value. If ``output_field`` is omitted, it will default to the ``output_field``
of ``expression``. A ``tzinfo`` subclass, usually provided by ``pytz``, can be
passed to truncate a value in a specific timezone.
+The ``is_dst`` parameter indicates whether or not ``pytz`` should interpret
+nonexistent and ambiguous datetimes in daylight saving time. By default (when
+``is_dst=None``), ``pytz`` raises an exception for such datetimes.
+
+.. versionadded:: 3.0
+
+ The ``is_dst`` parameter was added.
+
Given the datetime ``2015-06-15 14:30:50.000321+00:00``, the built-in ``kind``\s
return:
@@ -525,21 +533,21 @@ Usage example::
``DateField`` truncation
~~~~~~~~~~~~~~~~~~~~~~~~
-.. class:: TruncYear(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncYear(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'year'
-.. class:: TruncMonth(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncMonth(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'month'
-.. class:: TruncWeek(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncWeek(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
Truncates to midnight on the Monday of the week.
.. attribute:: kind = 'week'
-.. class:: TruncQuarter(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncQuarter(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'quarter'
@@ -603,19 +611,19 @@ truncate function. It's also registered as a transform on ``DateTimeField`` as
truncate function. It's also registered as a transform on ``DateTimeField`` as
``__time``.
-.. class:: TruncDay(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncDay(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'day'
-.. class:: TruncHour(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncHour(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'hour'
-.. class:: TruncMinute(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncMinute(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'minute'
-.. class:: TruncSecond(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncSecond(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'second'
@@ -653,15 +661,15 @@ Usage example::
``TimeField`` truncation
~~~~~~~~~~~~~~~~~~~~~~~~
-.. class:: TruncHour(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncHour(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'hour'
-.. class:: TruncMinute(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncMinute(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'minute'
-.. class:: TruncSecond(expression, output_field=None, tzinfo=None, **extra)
+.. class:: TruncSecond(expression, output_field=None, tzinfo=None, is_dst=None, **extra)
.. attribute:: kind = 'second'
diff --git a/docs/releases/3.0.txt b/docs/releases/3.0.txt
index 7d09d94399..1d4df533bd 100644
--- a/docs/releases/3.0.txt
+++ b/docs/releases/3.0.txt
@@ -164,6 +164,10 @@ Models
* Added the :class:`~django.db.models.functions.MD5` database function.
+* The new ``is_dst`` parameter of the
+ :class:`~django.db.models.functions.Trunc` database functions determines the
+ treatment of nonexistent and ambiguous datetimes.
+
Requests and Responses
~~~~~~~~~~~~~~~~~~~~~~