pg_walinspect 模块提供了 SQL 函数，允许您在底层检查正在运行的 PostgreSQL 数据库集群的预写日志 (WAL) 的内容，这对于调试、分析、报告或教育目的非常有用。它类似于 pg_waldump，但可以通过 SQL 访问，而不是作为一个单独的实用程序。
此模块的所有函数都将使用服务器的当前时间线 ID 提供 WAL 信息。
pg_walinspect 函数经常使用 LSN 参数调用，该参数指定了一个已知感兴趣的 WAL 记录 开始 的位置。但是，某些函数（例如 pg_logical_emit_message）会返回刚插入的记录 之后 的 LSN。
所有显示位于特定 LSN 范围内的记录信息的 pg_walinspect 函数都允许接受晚于服务器当前 LSN 的 end_lsn 参数。使用 “来自未来的” end_lsn 参数不会引发错误。
将 FFFFFFFF/FFFFFFFF（最大的有效 pg_lsn 值）作为 end_lsn 参数可能很方便。这等同于提供一个与服务器当前 LSN 匹配的 end_lsn 参数。
默认情况下，这些函数的使用仅限于超级用户和 pg_read_server_files 角色成员。超级用户可以使用 GRANT 命令将访问权限授予其他人。
pg_get_wal_record_info(in_lsn pg_lsn) returns record #获取位于 in_lsn 参数处或之后的一个 WAL 记录的信息。例如：
postgres=# SELECT * FROM pg_get_wal_record_info('0/E419E28');
-[ RECORD 1 ]----+-------------------------------------------------
start_lsn | 0/E419E28
end_lsn | 0/E419E68
prev_lsn | 0/E419D78
xid | 0
resource_manager | Heap2
record_type | VACUUM
record_length | 58
main_data_length | 2
fpi_length | 0
description | nunused: 5, unused: [1, 2, 3, 4, 5]
block_ref | blkref #0: rel 1663/16385/1249 fork main blk 364
如果 in_lsn 不是 WAL 记录的开头，则会显示下一个有效 WAL 记录的信息。如果没有下一个有效 WAL 记录，该函数将引发错误。
pg_get_wal_records_info(start_lsn pg_lsn, end_lsn pg_lsn) returns setof record #获取 start_lsn 和 end_lsn 之间所有有效 WAL 记录的信息。每条 WAL 记录返回一行。例如：
postgres=# SELECT * FROM pg_get_wal_records_info('0/1E913618', '0/1E913740') LIMIT 1;
-[ RECORD 1 ]----+--------------------------------------------------------------
start_lsn | 0/1E913618
end_lsn | 0/1E913650
prev_lsn | 0/1E9135A0
xid | 0
resource_manager | Standby
record_type | RUNNING_XACTS
record_length | 50
main_data_length | 24
fpi_length | 0
description | nextXid 33775 latestCompletedXid 33774 oldestRunningXid 33775
block_ref |
如果 start_lsn 不可用，该函数将引发错误。
pg_get_wal_block_info(start_lsn pg_lsn, end_lsn pg_lsn, show_data boolean DEFAULT true) returns setof record #获取 start_lsn 和 end_lsn 之间具有一个或多个块引用的所有有效 WAL 记录的每个块引用的信息。每个 WAL 记录的每个块引用返回一行。例如：
postgres=# SELECT * FROM pg_get_wal_block_info('0/1230278', '0/12302B8');
-[ RECORD 1 ]-----+-----------------------------------
start_lsn | 0/1230278
end_lsn | 0/12302B8
prev_lsn | 0/122FD40
block_id | 0
reltablespace | 1663
reldatabase | 1
relfilenode | 2658
relforknumber | 0
relblocknumber | 11
xid | 341
resource_manager | Btree
record_type | INSERT_LEAF
record_length | 64
main_data_length | 2
block_data_length | 16
block_fpi_length | 0
block_fpi_info |
description | off: 46
block_data | \x00002a00070010402630000070696400
block_fpi_data |
此示例涉及一个仅包含一个块引用的 WAL 记录，但许多 WAL 记录包含多个块引用。pg_get_wal_block_info 输出的行保证具有 start_lsn 和 block_id 值的唯一组合。
此处显示的大部分信息与使用相同参数时 pg_get_wal_records_info 的输出相匹配。但是，pg_get_wal_block_info 将每个 WAL 记录的信息展开，每块引用输出一行，因此某些详细信息是在块引用级别而不是整个记录级别跟踪的。这种结构对于跟踪单个块如何随时间变化非常有用。请注意，没有块引用的记录（例如 COMMIT WAL 记录）将不会返回任何行，因此 pg_get_wal_block_info 实际上可能返回比 pg_get_wal_records_info 更少 的行。
reltablespace、reldatabase 和 relfilenode 参数分别引用 pg_tablespace.oid、pg_database.oid 和 pg_class.relfilenode。 relforknumber 字段是块引用中相对于关系的分叉号；有关详细信息，请参阅 common/relpath.h。
pg_filenode_relation 函数（请参阅 表 9.103）可以帮助您确定在原始执行期间修改了哪个关系。
客户端可以避免物化块数据的开销。这可以显著加快函数执行速度。当 show_data 设置为 false 时，将省略 block_data 和 block_fpi_data 值（即，对于所有返回的行，block_data 和 block_fpi_data OUT 参数为 NULL）。显然，只有在不需要块数据的查询中，此优化才可行。
如果 start_lsn 不可用，该函数将引发错误。
pg_get_wal_stats(start_lsn pg_lsn, end_lsn pg_lsn, per_record boolean DEFAULT false) returns setof record #获取 start_lsn 和 end_lsn 之间所有有效 WAL 记录的统计信息。默认情况下，它为每个 resource_manager 类型返回一行。当 per_record 设置为 true 时，它为每个 record_type 返回一行。例如：
postgres=# SELECT * FROM pg_get_wal_stats('0/1E847D00', '0/1E84F500')
WHERE count > 0 AND
"resource_manager/record_type" = 'Transaction'
LIMIT 1;
-[ RECORD 1 ]----------------+-------------------
resource_manager/record_type | Transaction
count | 2
count_percentage | 8
record_size | 875
record_size_percentage | 41.23468426013195
fpi_size | 0
fpi_size_percentage | 0
combined_size | 875
combined_size_percentage | 2.8634072910530795
如果 start_lsn 不可用，该函数将引发错误。
Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com>
如果您在文档中发现任何不正确、与您对特定功能的体验不符或需要进一步澄清的内容，请使用 此表单 报告文档问题。