PG_WALDUMP(1)

✨ NAME ✨

Okay bestie, welcome to the PG_WALDUMP(1) manual page — this is all about pg_waldump, which displays a human-readable rendering of the write-ahead log of a PostgreSQL database cluster. It's giving “WAL but make it readable” energy 💅

---

🌸 SYNOPSIS 🌸

pg_waldump [option...] [startseg [endseg]]

---

💖 DESCRIPTION 💖

pg_waldump displays the write-ahead log (WAL) and is mainly useful for debugging or educational purposes. No cap, it's the tool you reach for when you wanna peek at WAL records instead of just vibing with mystery bytes 🦋

This utility can only be run by the user who installed the server, because it requires read-only access to the data directory. So yeah, permissions matter, bestie — it's not a “run it as anyone” situation 🙈

---

🎀 OPTIONS 🎀

The following command-line options control the location and format of the output — read 'em and weep, bestie:

• startseg — Start reading at the specified log segment file. This implicitly determines the path in which files will be searched for, and the timeline to use. It's literally picking your starting point ✨
• endseg — Stop after reading the specified log segment file. That's the finish line, periodt 🏁
• -b, --bkp-details — Output detailed information about backup blocks. Backup block lore unlocked 🔥
• -e end, --end=end — Stop reading at the specified WAL location, instead of reading to the end of the log stream. You set the stop point, bestie 🛑
• -f, --follow — After reaching the end of valid WAL, keep polling once per second for new WAL to appear. It's giving “wait for it… wait for it…” energy 👀
• -n limit, --limit=limit — Display the specified number of records, then stop. Snack-sized WAL output 🍓
• -p path, --path=path — Specifies a directory to search for log segment files or a directory with a pg_wal subdirectory that contains such files. The default is to search in the current directory, the pg_wal subdirectory of the current directory, and the pg_wal subdirectory of PGDATA. Path hunting: iconic 🔍
• -q, --quiet — Do not print any output, except for errors. This option can be useful when you want to know whether a range of WAL records can be successfully parsed but don't care about the record contents. Silent mode, but make it useful 🤫
• -r rmgr, --rmgr=rmgr — Only display records generated by the specified resource manager. If list is passed as name, print a list of valid resource manager names, and exit. Filtered records, filtered vibes 💅
• -s start, --start=start — WAL location at which to start reading. The default is to start reading the first valid log record found in the earliest file found. Choose your beginning, main character style 🌟
• -t timeline, --timeline=timeline — Timeline from which to read log records. The default is to use the value in startseg, if that is specified; otherwise, the default is 1. Timeline selection is lowkey important 🧚
• -V, --version — Print the pg_waldump version and exit. Version check, slay 💖
• -x xid, --xid=xid — Only display records marked with the given transaction ID. XID filter, activated ⭐
• -z, --stats[=record] — Display summary statistics (number and size of records and full-page images) instead of individual records. Optionally generate statistics per-record instead of per-rmgr. Stats girlies rise 🌈
• -?, --help — Show help about pg_waldump command line arguments, and exit. Help is always a vibe 🫶

---

🦋 ENVIRONMENT 🦋

• PGDATA — Data directory; see also the -p option. It's the home base of your data 🏡
• PG_COLOR — Specifies whether to use color in diagnostic messages. Possible values are always, auto and never. Color choice is a whole personality 💜

---

🌈 NOTES 🌈

⚠️ Can give wrong results when the server is running. That's a real heads-up, bestie — don't ignore it 😭

Only the specified timeline is displayed (or the default, if none is specified). Records in other timelines are ignored. Timeline boundaries are respected, no crossover drama 🚫

pg_waldump cannot read WAL files with suffix .partial. If those files need to be read, .partial suffix needs to be removed from the file name. Yep, you gotta rename it — the .partial has to go 🙈

---

💜 SEE ALSO 💜

Section 29.5

---

Cute sign-off time: this page is from PostgreSQL 13.23, dated 2025. Stay slay, bestie 🫶💖