summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2020-10-17 16:02:47 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2020-10-17 16:02:47 -0400
commitc1a3188baeda2414a7a7453917d73aa5db511067 (patch)
treeda7a15fff522679ca4b63a60d208728ea90537ae
parent13dbf4ab82ea4ebe32aa178fcc7535f95a08de2f (diff)
Doc: caution against misuse of 'now' and related datetime literals.
Section 8.5.1.4, which defines these literals, made only a vague reference to the fact that they might be evaluated too soon to be safe in non-interactive contexts. Provide a more explicit caution against misuse. Also, generalize the wording in the related tip in section 9.9.4: while it clearly described this problem, it implied (or really, stated outright) that the problem only applies to table DEFAULT clauses. Per gripe from Tijs van Dam. Back-patch to all supported branches. Discussion: https://postgr.es/m/c2LuRv9BiRT3bqIo5mMQiVraEXey_25B4vUn0kDqVqilwOEu_iVF1tbtvLnyQK7yDG3PFaz_GxLLPil2SDkj1MCObNRVaac-7j1dVdFERk8=@thalex.com
-rw-r--r--doc/src/sgml/datatype.sgml20
-rw-r--r--doc/src/sgml/func.sgml8
2 files changed, 22 insertions, 6 deletions
diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml
index 8ec92f9ba8c..22f5eed5c3d 100644
--- a/doc/src/sgml/datatype.sgml
+++ b/doc/src/sgml/datatype.sgml
@@ -2121,7 +2121,7 @@ January 8 04:05:06 1999 PST
</para>
</sect3>
- <sect3>
+ <sect3 id="datatype-datetime-special-values">
<title>Special Values</title>
<indexterm>
@@ -2209,12 +2209,26 @@ January 8 04:05:06 1999 PST
type:
<literal>CURRENT_DATE</literal>, <literal>CURRENT_TIME</literal>,
<literal>CURRENT_TIMESTAMP</literal>, <literal>LOCALTIME</literal>,
- <literal>LOCALTIMESTAMP</literal>. The latter four accept an
- optional subsecond precision specification. (See <xref
+ <literal>LOCALTIMESTAMP</literal>. (See <xref
linkend="functions-datetime-current">.) Note that these are
SQL functions and are <emphasis>not</> recognized in data input strings.
</para>
+ <caution>
+ <para>
+ While the input strings <literal>now</literal>,
+ <literal>today</literal>, <literal>tomorrow</literal>,
+ and <literal>yesterday</literal> are fine to use in interactive SQL
+ commands, they can have surprising behavior when the command is
+ saved to be executed later, for example in prepared statements,
+ views, and function definitions. The string can be converted to a
+ specific time value that continues to be used long after it becomes
+ stale. Use one of the SQL functions instead in such contexts.
+ For example, <literal>CURRENT_DATE + 1</literal> is safer than
+ <literal>'tomorrow'::date</literal>.
+ </para>
+ </caution>
+
</sect3>
</sect2>
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 96edf78983a..60c3d2a579e 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -8148,20 +8148,22 @@ now()
<programlisting>
SELECT CURRENT_TIMESTAMP;
SELECT now();
-SELECT TIMESTAMP 'now'; -- incorrect for use with DEFAULT
+SELECT TIMESTAMP 'now'; -- but see tip below
</programlisting>
</para>
<tip>
<para>
- You do not want to use the third form when specifying a <literal>DEFAULT</>
- clause while creating a table. The system will convert <literal>now</literal>
+ Do not use the third form when specifying a value to be evaluated later,
+ for example in a <literal>DEFAULT</literal> clause for a table column.
+ The system will convert <literal>now</literal>
to a <type>timestamp</type> as soon as the constant is parsed, so that when
the default value is needed,
the time of the table creation would be used! The first two
forms will not be evaluated until the default value is used,
because they are function calls. Thus they will give the desired
behavior of defaulting to the time of row insertion.
+ (See also <xref linkend="datatype-datetime-special-values">.)
</para>
</tip>
</sect2>