PostgreSQL : Документация: 17: pg_waldump : Компания Postgres Professional

pg_waldump
Пред.	Наверх	Серверные приложения PostgreSQL	Начало	След.

pg_waldump

pg_waldump — вывести журнал предзаписи кластера БД PostgreSQL в понятном человеку виде

Синтаксис

pg_waldump [параметр...] [начальный_сегмент [конечный_сегмент]]

Описание

Программа pg_waldump показывает содержимое журнала предзаписи (WAL) и прежде всего полезна для целей отладки и обучения.

Эту утилиту может запускать только пользователь, установивший сервер, так как ей требуется доступ на чтение к каталогу данных.

Параметры

Следующие аргументы командной строки задают расположение данных и формат вывода:

начальный_сегмент

Начать чтение с указанного файла сегмента WAL. Это неявно определяет каталог, в котором будут находиться файлы, и целевую линию времени.

конечный_сегмент

Остановиться после чтения указанного файла сегмента WAL.

-b --bkp-details

Выводить подробные сведения о блоках-копиях страниц.

-B блок --block=блок

Выводить только записи, изменяющие указанный блок. При этом также необходимо указать отношение в аргументе --relation или -R.

-e конец --end=конец

Прекратить чтение в заданной позиции в WAL, а не читать поток до конца.

-f --follow

Достигнув конца корректного WAL, проверять раз в секунду поступление новых записей WAL.

-F слой --fork=слой

Выводить только записи, изменяющие блоки в указанном слое. Допустимые значения: main (основной слой), fsm (карта свободного пространства), vm (карта видимости) и init (слой инициализации).

-n предел --limit=предел

Вывести заданное число записей и остановиться.

-p путь --path=путь

Задаёт каталог, содержащий файлы сегментов WAL, либо каталог с подкаталогом pg_wal, содержащим такие файлы. По умолчанию в поисках этих файлов просматривается текущий каталог, подкаталог pg_wal текущего каталога и подкаталог pg_wal каталога PGDATA.

-q --quiet

Не выводить ничего кроме ошибок. Этот ключ может быть полезен, когда вы хотите узнать, можно ли полностью разобрать диапазон записей WAL, но собственно содержимое записей вас не интересует.

-r менеджер_ресурсов --rmgr=менеджер_ресурсов

Выводить только записи, созданные указанным менеджером ресурсов. Вы можете указать параметр несколько раз, чтобы выбрать несколько менеджеров ресурсов. Когда в качестве имени менеджера передаётся list, программа выводит только список возможных имён менеджеров ресурсов и завершается.

Расширения могут определять пользовательские менеджеры ресурсов, но pg_waldump не загружает модули расширений и поэтому не может распознать пользовательские менеджеры ресурсов по имени. Вместо этого можно обозначить пользовательского менеджера ресурсов в форме custom###, где ### — трёхзначный идентификатор менеджера ресурсов. Обозначения в этой форме всегда будут считаться действительными.

-R табл_пространство/бд/отношение --relation=табл_пространство/бд/отношение

Выводить только записи, изменяющие блоки в указанном отношении. Отношение указывается с OID табличного пространства, OID базы данных и номером файла, разделёнными косой чертой, например 1234/12345/12345. В этом же формате отношения обозначаются в выводе программы.

-s начало --start=начало

Позиция в WAL, с которой нужно начать чтение. По умолчанию чтение начинается с первой корректной записи WAL в самом первом из найденных файлов.

-t линия_времени --timeline=линия_времени

Линия времени, из которой будут читаться записи WAL. По умолчанию используется значение, заданное параметром начальный_сегмент, если он присутствует, а иначе — 1. Значение можно задавать в десятичном или шестнадцатеричном представлении, например 17 или 0x11.

-V --version

Вывести версию pg_waldump и завершиться.

-w --fullpage

Выводить только записи, содержащие образы полных страниц.

-x xid --xid=xid

Вывести только записи, относящиеся к указанной транзакции.

-z --stats[=record]

Вывести общую статистику (число и размер записей и образов полных страниц) вместо отдельных записей. Возможен вариант получения статистики по записям, а не по менеджерам ресурсов.

Если программа pg_waldump прерывается сигналом SIGINT (Control+C), она выдаёт сводку по данным, которые были обработаны к моменту прерывания. Эта операция не поддерживается в Windows.

--save-fullpage=путь_хранения

Сохранять образы полных страниц, записываемые в WAL, в каталог, указанный в пути_хранения. Фильтровать сохраняемые образы и ограничивать их вывод можно так же, как и для записей.

Образы полных страниц сохраняются с именами в таком формате: TIMELINE-LSN.RELTABLESPACE.DATOID.RELNODE.BLKNO_FORK. Имена файлов состоят из следующих компонентов:

