public inbox for [email protected]
help / color / mirror / Atom feedFrom: David G. Johnston <[email protected]>
To: Sebastien Flaesch <[email protected]>
To: Pg Docs <[email protected]>
Subject: Re: Missing example for SAVEPOINT using the same savepoint name
Date: Tue, 12 Apr 2022 07:41:37 -0700
Message-ID: <CAKFQuwYzSb9OW5qTFgc0v9RWMN8bX83wpe8okQ7x6vtcmfA2KQ@mail.gmail.com> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
On Mon, Apr 11, 2022 at 9:43 AM PG Doc comments form <[email protected]>
wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/14/sql-savepoint.html
> Description:
>
> The "Compatibility" section deserves some code example to illustrate the
> behavior when reusing the same savepoint name.
>
>
I agree with the premise but not the implementation. I've attached (and
inlined) a patch that implements the example change, updates savepoint to
introduce the behavior prior to the example, and updates the rollback to
savepoint to note the behavior as well.
commit e921441f22bad972393144628c7ee48845d5384c
Author: David G. Johnston <[email protected]>
Date: Tue Apr 12 14:30:11 2022 +0000
doc: Improve docs regarding savepoint name reuse
Per documentation comment the savepoint command lacks an example
where the savepoint name is reused. The suggested example didn't
conform to the others on the page, nor did the suggested location
in compatibility seem desirable, but the omission rang true. Add
another example to the examples section demonstrating this case.
Additionally, document under the description for savepoint_name
that we allow for the name to be repeated - and note what that
means in terms of release and rollback. It seems desirable to
place this comment in description rather than notes for savepoint.
For the other two commands the behavior in the presence of
duplicate savepoint names best fits as notes. In fact release
already had one. This commit copies the same verbiage over to
rollback.
diff --git a/doc/src/sgml/ref/rollback_to.sgml
b/doc/src/sgml/ref/rollback_to.sgml
index 3d5a241e1a..7bd1b41feb 100644
--- a/doc/src/sgml/ref/rollback_to.sgml
+++ b/doc/src/sgml/ref/rollback_to.sgml
@@ -89,6 +89,12 @@ ROLLBACK [ WORK | TRANSACTION ] TO [ SAVEPOINT ]
<replaceable>savepoint_name</re
cannot-execute state, so while the transaction can be restored using
<command>ROLLBACK TO SAVEPOINT</command>, the cursor can no longer be
used.
</para>
+
+ <para>
+ If multiple savepoints have the same name, only the one that was most
+ recently defined is released.
+ </para>
+
</refsect1>
<refsect1>
diff --git a/doc/src/sgml/ref/savepoint.sgml
b/doc/src/sgml/ref/savepoint.sgml
index b17342a1ee..fd017935ea 100644
--- a/doc/src/sgml/ref/savepoint.sgml
+++ b/doc/src/sgml/ref/savepoint.sgml
@@ -53,7 +53,9 @@ SAVEPOINT <replaceable>savepoint_name</replaceable>
<term><replaceable>savepoint_name</replaceable></term>
<listitem>
<para>
- The name to give to the new savepoint.
+ The name to give to the new savepoint. The name may already exist,
+ in which case a rollback or release to the same name will use the
+ one that was most recently defined.
</para>
</listitem>
</varlistentry>
@@ -106,6 +108,25 @@ COMMIT;
</programlisting>
The above transaction will insert both 3 and 4.
</para>
+
+ <para>
+ To use a single savepoint name:
+<programlisting>
+BEGIN;
+ INSERT INTO table1 VALUES (1);
+ SAVEPOINT my_savepoint;
+ INSERT INTO table1 VALUES (2);
+ SAVEPOINT my_savepoint;
+ INSERT INTO table1 VALUES (3);
+ ROLLBACK TO SAVEPOINT my_savepoint;
+ SELECT * FROM table1; // 1, 2
+ ROLLBACK TO SAVEPOINT my_savepoint;
+ SELECT * FROM table1; // just 1
+COMMIT;
+</programlisting>
+ The above transaction shows row 3 being rolled back first then row 2.
+ </para>
+
</refsect1>
<refsect1>
Attachments:
[application/octet-stream] v0001-doc-savepoint-name-reuse.patch (2.9K, 3-v0001-doc-savepoint-name-reuse.patch)
download | inline diff:
commit e921441f22bad972393144628c7ee48845d5384c
Author: David G. Johnston <[email protected]>
Date: Tue Apr 12 14:30:11 2022 +0000
doc: Improve docs regarding savepoint name reuse
Per documentation comment the savepoint command lacks an example
where the savepoint name is reused. The suggested example didn't
conform to the others on the page, nor did the suggested location
in compatibility seem desirable, but the omission rang true. Add
another example to the examples section demonstrating this case.
Additionally, document under the description for savepoint_name
that we allow for the name to be repeated - and note what that
means in terms of release and rollback. It seems desirable to
place this comment in description rather than notes for savepoint.
For the other two commands the behavior in the presence of
duplicate savepoint names best fits as notes. In fact release
already had one. This commit copies the same verbiage over to
rollback.
diff --git a/doc/src/sgml/ref/rollback_to.sgml b/doc/src/sgml/ref/rollback_to.sgml
index 3d5a241e1a..7bd1b41feb 100644
--- a/doc/src/sgml/ref/rollback_to.sgml
+++ b/doc/src/sgml/ref/rollback_to.sgml
@@ -89,6 +89,12 @@ ROLLBACK [ WORK | TRANSACTION ] TO [ SAVEPOINT ] <replaceable>savepoint_name</re
cannot-execute state, so while the transaction can be restored using
<command>ROLLBACK TO SAVEPOINT</command>, the cursor can no longer be used.
</para>
+
+ <para>
+ If multiple savepoints have the same name, only the one that was most
+ recently defined is released.
+ </para>
+
</refsect1>
<refsect1>
diff --git a/doc/src/sgml/ref/savepoint.sgml b/doc/src/sgml/ref/savepoint.sgml
index b17342a1ee..fd017935ea 100644
--- a/doc/src/sgml/ref/savepoint.sgml
+++ b/doc/src/sgml/ref/savepoint.sgml
@@ -53,7 +53,9 @@ SAVEPOINT <replaceable>savepoint_name</replaceable>
<term><replaceable>savepoint_name</replaceable></term>
<listitem>
<para>
- The name to give to the new savepoint.
+ The name to give to the new savepoint. The name may already exist,
+ in which case a rollback or release to the same name will use the
+ one that was most recently defined.
</para>
</listitem>
</varlistentry>
@@ -106,6 +108,25 @@ COMMIT;
</programlisting>
The above transaction will insert both 3 and 4.
</para>
+
+ <para>
+ To use a single savepoint name:
+<programlisting>
+BEGIN;
+ INSERT INTO table1 VALUES (1);
+ SAVEPOINT my_savepoint;
+ INSERT INTO table1 VALUES (2);
+ SAVEPOINT my_savepoint;
+ INSERT INTO table1 VALUES (3);
+ ROLLBACK TO SAVEPOINT my_savepoint;
+ SELECT * FROM table1; // 1, 2
+ ROLLBACK TO SAVEPOINT my_savepoint;
+ SELECT * FROM table1; // just 1
+COMMIT;
+</programlisting>
+ The above transaction shows row 3 being rolled back first then row 2.
+ </para>
+
</refsect1>
<refsect1>
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected], [email protected]
Subject: Re: Missing example for SAVEPOINT using the same savepoint name
In-Reply-To: <CAKFQuwYzSb9OW5qTFgc0v9RWMN8bX83wpe8okQ7x6vtcmfA2KQ@mail.gmail.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox