pg_dumpall
pg_dumpall — выгрузить кластер баз данных Postgres Pro в файл скрипта
Синтаксис
pg_dumpall [параметр-подключения...] [параметр...]
Описание
Утилита pg_dumpall предназначена для записи («выгрузки») всех баз данных кластера Postgres Pro в один файл в формате скрипта. Этот файл содержит команды SQL, так что передав его на вход psql, можно восстановить все базы данных. Чтобы его сформировать, pg_dumpall вызывает для каждой базы данных в кластере pg_dump и дополнительно выгружает глобальные объекты, общие для всех баз данных. (Утилита pg_dump не сохраняет эти объекты.) В настоящее время, к таким объектам относятся группы, пользователи и табличные пространства, а также такие свойства, как права доступа, которые применяются к базам данных в целом.
Так как утилита pg_dumpall читает таблицы из всех баз данных, для получения полного содержимого баз запускать её, как правило, нужно от имени суперпользователя. Чтобы впоследствии выполнить сохранённый скрипт, также необходимо иметь права суперпользователя, позволяющие создавать пользователей, группы и собственно базы данных.
Генерируемый SQL-скрипт записывается в стандартное устройство вывода. Чтобы перенаправить его в файл, воспользуйтесь параметром -f/--file или операторами оболочки.
Утилите pg_dumpall требуется подключаться к серверу Postgres Pro несколько раз (к каждой базе по отдельности). Если вы проходите проверку подлинности по паролю, вам придётся каждый раз вводить пароль. Чтобы избежать этого, удобно иметь файл ~/.pgpass. За дополнительными сведениями обратитесь к Разделу 31.15.
Параметры
Параметры командной строки для управления содержимым и форматом вывода.
- -a- --data-only
- Выгружать только данные, без схемы (определений данных). 
- -c- --clean
- Добавить команды SQL для удаления (DROP) баз данных перед командами, создающими их. В дополнение к ним добавляются команды - DROPдля ролей и табличных пространств.
- -f- имя_файла- --file=- имя_файла
- Направить вывод в указанный файл. Если этот параметр опущен, скрипт записывается в стандартный вывод. 
- -g- --globals-only
- Выгружать только глобальные объекты (роли и табличные пространства), без баз данных. 
- -o- --oids
- Выгружать идентификаторы объектов (OIDs) вместе с данными таблиц. Используйте этот параметр, если в приложении есть ссылки на OID, например во внешних ключах. В противном случае, этот параметр лучше не использовать. 
- -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). При этом восстановление будет очень медленным; в основном это применяется для выгрузки данных, которые затем будут загружаться не в Postgres Pro.- таблица(- столбец, ...) VALUES ...
- --disable-dollar-quoting
- Этот параметр запрещает заключать в доллары тело функций, что оставляет возможность только заключать их в кавычки, применяя стандартный синтаксис SQL. 
- --disable-triggers
- Этот параметр действует только при выгрузке одних данных. С ним pg_dumpall добавляет команды, отключающие триггеры в целевых таблицах на время загрузки данных. Используйте его, если в ваших таблицах определены проверки ссылочной целостности или другие триггеры, которые вы не хотели бы выполнять в процессе загрузки данных. - В настоящее время команды, генерируемые с параметром - --disable-triggers, должны исполняться от имени суперпользователя. Таким образом, необходимо также передавать флаг- -S, либо при восстановлении выполнять скрипт от имени суперпользователя.
- --if-exists
- Использовать условные команды (т. е. добавлять предложение - IF EXISTS) при очистке базы данных и других объектов. Этот параметр принимается, только если также указан параметр- --clean.
- --inserts
- Выгружать данные в виде команд - INSERT, а не- COPY. При этом восстановление значительно замедлится; в основном это применяется для выгрузки данных, которые затем будут загружаться не в Postgres Pro. Заметьте, что восстановление может вовсе не выполниться при изменении порядка столбцов в таблицах. В этом смысле параметр- --column-insertsбезопаснее, но восстановление будет ещё медленнее.
- --lock-wait-timeout=- время_ожидания
- Не ждать бесконечно получения разделяемых блокировок таблиц в начале процедуры выгрузки. Вместо этого выдать ошибку, если не удастся заблокировать таблицы за указанное - время_ожидания. Это время можно задать в любом из форматов, принимаемых командой- SET statement_timeout. Допустимые значения зависят от версии сервера, выгружающего данные, но количество миллисекунд в виде целого числа принимают все версии, начиная с 7.3. Более ранние версии игнорируют этот параметр.
- --no-security-labels
- Не выгружать метки безопасности. 
- --no-tablespaces
- Не выводить команды, создающие или выбирающие табличные пространства для объектов. С этим параметром все объекты будут созданы в пространстве по умолчанию, установленном во время восстановления. 
- --no-unlogged-table-data
- Не выгружать содержимое нежурналируемых таблиц. Этот параметр не влияет на то, как выгружаются определения этих таблиц (схема); он отключает только выгрузку данных из них. 
- --quote-all-identifiers
- Принудительно экранировать все идентификаторы. Этот параметр рекомендуется при выгрузке базы, когда основная версия сервера PostgreSQL, с которого выгружается база, отличается от версии pg_dumpall, или когда выгруженная копия предназначена для загрузки на сервере с другой основной версией. По умолчанию pg_dumpall экранирует только те идентификаторы, которые являются зарезервированными словами в собственной основной версии. Иногда это приводит к проблемам совместимости с серверами других версий, в которых множество зарезервированных слов может быть несколько другим. Применение параметра - --quote-all-identifiersпредотвращает подобные проблемы, ценой ухудшения читаемости скрипта с выгруженными данными.
- --use-set-session-authorization
- Выводить команды - SET SESSION AUTHORIZATION, соответствующие стандарту, вместо- ALTER OWNER, для назначения владельцев объектов. В результате выгруженный скрипт будет более стандартизированным, но может не восстановиться корректно, в зависимости от истории объектов.
- -?- --help
- Показать справку по аргументам командной строки pg_dumpall и завершиться. 
Далее описаны параметры управления подключением.
- -d- строка_подключения- --dbname=- строка_подключения
- Указывает параметры подключения к серверу в формате строки подключения. См. Подраздел 31.1.1 для более подробной информации. - Этот параметр называется - --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, но может переключиться на роль, наделённую этими правами. В некоторых окружениях правила запрещают подключаться к серверу непосредственно суперпользователю, и этот параметр позволяет выполнить выгрузку, не нарушая их.
Переменные окружения
- PGHOST- PGOPTIONS- PGPORT- PGUSER
- Параметры подключения по умолчанию 
Эта утилита, как и большинство других утилит Postgres Pro, также использует переменные среды, поддерживаемые libpq (см. Раздел 31.14).
Замечания
Так как pg_dumpall внутри себя вызывает pg_dump, часть диагностических сообщений будет относиться к pg_dump.
После восстановления имеет смысл запустить ANALYZE для каждой базы данных, чтобы оптимизатор получил актуальную статистику. Также можно запустить анализ для всех баз данных, выполнив команду vacuumdb -a -z.
При использовании pg_dumpall требуется, чтобы все необходимые каталоги табличных пространств существовали до восстановления; в противном случае создание баз данных в нестандартном размещении завершится ошибкой.
Примеры
Выгрузка всех баз данных:
$pg_dumpall > db.out
Загрузить базы данных из этого файла можно так:
$psql -f db.out postgres
(К какой базе данных вы подключаетесь, здесь не важно, так как скрипт, созданный утилитой pg_dumpall, будет содержать все команды, требующиеся для создания сохранённых баз данных и подключения к ним.)
См. также
Обратитесь к описанию pg_dump, чтобы узнать об условиях, при которых могут возникнуть проблемы.