database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-11-03 09:13:20 +03:00
Code Activity

doc: Simplify description of functions for pg_walinspect

Browse Source 
As introduced in 2258e76, the docs were hard to parse:
- The examples used listed a lot of long records, bloating the output.
These are switched to show less records with the expanded format,
similarly to pageinspect.
- The function descriptions listed all the OUT parameters, producing
long lines.  This is updated so as only the input parameters are
documented, clarifying the whole.
- Remove one example on pg_get_wal_stats() when per_record is set to
true, which is not really necessary once we know the output produced,
and the behavior of the parameter is documented.

While on it, fix a few grammar mistakes and simplify a couple of
sentences.

Author: Bharath Rupireddy
Discussion: https://postgr.es/m/CALj2ACVGcUpziGgQrcT-1G3dHWQQfWjYBu1YQ2ypv9y86dgogg@mail.gmail.com
Backpatch-through: 15
This commit is contained in:
Michael Paquier
2023-01-13 09:29:44 +09:00
parent f1821b58fc
commit 58597edea1
1 changed files with 54 additions and 127 deletions
Download Patch File Download Diff File Expand all files Collapse all files

181
doc/src/sgml/pgwalinspect.sgml
View File

@@ -11,7 +11,7 @@
The <filename>pg_walinspect</filename> module provides SQL functions that The <filename>pg_walinspect</filename> module provides SQL functions that
allow you to inspect the contents of write-ahead log of allow you to inspect the contents of write-ahead log of
a running <productname>PostgreSQL</productname> database cluster at a low a running <productname>PostgreSQL</productname> database cluster at a low
level, which is useful for debugging or analytical or reporting or level, which is useful for debugging, analytical, reporting or
educational purposes. It is similar to <xref linkend="pgwaldump"/>, but educational purposes. It is similar to <xref linkend="pgwaldump"/>, but
accessible through SQL rather than a separate utility. accessible through SQL rather than a separate utility.
</para> </para>
@@ -53,20 +53,7 @@
<variablelist> <variablelist>
<varlistentry id="pgwalinspect-funcs-pg-get-wal-record-info"> <varlistentry id="pgwalinspect-funcs-pg-get-wal-record-info">
<term> <term>
<function> <function>pg_get_wal_record_info(in_lsn pg_lsn) returns record</function>
pg_get_wal_record_info(in_lsn pg_lsn,
start_lsn OUT pg_lsn,
end_lsn OUT pg_lsn,
prev_lsn OUT pg_lsn,
xid OUT xid,
resource_manager OUT text,
record_type OUT text,
record_length OUT int4,
main_data_length OUT int4,
fpi_length OUT int4,
description OUT text,
block_ref OUT text)
</function>
</term> </term>
<listitem> <listitem>
@@ -74,6 +61,23 @@
Gets WAL record information of a given LSN. If the given LSN isn't Gets WAL record information of a given LSN. If the given LSN isn't
at the start of a WAL record, it gives the information of the next at the start of a WAL record, it gives the information of the next
available valid WAL record; or an error if no such record is found. available valid WAL record; or an error if no such record is found.
For example, usage of the function is as
follows:
<screen>
postgres=# SELECT * FROM pg_get_wal_record_info('0/1E826E98');
-[ RECORD 1 ]----+----------------------------------------------------
start_lsn | 0/1E826F20
end_lsn | 0/1E826F60
prev_lsn | 0/1E826C80
xid | 0
resource_manager | Heap2
record_type | PRUNE
record_length | 58
main_data_length | 8
fpi_length | 0
description | snapshotConflictHorizon 33748 nredirected 0 ndead 2
block_ref | blkref #0: rel 1663/5/60221 fork main blk 2
</screen>
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -81,19 +85,7 @@
<varlistentry id="pgwalinspect-funcs-pg-get-wal-records-info"> <varlistentry id="pgwalinspect-funcs-pg-get-wal-records-info">
<term> <term>
<function> <function>
pg_get_wal_records_info(start_lsn pg_lsn, pg_get_wal_records_info(start_lsn pg_lsn, end_lsn pg_lsn)
end_lsn pg_lsn,
start_lsn OUT pg_lsn,
end_lsn OUT pg_lsn,
prev_lsn OUT pg_lsn,
xid OUT xid,
resource_manager OUT text,
record_type OUT text,
record_length OUT int4,
main_data_length OUT int4,
fpi_length OUT int4,
description OUT text,
block_ref OUT text)
returns setof record returns setof record
</function> </function>
</term> </term>
@@ -104,25 +96,21 @@
<replaceable>start_lsn</replaceable> and <replaceable>end_lsn</replaceable>. <replaceable>start_lsn</replaceable> and <replaceable>end_lsn</replaceable>.
Returns one row per WAL record. If <replaceable>start_lsn</replaceable> Returns one row per WAL record. If <replaceable>start_lsn</replaceable>
or <replaceable>end_lsn</replaceable> are not yet available, the or <replaceable>end_lsn</replaceable> are not yet available, the
function will raise an error. For example, usage of the function is as function will raise an error. For example:
follows:
<screen> <screen>
postgres=# select start_lsn, end_lsn, prev_lsn, xid, resource_manager, record_type, record_length, main_data_length, fpi_length, description from pg_get_wal_records_info('0/14F9A30', '0/15011D7'); postgres=# SELECT * FROM pg_get_wal_records_info('0/1E913618', '0/1E913740') LIMIT 1;
start_lsn | end_lsn | prev_lsn | xid | resource_manager | record_type | record_length | main_data_length | fpi_length | description -[ RECORD 1 ]----+--------------------------------------------------------------
-----------+-----------+-----------+-----+------------------+--------------+---------------+------------------+------------+--------------------- start_lsn | 0/1E913618
0/14FA118 | 0/14FB4B0 | 0/14F9958 | 725 | Btree | INSERT_LEAF | 5013 | 2 | 4960 | off 246 end_lsn | 0/1E913650
0/14FB4B0 | 0/14FD050 | 0/14FA118 | 725 | Btree | INSERT_LEAF | 7045 | 2 | 6992 | off 130 prev_lsn | 0/1E9135A0
0/14FD050 | 0/14FD0A8 | 0/14FB4B0 | 725 | Heap2 | MULTI_INSERT | 85 | 6 | 0 | 1 tuples flags 0x02 xid | 0
0/14FD0A8 | 0/14FD0F0 | 0/14FD050 | 725 | Btree | INSERT_LEAF | 72 | 2 | 0 | off 155 resource_manager | Standby
0/14FD0F0 | 0/14FD138 | 0/14FD0A8 | 725 | Btree | INSERT_LEAF | 72 | 2 | 0 | off 134 record_type | RUNNING_XACTS
0/14FD138 | 0/14FD210 | 0/14FD0F0 | 725 | Heap | INSERT | 211 | 3 | 0 | off 11 flags 0x00 record_length | 50
0/14FD210 | 0/14FD250 | 0/14FD138 | 725 | Btree | INSERT_LEAF | 64 | 2 | 0 | off 246 main_data_length | 24
0/14FD250 | 0/14FF260 | 0/14FD210 | 725 | Btree | INSERT_LEAF | 8181 | 2 | 8128 | off 47 fpi_length | 0
0/14FF260 | 0/14FF2B8 | 0/14FD250 | 725 | Heap2 | MULTI_INSERT | 85 | 6 | 0 | 1 tuples flags 0x02 description | nextXid 33775 latestCompletedXid 33774 oldestRunningXid 33775
0/14FF2B8 | 0/14FF300 | 0/14FF260 | 725 | Btree | INSERT_LEAF | 72 | 2 | 0 | off 155 block_ref |
0/14FF300 | 0/15008D8 | 0/14FF2B8 | 725 | Btree | INSERT_LEAF | 5565 | 2 | 5512 | off 106
0/15008D8 | 0/1500C48 | 0/14FF300 | 725 | Heap | INSERT | 874 | 3 | 820 | off 2 flags 0x01
(12 rows)
</screen> </screen>
</para> </para>
</listitem> </listitem>
@@ -131,25 +119,14 @@ postgres=# select start_lsn, end_lsn, prev_lsn, xid, resource_manager, record_ty
<varlistentry id="pgwalinspect-funcs-pg-get-wal-records-info-till-end-of-wal"> <varlistentry id="pgwalinspect-funcs-pg-get-wal-records-info-till-end-of-wal">
<term> <term>
<function> <function>
pg_get_wal_records_info_till_end_of_wal(start_lsn pg_lsn, pg_get_wal_records_info_till_end_of_wal(start_lsn pg_lsn)
start_lsn OUT pg_lsn,
end_lsn OUT pg_lsn,
prev_lsn OUT pg_lsn,
xid OUT xid,
resource_manager OUT text,
record_type OUT text,
record_length OUT int4,
main_data_length OUT int4,
fpi_length OUT int4,
description OUT text,
block_ref OUT text)
returns setof record returns setof record
</function> </function>
</term> </term>
<listitem> <listitem>
<para> <para>
This function is same as <function>pg_get_wal_records_info()</function> This function is the same as <function>pg_get_wal_records_info()</function>,
except that it gets information of all the valid WAL records from except that it gets information of all the valid WAL records from
<replaceable>start_lsn</replaceable> till the end of WAL. <replaceable>start_lsn</replaceable> till the end of WAL.
</para> </para>
@@ -159,18 +136,7 @@ postgres=# select start_lsn, end_lsn, prev_lsn, xid, resource_manager, record_ty
<varlistentry id="pgwalinspect-funcs-pg-get-wal-stats"> <varlistentry id="pgwalinspect-funcs-pg-get-wal-stats">
<term> <term>
<function> <function>
pg_get_wal_stats(start_lsn pg_lsn, pg_get_wal_stats(start_lsn pg_lsn, end_lsn pg_lsn, per_record boolean DEFAULT false)
end_lsn pg_lsn,
per_record boolean DEFAULT false,
"resource_manager/record_type" OUT text,
count OUT int8,
count_percentage OUT float8,
record_length OUT int8,
record_length_percentage OUT float8,
fpi_length OUT int8,
fpi_length_percentage OUT float8,
combined_size OUT int8,
combined_size_percentage OUT float8)
returns setof record returns setof record
</function> </function>
</term> </term>
@@ -185,50 +151,21 @@ postgres=# select start_lsn, end_lsn, prev_lsn, xid, resource_manager, record_ty
it returns one row per <replaceable>record_type</replaceable>. it returns one row per <replaceable>record_type</replaceable>.
If <replaceable>start_lsn</replaceable> If <replaceable>start_lsn</replaceable>
or <replaceable>end_lsn</replaceable> are not yet available, the or <replaceable>end_lsn</replaceable> are not yet available, the
function will raise an error. For example, usage of the function is as function will raise an error. For example:
follows:
<screen> <screen>
postgres=# select * from pg_get_wal_stats('0/12FBA30', '0/15011D7') where count > 0; postgres=# SELECT * FROM pg_get_wal_stats('0/1E847D00', '0/1E84F500')
resource_manager/record_type | count | count_percentage | record_size | record_size_percentage | fpi_size | fpi_size_percentage | combined_size | combined_size_percentage WHERE count > 0 LIMIT 1 AND
------------------------------+-------+------------------+-------------+------------------------+----------+---------------------+---------------+-------------------------- "resource_manager/record_type" = 'Transaction';
XLOG | 10 | 0.10871929 | 796 | 0.052369177 | 352 | 0.061031006 | 1148 | 0.054751817 -[ RECORD 1 ]----------------+-------------------
Transaction | 187 | 2.0330508 | 62773 | 4.1298623 | 0 | 0 | 62773 | 2.9938467 resource_manager/record_type | Transaction
Storage | 13 | 0.14133507 | 546 | 0.035921574 | 0 | 0 | 546 | 0.0260405 count | 2
Database | 2 | 0.021743858 | 84 | 0.005526396 | 0 | 0 | 84 | 0.0040062307 count_percentage | 8
Standby | 218 | 2.3700805 | 15908 | 1.0465941 | 0 | 0 | 15908 | 0.75870377 record_size | 875
Heap2 | 1897 | 20.624048 | 383916 | 25.257998 | 364472 | 63.193447 | 748388 | 35.693035 record_size_percentage | 41.23468426013195
Heap | 1318 | 14.329202 | 621390 | 40.88151 | 139660 | 24.214746 | 761050 | 36.29693 fpi_size | 0
Btree | 5553 | 60.37182 | 434565 | 28.590216 | 72272 | 12.530776 | 506837 | 24.17269 fpi_size_percentage | 0
(8 rows) combined_size | 875
</screen> combined_size_percentage | 2.8634072910530795
With <replaceable>per_record</replaceable> passed as <literal>true</literal>:
<screen>
postgres=# select * from pg_get_wal_stats('0/14AFC30', '0/15011D7', true) where count > 0;
resource_manager/record_type | count | count_percentage | record_size | record_size_percentage | fpi_size | fpi_size_percentage | combined_size | combined_size_percentage
------------------------------+-------+------------------+-------------+------------------------+----------+---------------------+---------------+--------------------------
XLOG/CHECKPOINT_SHUTDOWN | 1 | 0.32894737 | 114 | 0.22891566 | 0 | 0 | 114 | 0.03534489
XLOG/CHECKPOINT_ONLINE | 4 | 1.3157895 | 456 | 0.91566265 | 0 | 0 | 456 | 0.14137957
XLOG/NEXTOID | 1 | 0.32894737 | 30 | 0.060240965 | 0 | 0 | 30 | 0.009301287
Transaction/COMMIT | 9 | 2.9605262 | 1173 | 2.3554218 | 0 | 0 | 1173 | 0.36368033
Storage/CREATE | 1 | 0.32894737 | 42 | 0.084337346 | 0 | 0 | 42 | 0.0130218025
Database/CREATE_FILE_COPY | 2 | 0.65789473 | 84 | 0.16867469 | 0 | 0 | 84 | 0.026043605
Standby/RUNNING_XACTS | 6 | 1.9736842 | 316 | 0.6345382 | 0 | 0 | 316 | 0.09797356
Standby/INVALIDATIONS | 45 | 14.802631 | 4018 | 8.068274 | 0 | 0 | 4018 | 1.2457525
Heap2/PRUNE | 4 | 1.3157895 | 270 | 0.5421687 | 0 | 0 | 270 | 0.08371159
Heap2/FREEZE_PAGE | 27 | 8.881579 | 20904 | 41.975903 | 0 | 0 | 20904 | 6.481137
Heap2/VISIBLE | 29 | 9.539474 | 1756 | 3.5261045 | 73728 | 27.032736 | 75484 | 23.403278
Heap2/MULTI_INSERT | 13 | 4.2763157 | 1049 | 2.1064258 | 12216 | 4.479057 | 13265 | 4.112719
Heap/INSERT | 19 | 6.25 | 2324 | 4.6666665 | 43884 | 16.090284 | 46208 | 14.326463
Heap/UPDATE | 7 | 2.3026316 | 511 | 1.0261045 | 54340 | 19.924028 | 54851 | 17.006165
Heap/HOT_UPDATE | 11 | 3.618421 | 1134 | 2.2771084 | 468 | 0.17159452 | 1602 | 0.49668875
Heap/LOCK | 8 | 2.631579 | 432 | 0.8674699 | 0 | 0 | 432 | 0.13393854
Heap/INPLACE | 45 | 14.802631 | 9123 | 18.319277 | 16076 | 5.894345 | 25199 | 7.8127713
Heap/UPDATE+INIT | 1 | 0.32894737 | 817 | 1.6405623 | 0 | 0 | 817 | 0.25330505
Btree/INSERT_LEAF | 70 | 23.026316 | 5183 | 10.407631 | 72024 | 26.407955 | 77207 | 23.937483
Btree/DEDUP | 1 | 0.32894737 | 64 | 0.12851405 | 0 | 0 | 64 | 0.019842746
(20 rows)
</screen> </screen>
</para> </para>
</listitem> </listitem>
@@ -237,25 +174,15 @@ postgres=# select * from pg_get_wal_stats('0/14AFC30', '0/15011D7', true) where
<varlistentry id="pgwalinspect-funcs-pg-get-wal-stats-till-end-of-wal"> <varlistentry id="pgwalinspect-funcs-pg-get-wal-stats-till-end-of-wal">
<term> <term>
<function> <function>
pg_get_wal_stats_till_end_of_wal(start_lsn pg_lsn, pg_get_wal_stats_till_end_of_wal(start_lsn pg_lsn, end_lsn pg_lsn, per_record boolean DEFAULT false)
per_record boolean DEFAULT false,
"resource_manager/record_type" OUT text,
count OUT int8,
count_percentage OUT float8,
record_length OUT int8,
record_length_percentage OUT float8,
fpi_length OUT int8,
fpi_length_percentage OUT float8,
combined_size OUT int8,
combined_size_percentage OUT float8)
returns setof record returns setof record
</function> </function>
</term> </term>
<listitem> <listitem>
<para> <para>
This function is same as <function>pg_get_wal_stats()</function> except This function is the same as <function>pg_get_wal_stats()</function>,
that it gets statistics of all the valid WAL records from except that it gets statistics of all the valid WAL records from
<replaceable>start_lsn</replaceable> till end of WAL. <replaceable>start_lsn</replaceable> till end of WAL.
</para> </para>
</listitem> </listitem>