Document pg_get_multixact_members().

Oversight in commit 0ac5ad5134.

Author: Sami Imseih 
Co-authored-by: Álvaro Herrera 
Reviewed-by: Ashutosh Bapat 
Discussion: https://postgr.es/m/20150619215231.GT133018%40postgresql.org
Discussion: https://postgr.es/m/CAA5RZ0sjQDDwJfMRb%3DZ13nDLuRpF13ME2L_BdGxi0op8RKjmDg%40mail.gmail.com
Backpatch-through: 13

diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 126b8cfbad81ecce0c7284adfbb695ed42802e4c..810b2b50f0da82a3d36dcca8a97bd43b17c5dd44 100644 (file)
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -27704,6 +27704,31 @@ acl      | {postgres=arwdDxtm/postgres,foo=r/postgres}
         details.
        
       
+
+      
+       
+        
+         pg_get_multixact_members
+        
+        pg_get_multixact_members ( multixid xid )
+        setof record
+        ( xid xid,
+        mode text )
+       
+       
+        Returns the transaction ID and lock mode for each member of the
+        specified multixact ID.  The lock modes forupd,
+        fornokeyupd, sh, and
+        keysh correspond to the row-level locks
+        FOR UPDATE, FOR NO KEY UPDATE,
+        FOR SHARE, and FOR KEY SHARE,
+        respectively, as described in .  Two
+        additional modes are specific to multixacts:
+        nokeyupd, used by updates that do not modify key
+        columns, and upd, used by updates or deletes that
+        modify key columns.
+       
+      
      
     
    
@@ -27712,7 +27737,8 @@ acl      | {postgres=arwdDxtm/postgres,foo=r/postgres}
     The internal transaction ID type xid is 32 bits wide and
     wraps around every 4 billion transactions.  However,
     the functions shown in , except
-    age and mxid_age, use a
+    age, mxid_age, and
+    pg_get_multixact_members, use a
     64-bit type xid8 that does not wrap around during the life
     of an installation and can be converted to xid by casting if
     required;  see  for details.

diff --git a/doc/src/sgml/maintenance.sgml b/doc/src/sgml/maintenance.sgml
index 600e4b3f2f3b8e12c4dcf0062e4f79fc9e26ab4c..e7a9f58c01582b343de5cc598aea4e51ef3f9081 100644 (file)
--- a/doc/src/sgml/maintenance.sgml
+++ b/doc/src/sgml/maintenance.sgml
@@ -779,7 +779,10 @@ HINT:  Execute a database-wide VACUUM in that database.
      careful aging management, storage cleanup, and wraparound handling.
      There is a separate storage area which holds the list of members in
      each multixact, which also uses a 32-bit counter and which must also
-     be managed.
+     be managed.  The system function
+     pg_get_multixact_members() described in
+      can be used to examine the
+     transaction IDs associated with a multixact ID.