> For the complete documentation index, see [llms.txt](https://docs.postgresql.tw/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.postgresql.tw/15/appendixes/additional-supplied-modules/pg_walinspect.md). # F.37. pg\_walinspect ## F.37. pg\_walinspect [F.37.1. General Functions](#id-1.11.7.46.8) [F.37.2. Author](#id-1.11.7.46.9) The `pg_walinspect` module provides SQL functions that allow you to inspect the contents of write-ahead log of a running PostgreSQL database cluster at a low level, which is useful for debugging, analytical, reporting or educational purposes. It is similar to [pg\_waldump](/15/reference/server-applications/pg_waldump.md), but accessible through SQL rather than a separate utility. All the functions of this module will provide the WAL information using the current server's timeline ID. All the functions of this module will try to find the first valid WAL record that is at or after the given *`in_lsn`* or *`start_lsn`* and will emit error if no such record is available. Similarly, the *`end_lsn`* must be available, and if it falls in the middle of a record, the entire record must be available. ### Note Some functions, such as [`pg_logical_emit_message`](/15/the-sql-language/functions-and-operators/system-administration.md#PG-LOGICAL-EMIT-MESSAGE), return the LSN *after* the record just inserted. Therefore, if you pass that LSN as *`in_lsn`* or *`start_lsn`* to one of these functions, it will return the *next* record. By default, use of these functions is restricted to superusers and members of the `pg_read_server_files` role. Access may be granted by superusers to others using `GRANT`. ### F.37.1. General Functions `pg_get_wal_record_info(in_lsn pg_lsn) returns record` 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 available valid WAL record; or an error if no such record is found. For example, usage of the function is as follows: ``` 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 ``` `pg_get_wal_records_info(start_lsn pg_lsn, end_lsn pg_lsn) returns setof record` Gets information of all the valid WAL records between *`start_lsn`* and *`end_lsn`*. Returns one row per WAL record. If *`start_lsn`* or *`end_lsn`* are not yet available, the function will raise an error. For example: ``` 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 | ``` `pg_get_wal_records_info_till_end_of_wal(start_lsn pg_lsn) returns setof record` This function is the same as `pg_get_wal_records_info()`, except that it gets information of all the valid WAL records from *`start_lsn`* till the end of WAL. `pg_get_wal_stats(start_lsn pg_lsn, end_lsn pg_lsn, per_record boolean DEFAULT false) returns setof record` Gets statistics of all the valid WAL records between *`start_lsn`* and *`end_lsn`*. By default, it returns one row per *`resource_manager`* type. When *`per_record`* is set to `true`, it returns one row per *`record_type`*. If *`start_lsn`* or *`end_lsn`* are not yet available, the function will raise an error. For example: ``` 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 ``` `pg_get_wal_stats_till_end_of_wal(start_lsn pg_lsn, per_record boolean DEFAULT false) returns setof record` This function is the same as `pg_get_wal_stats()`, except that it gets statistics of all the valid WAL records from *`start_lsn`* till end of WAL. ### F.37.2. Author Bharath Rupireddy `<`[`bharath.rupireddyforpostgres@gmail.com`](mailto:bharath.rupireddyforpostgres@gmail.com)`>` *** 原文：[PostgreSQL 15.19 Documentation](/15/appendixes/additional-supplied-modules/pg_walinspect.md)（英文原文，待翻譯） --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.postgresql.tw/15/appendixes/additional-supplied-modules/pg_walinspect.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.