aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2016-05-07 13:16:50 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2016-05-07 13:16:50 -0400
commit691d99de386aa1f5a858e04634dbaaba48488ef8 (patch)
tree2c738c6ec6750fc92482e25fcf87d840861f7c74
parent7dc1d359699345a2b2af6af6d21bd6f7bd6cfb27 (diff)
downloadpostgresql-691d99de386aa1f5a858e04634dbaaba48488ef8.tar.gz
postgresql-691d99de386aa1f5a858e04634dbaaba48488ef8.zip
Docs: improve warnings about nextval() not producing gapless sequences.
In the documentation for nextval(), point out explicitly that INSERT ... ON CONFLICT will call nextval() if needed for the insertion case, whether or not it ends up following the ON CONFLICT path. This seems to be a matter of some confusion, cf bug #14126, so let's be clear about it. Also mention the issue in the CREATE SEQUENCE reference page, since that is another place where people might expect such things to be covered. Minor wording improvements nearby, as well. Back-patch to 9.5 where ON CONFLICT was introduced.
-rw-r--r--doc/src/sgml/func.sgml22
-rw-r--r--doc/src/sgml/ref/create_sequence.sgml10
2 files changed, 24 insertions, 8 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index c8dd838d253..3f627dc885f 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -11512,13 +11512,19 @@ nextval('foo'::text) <lineannotation><literal>foo</literal> is looked up at
<important>
<para>
- To avoid blocking concurrent transactions that obtain numbers from the
- same sequence, a <function>nextval</function> operation is never
+ To avoid blocking concurrent transactions that obtain numbers from
+ the same sequence, a <function>nextval</function> operation is never
rolled back; that is, once a value has been fetched it is considered
- used, even if the transaction that did the
- <function>nextval</function> later aborts. This means that aborted
- transactions might leave unused <quote>holes</quote> in the sequence
- of assigned values.
+ used and will not be returned again. This is true even if the
+ surrounding transaction later aborts, or if the calling query ends
+ up not using the value. For example an <command>INSERT</> with
+ an <literal>ON CONFLICT</> clause will compute the to-be-inserted
+ tuple, including doing any required <function>nextval</function>
+ calls, before detecting any conflict that would cause it to follow
+ the <literal>ON CONFLICT</> rule instead. Such cases will leave
+ unused <quote>holes</quote> in the sequence of assigned values.
+ Thus, <productname>PostgreSQL</> sequence objects <emphasis>cannot
+ be used to obtain <quote>gapless</> sequences</emphasis>.
</para>
</important>
@@ -11547,8 +11553,8 @@ nextval('foo'::text) <lineannotation><literal>foo</literal> is looked up at
Return the value most recently returned by
<function>nextval</> in the current session. This function is
identical to <function>currval</function>, except that instead
- of taking the sequence name as an argument it fetches the
- value of the last sequence used by <function>nextval</function>
+ of taking the sequence name as an argument it refers to whichever
+ sequence <function>nextval</function> was most recently applied to
in the current session. It is an error to call
<function>lastval</function> if <function>nextval</function>
has not yet been called in the current session.
diff --git a/doc/src/sgml/ref/create_sequence.sgml b/doc/src/sgml/ref/create_sequence.sgml
index 9e364ff2409..c9591462eed 100644
--- a/doc/src/sgml/ref/create_sequence.sgml
+++ b/doc/src/sgml/ref/create_sequence.sgml
@@ -240,6 +240,16 @@ SELECT * FROM <replaceable>name</replaceable>;
</para>
<para>
+ Because <function>nextval</> and <function>setval</> calls are never
+ rolled back, sequence objects cannot be used if <quote>gapless</>
+ assignment of sequence numbers is needed. It is possible to build
+ gapless assignment by using exclusive locking of a table containing a
+ counter; but this solution is much more expensive than sequence
+ objects, especially if many transactions need sequence numbers
+ concurrently.
+ </para>
+
+ <para>
Unexpected results might be obtained if a <replaceable
class="parameter">cache</replaceable> setting greater than one is
used for a sequence object that will be used concurrently by