Компонент	Описание
TIMELINE	линия времени файла-сегмента WAL, в котором хранится запись, состоит из одного шестнадцатеричного числа шириной 8 символов `%08X`
LSN	LSN записи с этим образом, состоит из двух шестнадцатеричных чисел шириной 8 символов `%08X-%08X`
RELTABLESPACE	OID табличного пространства, содержащего блок
DATOID	OID базы данных, содержащей блок
RELNODE	номер файлового узла для блока
BLKNO	номер блока
FORK	имя слоя, в котором был создан образ полной страницы: `main`, `fsm`, `vm` или `init`

-? --help

Вывести справку об аргументах командной строки pg_waldump и завершиться.

Переменные окружения

PGDATA: Каталог данных; также см. параметр -p.
PG_COLOR: Выбирает вариант использования цвета в диагностических сообщениях. Возможные значения: always (всегда), auto (автоматически) и never (никогда).

Примечания

Когда сервер работает, результаты могут быть некорректными.

Выводятся записи только указанной линии времени (или линии времени по умолчанию, если она не задана явно). Записи в других линиях времени игнорируются.

pg_waldump не будет читать файлы WAL с расширением .partial. Если требуется прочитать такие файлы, расширение .partial нужно убрать из их имён.

См. также

Раздел 28.6

Пред.	Наверх	След.
pg_upgrade	Начало	pg_walsummary

pg_waldump
Prev	Up	PostgreSQL Server Applications	Home	Next

pg_waldump

pg_waldump — display a human-readable rendering of the write-ahead log of a PostgreSQL database cluster

Synopsis

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

Description

pg_waldump displays the write-ahead log (WAL) and is mainly useful for debugging or educational purposes.

This utility can only be run by the user who installed the server, because it requires read-only access to the data directory.

Options

The following command-line options control the location and format of the output:

startseg

Start reading at the specified WAL segment file. This implicitly determines the path in which files will be searched for, and the timeline to use.

endseg

Stop after reading the specified WAL segment file.

-b --bkp-details

Output detailed information about backup blocks.

-B block --block=block

Only display records that modify the given block. The relation must also be provided with --relation or -R.

-e end --end=end

Stop reading at the specified WAL location, instead of reading to the end of the log stream.

-f --follow

After reaching the end of valid WAL, keep polling once per second for new WAL to appear.

-F fork --fork=fork

Only display records that modify blocks in the given fork. The valid values are main for the main fork, fsm for the free space map, vm for the visibility map, and init for the init fork.

-n limit --limit=limit

Display the specified number of records, then stop.

-p path --path=path

Specifies a directory to search for WAL 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.

-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.

-r rmgr --rmgr=rmgr

Only display records generated by the specified resource manager. You can specify the option multiple times to select multiple resource managers. If list is passed as name, print a list of valid resource manager names, and exit.

Extensions may define custom resource managers, but pg_waldump does not load the extension module and therefore does not recognize custom resource managers by name. Instead, you can specify the custom resource managers as custom### where ### is the three-digit resource manager ID. Names of this form will always be considered valid.

-R tblspc/db/rel --relation=tblspc/db/rel

Only display records that modify blocks in the given relation. The relation is specified with tablespace OID, database OID, and relfilenode separated by slashes, for example 1234/12345/12345. This is the same format used for relations in the program's output.

-s start --start=start

WAL location at which to start reading. The default is to start reading the first valid WAL record found in the earliest file found.

-t timeline --timeline=timeline

Timeline from which to read WAL records. The default is to use the value in startseg, if that is specified; otherwise, the default is 1. The value can be specified in decimal or hexadecimal, for example 17 or 0x11.

-V --version

Print the pg_waldump version and exit.

-w --fullpage

Only display records that include full page images.

-x xid --xid=xid

Only display records marked with the given transaction ID.

-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.

If pg_waldump is terminated by signal SIGINT (Control+C), the summary of the statistics computed is displayed up to the termination point. This operation is not supported on Windows.

--save-fullpage=save_path

Save full page images found in the WAL records to the save_path directory. The images saved are subject to the same filtering and limiting criteria as the records displayed.

The full page images are saved with the following file name format: TIMELINE-LSN.RELTABLESPACE.DATOID.RELNODE.BLKNO_FORK The file names are composed of the following parts:

Component	Description
TIMELINE	The timeline of the WAL segment file where the record is located formatted as one 8-character hexadecimal number `%08X`
LSN	The LSN of the record with this image, formatted as two 8-character hexadecimal numbers `%08X-%08X`
RELTABLESPACE	tablespace OID of the block
DATOID	database OID of the block
RELNODE	filenode of the block
BLKNO	block number of the block
FORK	The name of the fork the full page image came from, such as `main`, `fsm`, `vm`, or `init`.

-? --help

Show help about pg_waldump command line arguments, and exit.

Environment

PGDATA: Data directory; see also the -p option.
PG_COLOR: Specifies whether to use color in diagnostic messages. Possible values are always, auto and never.

Notes

Can give wrong results when the server is running.

Only the specified timeline is displayed (or the default, if none is specified). Records in other timelines are ignored.

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.

pg_waldump

Синтаксис

Описание

Параметры

Переменные окружения

Примечания

См. также

pg_waldump

Synopsis

Description

Options

Environment

Notes

See Also