Hi hackers,
48b5aa3143 mentioned age() and mxid_age() as deprecated. As per the discussion
in
[1], it looks like that was not intentional.
Please find attached a patch to fix this on master and its version for the 17
stable branch backpatch. I think that's worth a backpatch as that could raise
concerns to read that the functions you rely on for monitoring are deprecated
and could generate questions like "will they be removed in PG 18?", "if so, what
is the supported/recommended way to calculate age of transaction id’s?".
Also it looks like that for PG 16, 7471230cc6, did put the functions description
in the "Control Data Functions". That looks unintentional too, so moving it to
"Transaction ID and Snapshot Information Functions" section instead.
Please find attached the 3 patches.
[1]:
https://www.postgresql.org/message-id/20231114013224.4z6oxa6p6va33rxr%40awork3.anarazel.de
Looking forward to your feedback,
Regards,
--
Bertrand Drouvot
PostgreSQL Contributors Team
RDS Open Source Databases
Amazon Web Services: https://aws.amazon.com
>From 26e0211f2a1366d6e345caeb0fbfd1a7dff70774 Mon Sep 17 00:00:00 2001
From: Bertrand Drouvot <bertranddrouvot...@gmail.com>
Date: Mon, 18 Nov 2024 06:46:13 +0000
Subject: [PATCH v1] fix deprecation mention for age() and mxid_age()
48b5aa3143 mentioned age() and mxid_age() as deprecated. That was not intentional,
as per the dicussion that lead to 48b5aa3143.
---
doc/src/sgml/func.sgml | 58 ++++++++++++++++++++++--------------------
1 file changed, 30 insertions(+), 28 deletions(-)
100.0% doc/src/sgml/
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 73979f20ff..e740b3f4ca 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -27138,6 +27138,34 @@ acl | {postgres=arwdDxtm/postgres,foo=r/postgres}
</thead>
<tbody>
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <indexterm>
+ <primary>age</primary>
+ </indexterm>
+ <function>age</function> ( <type>xid</type> )
+ <returnvalue>integer</returnvalue>
+ </para>
+ <para>
+ Returns the number of transactions between the supplied
+ transaction id and the current transaction counter.
+ </para></entry>
+ </row>
+
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <indexterm>
+ <primary>mxid_age</primary>
+ </indexterm>
+ <function>mxid_age</function> ( <type>xid</type> )
+ <returnvalue>integer</returnvalue>
+ </para>
+ <para>
+ Returns the number of multixacts IDs between the supplied
+ multixact ID and the current multixacts counter.
+ </para></entry>
+ </row>
+
<row>
<entry role="func_table_entry"><para role="func_signature">
<indexterm>
@@ -27282,7 +27310,8 @@ acl | {postgres=arwdDxtm/postgres,foo=r/postgres}
<para>
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"/> use a
+ the functions shown in <xref linkend="functions-pg-snapshot"/> (except
+ <function>age</function> () and <function>mxid_age</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.
@@ -27364,33 +27393,6 @@ acl | {postgres=arwdDxtm/postgres,foo=r/postgres}
</thead>
<tbody>
- <row>
- <entry role="func_table_entry"><para role="func_signature">
- <indexterm>
- <primary>age</primary>
- </indexterm>
- <function>age</function> ( <type>xid</type> )
- <returnvalue>integer</returnvalue>
- </para>
- <para>
- Returns the number of transactions between the supplied
- transaction id and the current transaction counter.
- </para></entry>
- </row>
-
- <row>
- <entry role="func_table_entry"><para role="func_signature">
- <indexterm>
- <primary>mxid_age</primary>
- </indexterm>
- <function>mxid_age</function> ( <type>xid</type> )
- <returnvalue>integer</returnvalue>
- </para>
- <para>
- Returns the number of multixacts IDs between the supplied
- multixact ID and the current multixacts counter.
- </para></entry>
- </row>
<row>
<entry role="func_table_entry"><para role="func_signature">
--
2.34.1
>From 1c02a64f2b2b3248a898f17a26e3da9ca5801308 Mon Sep 17 00:00:00 2001
From: Bertrand Drouvot <bertranddrouvot...@gmail.com>
Date: Mon, 18 Nov 2024 07:12:55 +0000
Subject: [PATCH v1] fix deprecation mention for age() and mxid_age()
48b5aa3143 mentioned age() and mxid_age() as deprecated. That was not intentional,
as per the dicussion that lead to 48b5aa3143.
---
doc/src/sgml/func.sgml | 58 ++++++++++++++++++++++--------------------
1 file changed, 30 insertions(+), 28 deletions(-)
100.0% doc/src/sgml/
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 2cd93163b7..53c28f8c88 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -27009,6 +27009,34 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
</thead>
<tbody>
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <indexterm>
+ <primary>age</primary>
+ </indexterm>
+ <function>age</function> ( <type>xid</type> )
+ <returnvalue>integer</returnvalue>
+ </para>
+ <para>
+ Returns the number of transactions between the supplied
+ transaction id and the current transaction counter.
+ </para></entry>
+ </row>
+
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <indexterm>
+ <primary>mxid_age</primary>
+ </indexterm>
+ <function>mxid_age</function> ( <type>xid</type> )
+ <returnvalue>integer</returnvalue>
+ </para>
+ <para>
+ Returns the number of multixacts IDs between the supplied
+ multixact ID and the current multixacts counter.
+ </para></entry>
+ </row>
+
<row>
<entry role="func_table_entry"><para role="func_signature">
<indexterm>
@@ -27153,7 +27181,8 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
<para>
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"/> use a
+ the functions shown in <xref linkend="functions-pg-snapshot"/> (except
+ <function>age</function> () and <function>mxid_age</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.
@@ -27235,33 +27264,6 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
</thead>
<tbody>
- <row>
- <entry role="func_table_entry"><para role="func_signature">
- <indexterm>
- <primary>age</primary>
- </indexterm>
- <function>age</function> ( <type>xid</type> )
- <returnvalue>integer</returnvalue>
- </para>
- <para>
- Returns the number of transactions between the supplied
- transaction id and the current transaction counter.
- </para></entry>
- </row>
-
- <row>
- <entry role="func_table_entry"><para role="func_signature">
- <indexterm>
- <primary>mxid_age</primary>
- </indexterm>
- <function>mxid_age</function> ( <type>xid</type> )
- <returnvalue>integer</returnvalue>
- </para>
- <para>
- Returns the number of multixacts IDs between the supplied
- multixact ID and the current multixacts counter.
- </para></entry>
- </row>
<row>
<entry role="func_table_entry"><para role="func_signature">
--
2.34.1
>From cfa4fb451bf809c56a3806b2e108383dfec221c6 Mon Sep 17 00:00:00 2001
From: Bertrand Drouvot <bertranddrouvot...@gmail.com>
Date: Mon, 18 Nov 2024 07:37:12 +0000
Subject: [PATCH v1] fix doc location for age() and mxid_age()
7471230cc6 did put the functions description in the "Control Data Functions".
That looks unintentional, so moving it to the
"Transaction ID and Snapshot Information Functions" section instead.
---
doc/src/sgml/func.sgml | 58 ++++++++++++++++++++++--------------------
1 file changed, 30 insertions(+), 28 deletions(-)
100.0% doc/src/sgml/
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 51fcfc26c9..e282bd42d3 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -25365,6 +25365,34 @@ SELECT collation for ('foo' COLLATE "de_DE");
</thead>
<tbody>
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <indexterm>
+ <primary>age</primary>
+ </indexterm>
+ <function>age</function> ( <type>xid</type> )
+ <returnvalue>integer</returnvalue>
+ </para>
+ <para>
+ Returns the number of transactions between the supplied
+ transaction id and the current transaction counter.
+ </para></entry>
+ </row>
+
+ <row>
+ <entry role="func_table_entry"><para role="func_signature">
+ <indexterm>
+ <primary>mxid_age</primary>
+ </indexterm>
+ <function>mxid_age</function> ( <type>xid</type> )
+ <returnvalue>integer</returnvalue>
+ </para>
+ <para>
+ Returns the number of multixacts IDs between the supplied
+ multixact ID and the current multixacts counter.
+ </para></entry>
+ </row>
+
<row>
<entry role="func_table_entry"><para role="func_signature">
<indexterm>
@@ -25509,7 +25537,8 @@ SELECT collation for ('foo' COLLATE "de_DE");
<para>
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"/> use a
+ the functions shown in <xref linkend="functions-pg-snapshot"/> (except
+ <function>age</function> () and <function>mxid_age</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.
@@ -25806,33 +25835,6 @@ SELECT collation for ('foo' COLLATE "de_DE");
</thead>
<tbody>
- <row>
- <entry role="func_table_entry"><para role="func_signature">
- <indexterm>
- <primary>age</primary>
- </indexterm>
- <function>age</function> ( <type>xid</type> )
- <returnvalue>integer</returnvalue>
- </para>
- <para>
- Returns the number of transactions between the supplied
- transaction id and the current transaction counter.
- </para></entry>
- </row>
-
- <row>
- <entry role="func_table_entry"><para role="func_signature">
- <indexterm>
- <primary>mxid_age</primary>
- </indexterm>
- <function>mxid_age</function> ( <type>xid</type> )
- <returnvalue>integer</returnvalue>
- </para>
- <para>
- Returns the number of multixacts IDs between the supplied
- multixact ID and the current multixacts counter.
- </para></entry>
- </row>
<row>
<entry role="func_table_entry"><para role="func_signature">
--
2.34.1
