pg_dumpall
pg_dumpall — выгрузить кластер баз данных PostgreSQL в формате скрипта
Синтаксис
pg_dumpall [параметр-подключения...] [параметр...]
Описание
Утилита pg_dumpall предназначена для записи («выгрузки») всех баз данных кластера PostgreSQL в один файл в формате скрипта. Этот файл содержит команды SQL, так что передав его на вход psql, можно восстановить все базы данных. Для формирования этого файла вызывается pg_dump для каждой базы данных в кластере. pg_dumpall также выгружает глобальные объекты, общие для всех баз данных, а именно роли, табличные пространства и права, выданные для параметров конфигурации. (Программа pg_dump не сохраняет эти объекты.)
Так как утилита pg_dumpall читает таблицы из всех баз данных, для получения полного содержимого баз запускать её, как правило, нужно от имени суперпользователя. Также права суперпользователя требуются при последующем выполнении сохранённого скрипта, чтобы он смог добавить роли и создать базы данных.
Генерируемый SQL-скрипт записывается в стандартное устройство вывода. Чтобы перенаправить его в файл, воспользуйтесь параметром -f/--file или операторами оболочки.
Утилите pg_dumpall требуется подключаться к серверу PostgreSQL несколько раз (к каждой базе по отдельности). Если вы проходите проверку подлинности по паролю, вам придётся каждый раз вводить пароль. Чтобы избежать этого, удобно иметь файл ~/.pgpass. За дополнительными сведениями обратитесь к Разделу 34.16.
Предупреждение
При восстановлении выгрузки в целевой точке выполняется произвольный код по выбору суперпользователей исходной точки. Для частичных выгрузок и частичных восстановлений такого ограничения нет. Если суперпользователи исходной точки не являются доверенными, выгружаемые команды SQL нужно проверять перед восстановлением. Обратите внимание, что клиенту, выполняющему выгрузку и восстановление, не нужно доверять суперпользователям исходной или целевой точки.
Параметры
Параметры командной строки для управления содержимым и форматом вывода.
-a--data-onlyВыгружать только данные, без схемы (определений данных).
-c--cleanВыводить SQL-команды для
DROPвсех выгруженных баз данных, ролей и табличных пространств перед их воссозданием. Этот параметр полезен, когда при восстановлении необходимо перезаписать существующий кластер. Без дополнительного указания--if-existsпри этом могут выдаваться безвредные сообщения об ошибках, если таких объектов не окажется в целевой базе данных.-Eкодировка--encoding=кодировкаСоздать копию в заданной кодировке. По умолчанию копия создаётся в кодировке базы данных. (Другой способ достичь того же результата — задать желаемую кодировку в переменной окружения
PGCLIENTENCODING.)-fимя_файла--file=имя_файлаНаправить вывод в указанный файл. Если этот параметр опущен, скрипт записывается в стандартный вывод.
-g--globals-onlyВыгружать только глобальные объекты (роли и табличные пространства), без баз данных.
-O--no-ownerНе генерировать команды, устанавливающие владение объектами, как в исходной базе данных. По умолчанию, pg_dumpall генерирует команды
ALTER OWNERилиSET SESSION AUTHORIZATION, восстанавливающие исходных владельцев для создаваемых элементов схемы. Однако выполнить эти команды сможет только суперпользователь (или пользователь, владеющий всеми объектами, создаваемыми скриптом). Чтобы получить скрипт, который сможет восстановить любой пользователь (но при этом он станет владельцем всех объектов), используется-O.-r--roles-onlyВыгружать только роли, без баз данных и табличных пространств.
-s--schema-onlyВыгружать только определения объектов (схемы), без данных.
-Sимя_пользователя--superuser=имя_пользователяУказать суперпользователя, который будет использоваться для отключения триггеров. Параметр имеет значение только вместе с
--disable-triggers. Обычно его лучше не использовать, а запускать полученный скрипт от имени суперпользователя.-t--tablespaces-onlyВыгружать только табличные пространства, без баз данных и ролей.
-v--verboseВключить подробный режим. pg_dumpall будет выводить в стандартный поток ошибок подробные комментарии к объектам, включая время начала и окончания выгрузки, а также сообщения о прогрессе выполнения. Если повторить этот ключ, в стандартный поток ошибок будут выдаваться дополнительные отладочные сообщения. Этот ключ также передаётся программе pg_dump.
-V--versionСообщить версию pg_dumpall и завершиться.
-x--no-privileges--no-aclНе выгружать права доступа (команды GRANT/REVOKE).
--binary-upgradeЭтот параметр предназначен для утилит обновления сервера. Использование для иных целей не рекомендуется и не поддерживается. Поведение параметра может быть изменено в последующих версиях без предварительного уведомления.
--column-inserts--attribute-insertsВыгружать данные в виде команд
INSERTс явно задаваемыми именами столбцов (INSERT INTO). При этом восстановление будет очень медленным; в основном это применяется для выгрузки данных, которые затем будут загружаться не в PostgreSQL.таблица(столбец, ...) VALUES ...--disable-dollar-quotingЭтот параметр запрещает заключать в доллары тело функций, что оставляет возможность только заключать их в кавычки, применяя стандартный синтаксис SQL.
--disable-triggersЭтот параметр действует только при выгрузке одних данных. С ним pg_dumpall добавляет команды, отключающие триггеры в целевых таблицах на время загрузки данных. Используйте его, если в ваших таблицах определены проверки ссылочной целостности или другие триггеры, которые вы не хотели бы выполнять в процессе загрузки данных.
В настоящее время команды, генерируемые с параметром
--disable-triggers, должны исполняться от имени суперпользователя. Таким образом, необходимо также передавать флаг-S, либо при восстановлении выполнять скрипт от имени суперпользователя.--exclude-database=шаблонНе выгружать базы данных, имена которых соответствуют
шаблону. Исключить имена по нескольким шаблонам можно, добавив несколько ключей--exclude-database. Параметршаблонв данном аргументе обрабатывается по тем же правилам, что и в командах psql\d(см. Шаблоны поиска), что позволяет также исключить несколько баз данных, добавив в шаблон звёздочку. Используя звёздочку, заключайте шаблон в кавычки, если звёздочка может быть развёрнута оболочкой.--extra-float-digits=число_цифрВыводить числа с плавающей точкой не с максимальной точностью, а с заданным значением extra_float_digits. При выгрузке данных в целях резервного копирования данный параметр использовать не следует.
--if-existsИспользовать команды
DROP ... IF EXISTSдля удаления объектов в режиме--clean. При этом возможные ошибки «does not exist» (не существует) не выводятся. Этот параметр недействителен без указания--clean.--insertsВыгружать данные в виде команд
INSERT, а неCOPY. При этом восстановление значительно замедлится; в основном это применяется для выгрузки данных, которые затем будут загружаться не в PostgreSQL. Заметьте, что восстановление может вовсе не выполниться при изменении порядка столбцов в таблицах. В этом смысле параметр--column-insertsбезопаснее, но восстановление будет ещё медленнее.--load-via-partition-rootПри выгрузке данных для секции таблицы выводить команды
COPYилиINSERT, ссылающиеся на корневую таблицу в иерархии секционирования, а не на эту секцию. В результате при загрузке данных подходящая секция будет выбираться заново для каждой строки. Это может быть полезно при восстановлении данных, когда на целевом сервере строки не всегда попадают в те же секции, в которых они находились на исходном. Это возможно, например, когда столбец секционирования имеет текстовый тип и в двух системах по-разному определено правило сортировки, по которому упорядочивается этот столбец.--lock-wait-timeout=время_ожиданияНе ждать бесконечно получения разделяемых блокировок таблиц в начале процедуры выгрузки. Вместо этого выдать ошибку, если не удастся заблокировать таблицы за указанное
время_ожидания. Это время можно задать в любом из форматов, принимаемых командойSET statement_timeout.--no-commentsНе выгружать комментарии.
--no-publicationsНе выгружать публикации.
--no-role-passwordsНе выгружать пароли ролей. При восстановлении все роли получат пароль NULL и не смогут пройти проверку подлинности, пока им не будут назначены пароли. Так как значения паролей не нужны, когда используется это указание, информация о ролях считывается из системного представления
pg_roles, а не изpg_authid. Таким образом, данный вариант может быть также полезен, если доступ кpg_authidограничен политикой безопасности.--no-security-labelsНе выгружать метки безопасности.
--no-subscriptionsНе выгружать подписки.
--no-syncПо умолчанию
pg_dumpallждёт, пока все файлы не будут надёжно записаны на диск. С данным параметромpg_dumpallзавершается немедленно, то есть выполняется быстрее, но в случае неожиданного сбоя операционной системы выгруженные данные могут оказаться испорченными. Вообще этот параметр предназначен прежде всего для тестирования, для производственной среды он не подходит.--no-table-access-methodНе выводить команды для выбора табличных методов доступа. При восстановлении все объекты будут создаваться с табличным методом доступа, выбираемым по умолчанию.
--no-tablespacesНе выводить команды, создающие или выбирающие табличные пространства для объектов. С этим параметром все объекты будут созданы в пространстве по умолчанию, установленном во время восстановления.
--no-toast-compressionНе выдавать команды, задающие методы сжатия TOAST. С этим указанием все столбцы будут восстановлены с методом сжатия, выбранным по умолчанию.
--no-unlogged-table-dataНе выгружать содержимое нежурналируемых таблиц. Этот параметр не влияет на то, как выгружаются определения этих таблиц (схема); он отключает только выгрузку данных из них.
--on-conflict-do-nothingДобавить предложения
ON CONFLICT DO NOTHINGв командыINSERT. Это указание допускается только при выборе режима--insertsили--column-inserts.--quote-all-identifiersПринудительно экранировать все идентификаторы. Этот параметр рекомендуется при выгрузке базы, когда основная версия сервера PostgreSQL, с которого выгружается база, отличается от версии pg_dumpall, или когда выгруженная копия предназначена для загрузки на сервере с другой основной версией. По умолчанию pg_dumpall экранирует только те идентификаторы, которые являются зарезервированными словами в собственной основной версии. Иногда это приводит к проблемам совместимости с серверами других версий, в которых множество зарезервированных слов может быть несколько другим. Применение параметра
--quote-all-identifiersпредотвращает подобные проблемы, ценой ухудшения читаемости скрипта с выгруженными данными.--restrict-key=restrict_keyИспользовать предоставленную строку в качестве ключа
\restrictpsql в выводе выгрузки. Если ключ ограничения не указан, pg_dumpall сгенерирует случайный ключ. Ключи могут содержать только буквенные и цифровые символы.Этот параметр в основном предназначен для целей тестирования и других сценариев, требующих повторящегося создания вывода (например, для сравнения файлов выгрузки). Параметр не рекомендуется использовать в повседневной работе, поскольку, зная принципы функционирования ключа, злоумышленник может внедрить произвольный код, который будет выполнен на машине при помощи psql и вывода выгрузки.
--rows-per-insert=число_строкВыгружать данные таблиц в виде команд
INSERTвместоCOPY. В данном параметре задаётся максимальное число строк для одной командыINSERT. Указанное в нём значение должно быть больше 0. При этом в случае каких-либо ошибок при восстановлении данных будут потеряны только строкиINSERT, где возникли ошибки, но не всё содержимое таблицы.--use-set-session-authorizationВыводить команды
SET SESSION AUTHORIZATION, соответствующие стандарту, вместоALTER OWNER, для назначения владельцев объектов. В результате выгруженный скрипт будет более стандартизированным, но может не восстановиться корректно, в зависимости от истории объектов.-?--helpПоказать справку по аргументам командной строки pg_dumpall и завершиться.
Далее описаны параметры управления подключением.
-dстрока_подключения--dbname=строка_подключенияУказывает параметры подключения к серверу в формате строки подключения; они будут переопределять любые одноимённые параметры, заданные в командной строке.
Этот параметр называется
--dbnameдля согласованности с другими клиентскими приложениями, но так как pg_dumpall подключается не к одной базе данных, имя базы в строке подключения игнорируется. Чтобы указать имя базы данных для начального подключения, которое будет использоваться для выгрузки глобальных объектов и обнаружения других выгружаемых баз, воспользуйтесь параметром-l.-hсервер--host=серверУказывает имя компьютера, на котором работает сервер баз данных. Если значение начинается с косой черты, оно определяет каталог Unix-сокета. Значение по умолчанию берётся из переменной окружения
PGHOST, если она установлена. В противном случае выполняется подключение к Unix-сокету.-lимя_бд--database=имя_бдЗадаёт имя базы данных, через подключение к которой будут выгружаться глобальные объекты и находиться другие выгружаемые базы. По умолчанию используется база
postgres, а в случае её отсутствия —template1.-pпорт--port=портУказывает TCP-порт или расширение файла локального Unix-сокета, через который сервер принимает подключения. Значение по умолчанию определяется переменной окружения
PGPORT, если она установлена, либо числом, заданным при компиляции.-Uимя_пользователя--username=имя_пользователяИмя пользователя, под которым производится подключение.
-w--no-passwordНе выдавать запрос на ввод пароля. Если сервер требует аутентификацию по паролю и пароль не доступен с помощью других средств, таких как файл
.pgpass, попытка соединения не удастся. Этот параметр может быть полезен в пакетных заданиях и скриптах, где нет пользователя, который вводит пароль.-W--passwordПринудительно запрашивать пароль перед подключением к базе данных.
Это несущественный параметр, так как pg_dumpall запрашивает пароль автоматически, если сервер проверяет подлинность по паролю. Однако чтобы понять это, pg_dumpall лишний раз подключается к серверу. Поэтому иногда имеет смысл ввести
-W, чтобы исключить эту ненужную попытку подключения.Заметьте, что пароль будет запрашиваться повторно для выгрузки каждой базы данных. Поэтому обычно лучше настроить файл
~/.pgpass, и не вводить пароль каждый раз вручную.--role=имя ролиЗадаёт имя роли, которая будет осуществлять выгрузку. Получив это имя, pg_dumpall выполнит
SET ROLEимя_ролипосле подключения к базе данных. Это полезно, когда проходящий проверку пользователь (указанный в-U) не имеет прав, необходимых для pg_dumpall, но может переключиться на роль, наделённую этими правами. В некоторых окружениях правила запрещают подключаться к серверу непосредственно суперпользователю, и этот параметр позволяет выполнить выгрузку, не нарушая их.
Переменные окружения
PGHOSTPGOPTIONSPGPORTPGUSERПараметры подключения по умолчанию
PG_COLORВыбирает вариант использования цвета в диагностических сообщениях. Возможные значения:
always(всегда),auto(автоматически) иnever(никогда).
Эта утилита, как и большинство других утилит PostgreSQL, также использует переменные среды, поддерживаемые libpq (см. Раздел 34.15).
Примечания
Так как pg_dumpall внутри себя вызывает pg_dump, часть диагностических сообщений будет относиться к pg_dump.
Ключ --clean может быть полезен, даже если вы намереваетесь восстановить копию из скрипта в новом кластере. С --clean скрипт сможет удалить и пересоздать встроенные базы данных postgres и template1, так что они получат свойства, которые имели одноимённые базы в исходном кластере (например, локаль и кодировку). Без данного ключа эти базы сохранят свои свойства уровня базы данных, а также всё существующее содержимое.
После восстановления имеет смысл запустить ANALYZE для каждой базы данных, чтобы оптимизатор получил актуальную статистику. Также можно запустить анализ для всех баз данных, выполнив команду vacuumdb -a -z.
Не следует ожидать, что скрипт выгрузки будет выполняться абсолютно без ошибок. В частности, так как он будет содержать CREATE ROLE для каждой существующей в исходном кластере роли, при попытке создать суперпользователя определённо произойдёт ошибка «role already exists» (роль уже существует), если только целевой кластер был инициализирован не с другим начальным именем суперпользователя. Эта ошибка некритична и её следует просто игнорировать. С ключом --clean весьма вероятны другие незначительные сообщения об ошибках, связанные с несуществующими объектами; их число можно минимизировать, добавив ключ --if-exists.
При использовании pg_dumpall требуется, чтобы все необходимые каталоги табличных пространств существовали до восстановления; в противном случае создание баз данных в нестандартном размещении завершится ошибкой.
Обычно рекомендуется использовать параметр -X (--no-psqlrc) при восстановлении базы данных из скрипта pg_dumpall, чтобы обеспечить чистый процесс восстановления и избежать потенциальных конфликтов с нестандартными конфигурациями psql. Кроме того, поскольку скрипт pg_dumpall может содержать метакоманды psql, он может быть несовместим с клиентами, отличными от psql.
Примеры
Выгрузка всех баз данных:
$pg_dumpall > db.out
Восстановить базы данных из этого файла можно так:
$psql -X -f db.out -d postgres
К какой базе вы подключаетесь, в принципе, не имеет значения, так как скрипт, созданный утилитой pg_dumpall, будет содержать все команды, требующиеся для создания сохранённых баз данных и подключения к ним. Однако это важно, если применяется ключ --clean — тогда вы должны изначально подключиться к базе postgres; скрипт попытается прежде всего удалить остальные базы данных, но не сможет этого сделать для базы, к которой вы подключены.
См. также
Обратитесь к описанию pg_dump, чтобы узнать об условиях, при которых могут возникнуть проблемы.
pg_dumpall
pg_dumpall — extract a PostgreSQL database cluster into a script file
Synopsis
pg_dumpall [connection-option...] [option...]
Description
pg_dumpall is a utility for writing out (“dumping”) all PostgreSQL databases of a cluster into one script file. The script file contains SQL commands that can be used as input to psql to restore the databases. It does this by calling pg_dump for each database in the cluster. pg_dumpall also dumps global objects that are common to all databases, namely database roles, tablespaces, and privilege grants for configuration parameters. (pg_dump does not save these objects.)
Since pg_dumpall reads tables from all databases you will most likely have to connect as a database superuser in order to produce a complete dump. Also you will need superuser privileges to execute the saved script in order to be allowed to add roles and create databases.
The SQL script will be written to the standard output. Use the -f/--file option or shell operators to redirect it into a file.
pg_dumpall needs to connect several times to the PostgreSQL server (once per database). If you use password authentication it will ask for a password each time. It is convenient to have a ~/.pgpass file in such cases. See Section 34.16 for more information.
Warning
Restoring a dump causes the destination to execute arbitrary code of the source superusers' choice. Partial dumps and partial restores do not limit that. If the source superusers are not trusted, the dumped SQL statements must be inspected before restoring. Note that the client running the dump and restore need not trust the source or destination superusers.
Options
The following command-line options control the content and format of the output.
-a--data-onlyDump only the data, not the schema (data definitions).
-c--cleanEmit SQL commands to
DROPall the dumped databases, roles, and tablespaces before recreating them. This option is useful when the restore is to overwrite an existing cluster. If any of the objects do not exist in the destination cluster, ignorable error messages will be reported during restore, unless--if-existsis also specified.-Eencoding--encoding=encodingCreate the dump in the specified character set encoding. By default, the dump is created in the database encoding. (Another way to get the same result is to set the
PGCLIENTENCODINGenvironment variable to the desired dump encoding.)-ffilename--file=filenameSend output to the specified file. If this is omitted, the standard output is used.
-g--globals-onlyDump only global objects (roles and tablespaces), no databases.
-O--no-ownerDo not output commands to set ownership of objects to match the original database. By default, pg_dumpall issues
ALTER OWNERorSET SESSION AUTHORIZATIONstatements to set ownership of created schema elements. These statements will fail when the script is run unless it is started by a superuser (or the same user that owns all of the objects in the script). To make a script that can be restored by any user, but will give that user ownership of all the objects, specify-O.-r--roles-onlyDump only roles, no databases or tablespaces.
-s--schema-onlyDump only the object definitions (schema), not data.
-Susername--superuser=usernameSpecify the superuser user name to use when disabling triggers. This is relevant only if
--disable-triggersis used. (Usually, it's better to leave this out, and instead start the resulting script as superuser.)-t--tablespaces-onlyDump only tablespaces, no databases or roles.
-v--verboseSpecifies verbose mode. This will cause pg_dumpall to output start/stop times to the dump file, and progress messages to standard error. Repeating the option causes additional debug-level messages to appear on standard error. The option is also passed down to pg_dump.
-V--versionPrint the pg_dumpall version and exit.
-x--no-privileges--no-aclPrevent dumping of access privileges (grant/revoke commands).
--binary-upgradeThis option is for use by in-place upgrade utilities. Its use for other purposes is not recommended or supported. The behavior of the option may change in future releases without notice.
--column-inserts--attribute-insertsDump data as
INSERTcommands with explicit column names (INSERT INTO). This will make restoration very slow; it is mainly useful for making dumps that can be loaded into non-PostgreSQL databases.table(column, ...) VALUES ...--disable-dollar-quotingThis option disables the use of dollar quoting for function bodies, and forces them to be quoted using SQL standard string syntax.
--disable-triggersThis option is relevant only when creating a data-only dump. It instructs pg_dumpall to include commands to temporarily disable triggers on the target tables while the data is restored. Use this if you have referential integrity checks or other triggers on the tables that you do not want to invoke during data restore.
Presently, the commands emitted for
--disable-triggersmust be done as superuser. So, you should also specify a superuser name with-S, or preferably be careful to start the resulting script as a superuser.--exclude-database=patternDo not dump databases whose name matches
pattern. Multiple patterns can be excluded by writing multiple--exclude-databaseswitches. Thepatternparameter is interpreted as a pattern according to the same rules used by psql's\dcommands (see Patterns), so multiple databases can also be excluded by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent shell wildcard expansion.--extra-float-digits=ndigitsUse the specified value of extra_float_digits when dumping floating-point data, instead of the maximum available precision. Routine dumps made for backup purposes should not use this option.
--if-existsUse
DROP ... IF EXISTScommands to drop objects in--cleanmode. This suppresses “does not exist” errors that might otherwise be reported. This option is not valid unless--cleanis also specified.--insertsDump data as
INSERTcommands (rather thanCOPY). This will make restoration very slow; it is mainly useful for making dumps that can be loaded into non-PostgreSQL databases. Note that the restore might fail altogether if you have rearranged column order. The--column-insertsoption is safer, though even slower.--load-via-partition-rootWhen dumping data for a table partition, make the
COPYorINSERTstatements target the root of the partitioning hierarchy that contains it, rather than the partition itself. This causes the appropriate partition to be re-determined for each row when the data is loaded. This may be useful when restoring data on a server where rows do not always fall into the same partitions as they did on the original server. That could happen, for example, if the partitioning column is of type text and the two systems have different definitions of the collation used to sort the partitioning column.--lock-wait-timeout=timeoutDo not wait forever to acquire shared table locks at the beginning of the dump. Instead, fail if unable to lock a table within the specified
timeout. The timeout may be specified in any of the formats accepted bySET statement_timeout.--no-commentsDo not dump comments.
--no-publicationsDo not dump publications.
--no-role-passwordsDo not dump passwords for roles. When restored, roles will have a null password, and password authentication will always fail until the password is set. Since password values aren't needed when this option is specified, the role information is read from the catalog view
pg_rolesinstead ofpg_authid. Therefore, this option also helps if access topg_authidis restricted by some security policy.--no-security-labelsDo not dump security labels.
--no-subscriptionsDo not dump subscriptions.
--no-syncBy default,
pg_dumpallwill wait for all files to be written safely to disk. This option causespg_dumpallto return without waiting, which is faster, but means that a subsequent operating system crash can leave the dump corrupt. Generally, this option is useful for testing but should not be used when dumping data from production installation.--no-table-access-methodDo not output commands to select table access methods. With this option, all objects will be created with whichever table access method is the default during restore.
--no-tablespacesDo not output commands to create tablespaces nor select tablespaces for objects. With this option, all objects will be created in whichever tablespace is the default during restore.
--no-toast-compressionDo not output commands to set TOAST compression methods. With this option, all columns will be restored with the default compression setting.
--no-unlogged-table-dataDo not dump the contents of unlogged tables. This option has no effect on whether or not the table definitions (schema) are dumped; it only suppresses dumping the table data.
--on-conflict-do-nothingAdd
ON CONFLICT DO NOTHINGtoINSERTcommands. This option is not valid unless--insertsor--column-insertsis also specified.--quote-all-identifiersForce quoting of all identifiers. This option is recommended when dumping a database from a server whose PostgreSQL major version is different from pg_dumpall's, or when the output is intended to be loaded into a server of a different major version. By default, pg_dumpall quotes only identifiers that are reserved words in its own major version. This sometimes results in compatibility issues when dealing with servers of other versions that may have slightly different sets of reserved words. Using
--quote-all-identifiersprevents such issues, at the price of a harder-to-read dump script.--restrict-key=restrict_keyUse the provided string as the psql
\restrictkey in the dump output. If no restrict key is specified, pg_dumpall will generate a random one as needed. Keys may contain only alphanumeric characters.This option is primarily intended for testing purposes and other scenarios that require repeatable output (e.g., comparing dump files). It is not recommended for general use, as a malicious server with advance knowledge of the key may be able to inject arbitrary code that will be executed on the machine that runs psql with the dump output.
--rows-per-insert=nrowsDump data as
INSERTcommands (rather thanCOPY). Controls the maximum number of rows perINSERTcommand. The value specified must be a number greater than zero. Any error during restoring will cause only rows that are part of the problematicINSERTto be lost, rather than the entire table contents.--use-set-session-authorizationOutput SQL-standard
SET SESSION AUTHORIZATIONcommands instead ofALTER OWNERcommands to determine object ownership. This makes the dump more standards compatible, but depending on the history of the objects in the dump, might not restore properly.-?--helpShow help about pg_dumpall command line arguments, and exit.
The following command-line options control the database connection parameters.
-dconnstr--dbname=connstrSpecifies parameters used to connect to the server, as a connection string; these will override any conflicting command line options.
The option is called
--dbnamefor consistency with other client applications, but because pg_dumpall needs to connect to many databases, the database name in the connection string will be ignored. Use the-loption to specify the name of the database used for the initial connection, which will dump global objects and discover what other databases should be dumped.-hhost--host=hostSpecifies the host name of the machine on which the database server is running. If the value begins with a slash, it is used as the directory for the Unix domain socket. The default is taken from the
PGHOSTenvironment variable, if set, else a Unix domain socket connection is attempted.-ldbname--database=dbnameSpecifies the name of the database to connect to for dumping global objects and discovering what other databases should be dumped. If not specified, the
postgresdatabase will be used, and if that does not exist,template1will be used.-pport--port=portSpecifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the
PGPORTenvironment variable, if set, or a compiled-in default.-Uusername--username=usernameUser name to connect as.
-w--no-passwordNever issue a password prompt. If the server requires password authentication and a password is not available by other means such as a
.pgpassfile, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.-W--passwordForce pg_dumpall to prompt for a password before connecting to a database.
This option is never essential, since pg_dumpall will automatically prompt for a password if the server demands password authentication. However, pg_dumpall will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing
-Wto avoid the extra connection attempt.Note that the password prompt will occur again for each database to be dumped. Usually, it's better to set up a
~/.pgpassfile than to rely on manual password entry.--role=rolenameSpecifies a role name to be used to create the dump. This option causes pg_dumpall to issue a
SET ROLErolenamecommand after connecting to the database. It is useful when the authenticated user (specified by-U) lacks privileges needed by pg_dumpall, but can switch to a role with the required rights. Some installations have a policy against logging in directly as a superuser, and use of this option allows dumps to be made without violating the policy.
Environment
PGHOSTPGOPTIONSPGPORTPGUSERDefault connection parameters
PG_COLORSpecifies whether to use color in diagnostic messages. Possible values are
always,autoandnever.
This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 34.15).
Notes
Since pg_dumpall calls pg_dump internally, some diagnostic messages will refer to pg_dump.
The --clean option can be useful even when your intention is to restore the dump script into a fresh cluster. Use of --clean authorizes the script to drop and re-create the built-in postgres and template1 databases, ensuring that those databases will retain the same properties (for instance, locale and encoding) that they had in the source cluster. Without the option, those databases will retain their existing database-level properties, as well as any pre-existing contents.
Once restored, it is wise to run ANALYZE on each database so the optimizer has useful statistics. You can also run vacuumdb -a -z to analyze all databases.
The dump script should not be expected to run completely without errors. In particular, because the script will issue CREATE ROLE for every role existing in the source cluster, it is certain to get a “role already exists” error for the bootstrap superuser, unless the destination cluster was initialized with a different bootstrap superuser name. This error is harmless and should be ignored. Use of the --clean option is likely to produce additional harmless error messages about non-existent objects, although you can minimize those by adding --if-exists.
pg_dumpall requires all needed tablespace directories to exist before the restore; otherwise, database creation will fail for databases in non-default locations.
It is generally recommended to use the -X (--no-psqlrc) option when restoring a database from a pg_dumpall script to ensure a clean restore process and prevent potential conflicts with non-default psql configurations. Additionally, because the pg_dumpall script may include psql meta-commands, it may be incompatible with clients other than psql.
Examples
To dump all databases:
$pg_dumpall > db.out
To restore database(s) from this file, you can use:
$psql -X -f db.out -d postgres
It is not important which database you connect to here since the script file created by pg_dumpall will contain the appropriate commands to create and connect to the saved databases. An exception is that if you specified --clean, you must connect to the postgres database initially; the script will attempt to drop other databases immediately, and that will fail for the database you are connected to.
See Also
Check pg_dump for details on possible error conditions.