8000 Document pg_get_multixact_members(). · postgres/postgres@d271b04 · GitHub
[go: up one dir, main page]

Skip to content

Commit d271b04

Browse files
nathan-bossartÁlvaro Herrera
andcommitted
Document pg_get_multixact_members().
Oversight in commit 0ac5ad5. Author: Sami Imseih <samimseih@gmail.com> Co-authored-by: Álvaro Herrera <alvherre@kurilemu.de> Reviewed-by: Ashutosh Bapat <ashutosh.bapat.oss@gmail.com> Discussion: https://postgr.es/m/20150619215231.GT133018%40postgresql.org Discussion: https://postgr.es/m/CAA5RZ0sjQDDwJfMRb%3DZ13nDLuRpF13ME2L_BdGxi0op8RKjmDg%40mail.gmail.com Backpatch-through: 13
1 parent d25d392 commit d271b04

File tree

2 files changed

+31
-2
lines changed

2 files changed

+31
-2
lines changed

doc/src/sgml/func.sgml

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25540,6 +25540,31 @@ SELECT collation for ('foo' COLLATE "de_DE");
2554025540
details.
2554125541
</para></entry>
2554225542
</row>
25543+
25544+
<row>
25545+
<entry role="func_table_entry"><para role="func_signature">
25546+
<indexterm>
25547+
<primary>pg_get_multixact_members</primary>
25548+
</indexterm>
25549+
<function>pg_get_multixact_members</function> ( <parameter>multixid</parameter> <type>xid</type> )
25550+
<returnvalue>setof record</returnvalue>
25551+
( <parameter>xid</parameter> <type>xid</type>,
25552+
<parameter>mode</parameter> <type>text</type> )
25553+
</para>
25554+
<para>
25555+
Returns the transaction ID and lock mode for each member of the
25556+
specified multixact ID. The lock modes <literal>forupd</literal>,
25557+
<literal>fornokeyupd</literal>, <literal>sh</literal>, and
25558+
<literal>keysh</literal> correspond to the row-level locks
25559+
<literal>FOR UPDATE</literal>, <literal>FOR NO KEY UPDATE</literal>,
25560+
<literal>FOR SHARE</literal>, and <literal>FOR KEY SHARE</literal>,
25561+
respectively, as described in <xref linkend="locking-rows"/>. Two
25562+
additional modes are specific to multixacts:
25563+
<literal>nokeyupd</literal>, used by updates that do not modify key
25564+
columns, and <literal>upd</literal>, used by updates or deletes that
25565+
modify key columns.
25566+
</para></entry>
25567+
</row>
2554325568
</tbody>
2554425569
</tgroup>
2554525570
</table>
@@ -25548,7 +25573,8 @@ SELECT collation for ('foo' COLLATE "de_DE");
2554825573
The internal transaction ID type <type>xid</type> is 32 bits wide and
2554925574
wraps around every 4 billion transactions. However,
2555025575
the functions shown in <xref linkend="functions-pg-snapshot"/>, except
25551-
<function>age</function> and <function>mxid_age</function>, use a
25576+
<function>age</function>, <function>mxid_age</function>, and
25577+
<function>pg_get_multixact_members</function>, use a
2555225578
64-bit type <type>xid8</type> that does not wrap around during the life
2555325579
of an installation and can be converted to <type>xid</type> by casting if
2555425580
required; see <xref linkend="transaction-id"/> for details.

doc/src/sgml/maintenance.sgml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -760,7 +760,10 @@ HINT: Stop the postmaster and vacuum that database in single-user mode.
760760
careful aging management, storage cleanup, and wraparound handling.
761761
There is a separate storage area which holds the list of members in
762762
each multixact, which also uses a 32-bit counter and which must also
763-
be managed.
763+
be managed. The system function
764+
<function>pg_get_multixact_members()</function> described in
765+
<xref linkend="functions-pg-snapshot"/> can be used to examine the
766+
transaction IDs associated with a multixact ID.
764767
</para>
765768

766769
<para>

0 commit comments

Comments
 (0)
0