From: Michael Paquier <michael@paquier.xyz>
Date: Fri, 26 Jun 2026 01:47:32 +0000 (+0900)
Subject: doc: Improve description of pg_get_multixact_stats()
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fheads%2Fmaster;p=thirdparty%2Fpostgresql.git

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
---

diff --git a/doc/src/sgml/func/func-info.sgml b/doc/src/sgml/func/func-info.sgml
index 34f4019690f..211bc8b238b 100644
--- a/doc/src/sgml/func/func-info.sgml
+++ b/doc/src/sgml/func/func-info.sgml
@@ -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.