pg_dump

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

Включает большие объекты в выгрузку. Это поведение используется по умолчанию, за исключением случаев, когда указаны параметры --schema, --table или --schema-only. Параметр -b имеет смысл только для добавления больших объектов в выгрузки, в которых запрошена конкретная схема или таблица. Обратите внимание, что большие объекты считаются данными и включаются при использовании --data-only, но не включаются при использовании --schema-only.

Добавляет в текстовый выходной файл команды удаления объектов базы данных перед выводом команд их создания. При восстановлении могут появляться безвредные сообщения об ошибках, если какие-либо объекты отсутствуют в целевой базе данных. Обратите внимание, что объекты не удаляются до начала выгрузки, однако команды DROP включаются в выходной DDL-файл и при восстановлении выполняются перед соответствующими командами CREATE. Параметр имеет смысл только для формата обычного текста. Для архивных форматов его следует указывать при вызове pg_restore.

Начинает вывод с команды создания базы данных и переподключения к только что созданной базе. При использовании скрипта не имеет значения, к какой базе данных вы подключены в целевой системе перед запуском. Если также указан параметр --clean, скрипт сначала удаляет целевую базу данных, а затем создает ее заново перед переподключением. Параметр имеет смысл только для формата обычного текста. Для архивных форматов его можно указать при вызове pg_restore.

Создает выгрузку в указанной кодировке символов. По умолчанию используется кодировка базы данных. Альтернативный способ получить тот же результат — установить переменную окружения PGCLIENTENCODING в требуемую кодировку выгрузки.

Направляет вывод в указанный файл. Для файловых форматов этот параметр можно опустить — тогда используется стандартный вывод. Для формата вывода в виде каталога параметр обязателен: он задает целевой каталог, а не отдельный файл. Каталог создается утилитой pg_dump и не должен существовать заранее.

Выбирает формат вывода. format может быть одним из следующих:

Выполняет параллельную выгрузку, обрабатывая одновременно njobs таблиц. Этот параметр сокращает время выгрузки, но увеличивает нагрузку на сервер баз данных. Параметр можно использовать только с форматом вывода в виде каталога, так как это единственный формат, позволяющий нескольким процессам одновременно записывать свои данные.

Выгружает только схемы, соответствующие указанному шаблону, включая все объекты внутри них. Если параметр не указан, выгружаются все несистемные схемы целевой базы данных. Для выбора нескольких схем можно использовать несколько параметров -n. Параметр также интерпретируется как шаблон по тем же правилам, что применяются в командах \d в psql, поэтому можно указать несколько схем с помощью символов подстановки. При использовании символов подстановки заключайте шаблон в кавычки, чтобы предотвратить их раскрытие оболочкой.

Исключает из выгрузки схемы, соответствующие указанному шаблону. Шаблон интерпретируется по тем же правилам, что и для -n. Параметр -N можно использовать несколько раз для исключения схем, соответствующих любому из нескольких шаблонов. Если указаны оба параметра -n и -N, выгружаются только схемы, которые соответствуют хотя бы одному -n, но не соответствуют ни одному -N. Если -N используется без -n, схемы, соответствующие -N, исключаются из стандартной выгрузки.

Включает идентификаторы объектов (OID) в данные каждой таблицы при выгрузке. Использование этого параметра не рекомендуется для файлов, которые планируется восстанавливать в Greengage DB.

Не включает команды для установки владельца объектов в соответствии с исходной базой данных. По умолчанию pg_dump добавляет операторы ALTER OWNER или SET SESSION AUTHORIZATION, чтобы установить владельца созданных объектов. Эти команды вызовут ошибку при запуске скрипта, если он выполняется не суперпользователем или не пользователем, который владеет всеми объектами в скрипте. Чтобы создать скрипт, который может быть восстановлен любым пользователем и при этом назначит этому пользователю владение всеми объектами, используйте -O. Параметр имеет смысл только для формата обычного текста. Для архивных форматов его можно указать при вызове pg_restore.

Выгружает только определения объектов (схему), без данных.

Задает имя суперпользователя для использования при деактивации триггеров. Актуально только при использовании параметра --disable-triggers. Рекомендуется не указывать этот параметр и вместо этого запускать полученный скрипт от имени суперпользователя.

Выгружает только таблицы (или представления, последовательности, сторонние таблицы), соответствующие указанному шаблону. Имя таблицы указывается в формате schema.table.

Исключает из выгрузки все таблицы, соответствующие указанному шаблону. Шаблон интерпретируется так же, как для параметра -t. Параметр -T можно указать несколько раз, чтобы исключить таблицы, соответствующие любому из шаблонов.

Включает подробный режим вывода. В этом режиме pg_dump выводит детальные комментарии к объектам и время начала/окончания в дампе, а сообщения о ходе выполнения — в стандартный поток ошибок.

Выводит версию pg_dump и завершает работу.

Не включает в выгрузку привилегии доступа (команды GRANT/REVOKE).

Задает уровень сжатия для выгрузки. Значение 0 означает отсутствие сжатия.

Параметр предназначен для использования утилитами обновления на месте. Использование его для других целей не рекомендуется и не поддерживается.

Выгружает данные в виде команд INSERT с явным указанием имен столбцов (INSERT INTO <table> (<column>, …​) VALUES …​). Это делает восстановление значительно медленнее и в основном полезно для выгрузок, предназначенных для баз данных, несовместимых с PostgreSQL. При этом каждая строка создается отдельной командой, поэтому ошибка при загрузке затронет только эту строку, а не всю таблицу.

