1
0
mirror of https://github.com/postgres/postgres.git synced 2026-10-23 13:29:09 +03:00

doc: Improve description of pg_get_multixact_stats()

This addresses two gaps in the documentation:
- The function uses an xid, and was not mentioned as an exception in a
section of the docs related to xid8.
- The function returns NULL if a role does not have the privileges of
pg_read_all_stats.  The execution is not denied.

Author: Chao Li <li.evan.chao@gmail.com>
Author: Yingying Chen <cyy9255@gmail.com>
Discussion: https://postgr.es/m/CAGGTb65Qmtor2nJP-ATgfWpMpD2qhKrdyO7fmRbbS++nQ=vtMw@mail.gmail.com
This commit is contained in:
Michael Paquier
2026-06-26 10:47:32 +09:00
parent 6468f7a853
commit 30937c60cd

View File

@@ -3020,8 +3020,9 @@ acl | {postgres=arwdDxtm/postgres,foo=r/postgres}
vary between calls, even within a single transaction.
</para>
<para>
To use this function, you must have privileges of the
<literal>pg_read_all_stats</literal> role.
By default, all columns are shown as <literal>NULL</literal> unless
the user has privileges of the <literal>pg_read_all_stats</literal>
role.
</para></entry>
</row>
</tbody>
@@ -3032,8 +3033,9 @@ acl | {postgres=arwdDxtm/postgres,foo=r/postgres}
The internal transaction ID type <type>xid</type> is 32 bits wide and
wraps around every 4 billion transactions. However,
the functions shown in <xref linkend="functions-pg-snapshot"/>, except
<function>age</function>, <function>mxid_age</function>, and
<function>pg_get_multixact_members</function>, use a
<function>age</function>, <function>mxid_age</function>,
<function>pg_get_multixact_members</function>, and
<function>pg_get_multixact_stats</function>, use a
64-bit type <type>xid8</type> that does not wrap around during the life
of an installation and can be converted to <type>xid</type> by casting if
required; see <xref linkend="transaction-id"/> for details.