From bd2ef63aa827066476ec6ab3d7dcd0a3b5fe0671 Mon Sep 17 00:00:00 2001 From: Bruce Momjian <bruce@momjian.us> Date: Mon, 5 Nov 2007 16:45:52 +0000 Subject: [PATCH] Move txid snapshot field description table from datatype to functions section. --- doc/src/sgml/datatype.sgml | 73 +------------------------------------- doc/src/sgml/func.sgml | 65 +++++++++++++++++++++++++++++---- 2 files changed, 60 insertions(+), 78 deletions(-) diff --git a/doc/src/sgml/datatype.sgml b/doc/src/sgml/datatype.sgml index e1e157ab379..5f173c907af 100644 --- a/doc/src/sgml/datatype.sgml +++ b/doc/src/sgml/datatype.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.213 2007/11/05 14:51:08 momjian Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/datatype.sgml,v 1.214 2007/11/05 16:45:52 momjian Exp $ --> <chapter id="datatype"> <title id="datatype-title">Data Types</title> @@ -3437,77 +3437,6 @@ SELECT to_tsquery('Fat:ab & Cats'); </sect1> - <sect1 id="datatype-txid-snapshot"> - <title>Transaction Snapshot Type</title> - - <indexterm zone="datatype-txid-snapshot"> - <primary>txid_snapshot</primary> - </indexterm> - - <para> - The data type <type>txid_snapshot</type> stores info about transaction ID - visibility at a particular moment in time. The components are - described in <xref linkend="datatype-txid-snapshot-parts">. - </para> - - <table id="datatype-txid-snapshot-parts"> - <title>Snapshot components</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - <entry>Query Function</entry> - <entry>Description</entry> - </row> - </thead> - - <tbody> - - <row> - <entry><type>xmin</type></entry> - <entry>txid_snapshot_xmin()</entry> - <entry> - Earliest transaction ID that is still active. All earlier - transactions will either be committed and visible, or rolled - back and dead. - </entry> - </row> - - <row> - <entry><type>xmax</type></entry> - <entry>txid_snapshot_xmax()</entry> - <entry> - Next unassigned txid. All txids later than this one are - unassigned, and thus invisible. - </entry> - </row> - - <row> - <entry><type>xip_list</type></entry> - <entry>txid_snapshot_xip()</entry> - <entry> - Active txids at the time of snapshot. All of them are between - xmin and xmax. A txid that is <literal>xmin <= txid < - xmax</literal> and not in this list is visible. - </entry> - </row> - - </tbody> - </tgroup> - </table> - - <para> - Snapshot's textual representation is <literal>[xmin]:[xmax]:[xip_list]</literal> - for example <literal>10:20:10,14,15</literal> means - <literal>xmin=10 xmax=20 xip_list=10,14,15</literal>. - </para> - - <para> - Functions for getting and querying transaction ids and snapshots are - described in <xref linkend="functions-txid">. - </para> - </sect1> - <sect1 id="datatype-uuid"> <title><acronym>UUID</acronym> Type</title> diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index ad91d6d6af3..78ab02a0ec4 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -1,4 +1,4 @@ -<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.407 2007/11/05 14:51:08 momjian Exp $ --> +<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.408 2007/11/05 16:45:52 momjian Exp $ --> <chapter id="functions"> <title>Functions and Operators</title> @@ -11519,11 +11519,6 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); <primary>txid_visible_in_snapshot</primary> </indexterm> - <para> - The functions shown in <xref linkend="functions-txid-snapshot"> - export server internal transaction info to user level. - </para> - <table id="functions-txid-snapshot"> <title>Transaction IDs and snapshots</title> <tgroup cols="3"> @@ -11575,6 +11570,64 @@ SELECT pg_type_is_visible('myschema.widget'::regtype); which transactions were committed between two snapshots. </para> + <para> + The data type <type>txid_snapshot</type> stores info about transaction ID + visibility at a particular moment in time. The components are + described in <xref linkend="datatype-txid-snapshot-parts">. + </para> + + <table id="datatype-txid-snapshot-parts"> + <title>Snapshot components</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Query Function</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + + <row> + <entry><type>xmin</type></entry> + <entry>txid_snapshot_xmin()</entry> + <entry> + Earliest transaction ID that is still active. All earlier + transactions will either be committed and visible, or rolled + back and dead. + </entry> + </row> + + <row> + <entry><type>xmax</type></entry> + <entry>txid_snapshot_xmax()</entry> + <entry> + Next unassigned txid. All txids later than this one are + unassigned, and thus invisible. + </entry> + </row> + + <row> + <entry><type>xip_list</type></entry> + <entry>txid_snapshot_xip()</entry> + <entry> + Active txids at the time of snapshot. All of them are between + xmin and xmax. A txid that is <literal>xmin <= txid < + xmax</literal> and not in this list is visible. + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para> + Snapshot's textual representation is <literal>[xmin]:[xmax]:[xip_list]</literal> + for example <literal>10:20:10,14,15</literal> means + <literal>xmin=10 xmax=20 xip_list=10,14,15</literal>. + </para> + </sect1> <sect1 id="functions-admin"> -- GitLab