diff --git a/pages/common/pg_waldump.md b/pages/common/pg_waldump.md index 2093ecf8a3983e..66244de0e85acb 100644 --- a/pages/common/pg_waldump.md +++ b/pages/common/pg_waldump.md @@ -1,9 +1,13 @@ # pg_waldump -> Display a human-readable rendering of the write-ahead log (WAL). +> Display a human-readable rendering of the write-ahead log (WAL) of a PostgreSQL database cluster. > More information: . -- Basic invocation reading a WAL segment (or range): +- Display WAL records from a specific segment: + +`pg_waldump {{start_segment}}` + +- Display WAL records between two segments: `pg_waldump {{start_segment}} {{end_segment}}` @@ -11,14 +15,6 @@ `pg_waldump {{start_segment}} {{end_segment}} {{[-p|--path]}} {{path}}` -- Start from a particular WAL location (LSN): - -`pg_waldump {{start_segment}} {{end_segment}} {{[-s|--start]}} {{lsn}}` - -- Stop at a particular WAL location (LSN): - -`pg_waldump {{start_segment}} {{end_segment}} {{[-e|--end]}} {{lsn}}` - - Follow new WAL entries as they arrive: `pg_waldump {{start_segment}} {{end_segment}} {{[-f|--follow]}}` @@ -27,10 +23,14 @@ `pg_waldump {{start_segment}} {{end_segment}} {{[-n|--limit]}} {{count}}` -- Quiet mode (suppress output except errors): +- Display summary statistics instead of individual records: -`pg_waldump {{start_segment}} {{end_segment}} {{[-q|--quiet]}}` +`pg_waldump {{start_segment}} {{end_segment}} {{[-z|--stats]}}` - Filter by resource manager: `pg_waldump {{start_segment}} {{end_segment}} {{[-r|--rmgr]}} {{rmgr_name}}` + +- Display help: + +`pg_waldump {{[-?|--help]}}`