Отключает использование долларовых кавычек для тел функций и принудительно применяет обычные строковые литералы SQL.

Применяется только при выгрузке данных (--data-only). Указывает pg_dump включить команды для временной деактивации триггеров в целевых таблицах при перезагрузке данных. Используется, если в таблицах есть триггеры, которые не должны срабатывать во время загрузки. Команды для --disable-triggers должны выполняться от имени суперпользователя. Либо укажите имя суперпользователя через -S, либо предпочтительнее запустите скрипт напрямую от имени суперпользователя. Параметр применим только для обычного текстового формата. Для архивных форматов его можно указать при вызове pg_restore.

Исключает данные из выгрузки для всех таблиц, соответствующих указанному шаблону. Шаблон интерпретируется так же, как для параметра -t. Параметр можно указать несколько раз, чтобы исключить таблицы по разным шаблонам. Это полезно, когда требуется сохранить определения таблиц, но не их данные.

Добавляет выражение IF EXISTS к командам удаления объектов базы данных. Применяется только вместе с параметром --clean.

Выгружает данные в виде команд INSERT вместо COPY. Это замедляет восстановление, но полезно для выгрузок, которые необходимо загрузить в СУБД, отличную от PostgreSQL. Так как для каждой строки создается отдельная команда, ошибка при восстановлении затронет только эту строку, а не всю таблицу. Обратите внимание: восстановление может полностью не выполниться при изменении порядка столбцов. Параметр --column-inserts безопасен относительно изменения порядка столбцов, но еще медленнее.

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

Не выгружает метки безопасности.

Не выводит команды для выбора табличных пространств. С этим параметром все объекты будут созданы в том табличном пространстве, которое используется по умолчанию во время восстановления.

Не выгружает данные из нежурналируемых таблиц. Определения таблиц (схема) выгружаются как обычно; содержимое таблиц при этом не экспортируется. При выгрузке с резервного сервера данные из нежурналируемых таблиц всегда исключаются.

Принудительно заключает все идентификаторы в кавычки. Рекомендуется использовать при выгрузке базы данных с сервера, основная версия Greengage DB которого отличается от версии pg_dump, или если выгрузка предназначена для загрузки на сервер другой основной версии. По умолчанию pg_dump заключает в кавычки только идентификаторы, являющиеся зарезервированными словами в его текущей версии. Это может вызвать проблемы совместимости с серверами других версий, у которых набор зарезервированных слов отличается. Использование --quote-all-identifiers предотвращает такие проблемы, хотя делает скрипт выгрузки менее читаемым.

Выгружает только указанную секцию. Имя секции может быть pre-data, data или post-data. Этот параметр можно указать более одного раза для выбора нескольких секций. По умолчанию выгружаются все секции.

Использует сериализуемую транзакцию для выгрузки, чтобы гарантировать, что используемый снепшот согласован с последующими состояниями базы данных; делает это путем ожидания точки в потоке транзакций, в которой не могут присутствовать аномалии, так что нет риска сбоя выгрузки или отката других транзакций с ошибкой serialization_failure.

Выводит команды SQL-стандарта SET SESSION AUTHORIZATION вместо ALTER OWNER для установки владения объектами. Это повышает совместимость со стандартами, но может привести к некорректному восстановлению в зависимости от истории объектов. Выгрузка с SET SESSION AUTHORIZATION потребует привилегий суперпользователя для корректного восстановления, тогда как ALTER OWNER требует меньших привилегий.

Используйте --gp-syntax для включения синтаксиса Greengage DB в операторах CREATE TABLE. Это позволяет экспортировать политику распределения (выражения DISTRIBUTED BY или DISTRIBUTED RANDOMLY) таблиц Greengage DB, что важно при восстановлении в других кластерах Greengage DB. По умолчанию синтаксис Greengage DB включается при подключении к кластеру Greengage DB и исключается при подключении к PostgreSQL.

Выгружает функции, указанные списком идентификаторов объектов (OIDs).

Выгружает отношения, указанные списком идентификаторов объектов (OIDs).

Отображает справку по аргументам командной строки pg_dump и завершает работу.

Указывает имя базы данных для подключения. Это эквивалентно указанию dbname в качестве первого позиционного аргумента в командной строке.

Имя хоста, на котором работает мастер Greengage DB. Если параметр не указан, читается из переменной окружения PGHOST; по умолчанию используется localhost.

TCP-порт, на котором мастер Greengage DB прослушивает подключения. Если параметр не указан, читается из переменной окружения PGPORT; по умолчанию используется порт 5432.

Имя роли базы данных для подключения. Если параметр не указан, читается из переменной окружения PGUSER; по умолчанию используется имя текущей системной роли.

Принудительно запрашивает пароль при подключении.

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

Указывает роль, которая будет использоваться для создания выгрузки. После подключения к базе данных pg_dump выполнит команду SET ROLE rolename. Это полезно, когда аутентифицированному пользователю (через -U) не хватает прав, необходимых pg_dump, но он может переключиться на роль с нужными привилегиями. Некоторые инсталляции ограничивают прямой вход от имени суперпользователя; использование этого параметра позволяет создавать выгрузки, соблюдая политику безопасности.