doc: Fix section of functions age(xid) and mxid_age(xid)
authorMichael Paquier
Wed, 20 Nov 2024 05:20:52 +0000 (14:20 +0900)
committerMichael Paquier
Wed, 20 Nov 2024 05:20:52 +0000 (14:20 +0900)
In 17~, age(xid) and mxid_age(xid) were listed as deprecated.  Based on
the discussion that led to 48b5aa3143, this is not intentional as this
could break many existing monitoring queries.  Note that vacuumdb also
uses both of them.

In 16, both functions were listed under "Control Data Functions", which
is incorrect, so let's move them to the list of functions related to
transaction IDs and snapshots.

Author: Bertrand Drouvot
Discussion: https://postgr.es/m/[email protected]
Discussion: https://postgr.es/m/20231114013224[email protected]
Backpatch-through: 16

doc/src/sgml/func.sgml

index 1a0b85bb4d7ee4ddf2832bbbdefa1b15330c96b9..72f223a04145db978df4d0e3c85714f38fbea810 100644 (file)
@@ -27138,6 +27138,34 @@ acl      | {postgres=arwdDxtm/postgres,foo=r/postgres}
      
 
      
+      
+       
+        
+         age
+        
+        age  ( xid )
+        integer
+       
+       
+        Returns the number of transactions between the supplied
+        transaction id and the current transaction counter.
+       
+      
+
+      
+       
+        
+         mxid_age
+        
+        mxid_age  ( xid )
+        integer
+       
+       
+        Returns the number of multixacts IDs between the supplied
+        multixact ID and the current multixacts counter.
+       
+      
+
       
        
         
@@ -27282,7 +27310,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  use a
+    the functions shown in , except
+    age and mxid_age, 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.
@@ -27364,33 +27393,6 @@ acl      | {postgres=arwdDxtm/postgres,foo=r/postgres}
      
 
      
-      
-       
-        
-         age
-        
-        age  ( xid )
-        integer
-       
-       
-        Returns the number of transactions between the supplied
-        transaction id and the current transaction counter.
-       
-      
-
-      
-       
-        
-         mxid_age
-        
-        mxid_age  ( xid )
-        integer
-       
-       
-        Returns the number of multixacts IDs between the supplied
-        multixact ID and the current multixacts counter.
-       
-