Устанавливает целевой каталог для записи вывода. pg_basebackup создаст этот каталог (и любые отсутствующие родительские каталоги), если он не существует. Если он уже существует, он должен быть пустым.

Когда резервная копия находится в формате tar, целевой каталог может быть указан как - (тире), что приводит к записи tar файла в stdout.

Эта опция обязательна.

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

Создает standby.signal файл и добавляет настройки подключения в файл postgresql.auto.conf в целевом каталоге (или внутри базового архивного файла при использовании формата tar). Это упрощает настройку резервного сервера с использованием результатов резервного копирования.

Файл postgresql.auto.conf будет записывать настройки соединения и, если указано, слот репликации, который использует pg_basebackup, чтобы потоковая репликация использовала те же настройки позже.

Указывает серверу, куда поместить базовую резервную копию. По умолчанию целью является client, что означает, что резервная копия должна быть отправлена на машину, где запущено pg_basebackup. Если цель установлена на server:/some/path, резервная копия будет сохранена на машине, где запущен сервер, в каталоге /some/path. Для сохранения резервной копии на сервере требуются привилегии суперпользователя или привилегии роли pg_write_server_files. Если цель установлена на blackhole, содержимое будет отброшено и никуда не сохранено. Это следует использовать только для тестирования, так как вы не получите фактическую резервную копию.

Так как передача WAL-журналов осуществляется приложением pg_basebackup, а не сервером, эта опция не может использоваться вместе с -Xstream. Поскольку -Xstream является значением по умолчанию, при указании этой опции вы также должны указать --Xfetch или -Xnone.

Перемещает табличного пространства из каталога olddir в newdir во время резервного копирования. Чтобы это сработало, olddir должен точно соответствовать пути, указанному для табличного пространства на исходном сервере. (Однако, если на исходном сервере нет табличного пространства в olddir, это не является ошибкой). В то же время newdir - это каталог в файловой системе принимающего хоста. Как и для основной целевого каталога, newdir не обязательно должен уже существовать, но если он существует, он должен быть пустым. И olddir, и newdir должны быть абсолютными путями. Если в любом из путей нужно использовать знак равенства (=), перед ним следует поставить обратную косую черту. Эту опцию можно указывать несколько раз для нескольких табличных пространств.

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

В настоящее время эта опция работает только с форматом вывода plain; она игнорируется, если выбран формат tar.

Устанавливает каталог для записи файлов журнала предзаписи (журнала предварительной записи). По умолчанию файлы WAL будут размещены в подкаталоге pg_wal целевого каталога, но эту опцию можно использовать для размещения их в другом месте. waldir должен быть абсолютным путем. Как и с основным целевым каталогом, waldir не обязательно должен уже существовать, но если он существует, то он должен быть пустым. Эту опцию можно указать только при резервном копировании в обычном формате.

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

Поддерживаются следующие method сбора журналов предварительной записи:

Включает сжатие gzip для вывода файлов tar с уровнем сжатия по умолчанию. Сжатие доступно только при использовании формата tar, и суффикс .gz будет автоматически добавлен ко всем именам файлов tar.

Сжатие резервной копии. Если включены client или server, указывается, где будет выполняться сжатие. Сжатие на сервере уменьшит пропускную способность передачи, но увеличит использование процессора сервера. По умолчанию используется client, за исключением случаев, когда используется --target. В этом случае резервная копия не отправляется клиенту, поэтому имеет смысл использовать только сжатие на сервере. При использовании -Xstream, который является значением по умолчанию, сжатие на стороне сервера не будет применяться к WAL. Чтобы сжать WAL, используйте сжатие на стороне клиента или указывайте -Xfetch.

Метод сжатия может быть установлен на gzip, lz4, zstd или none для отсутствия сжатия. Можно также указать строку деталей сжатия. Если строка деталей является целым числом, она указывает уровень сжатия. В противном случае, она должна быть списком элементов, разделенных запятыми, каждый из которых имеет форму keyword или keyword=value. В настоящее время поддерживаются ключевые слова level и workers.

Если уровень сжатия не указан, будет использоваться уровень сжатия по умолчанию. Если указан только уровень без указания алгоритма, будет использоваться сжатие gzip, если уровень больше 0, и сжатие не будет использоваться, если уровень равен 0.

Когда используется формат gzip, lz4, или zstd, к именам всех файлов tar автоматически добавляется соответствующий суффикс .gz, .lz4, или .zst. При использовании простого формата сжатие на стороне клиента может не указываться, но все равно возможно запросить сжатие на стороне сервера. Если это сделано, сервер сжимает резервную копию для передачи, а клиент разжимает и извлекает ее.

Когда эта опция используется в сочетании с -Xstream, pg_wal.tar будет сжат с использованием gzip, если выбрана клиентская сжатие gzip, но не будет сжат, если выбран любой другой алгоритм сжатия или если выбрана серверная сжатие.

Устанавливает режим контрольной точки на быстрый (немедленный) или распределенный (по умолчанию) (см. Раздел 25.3.3).

Указывает, что слот репликации, указанный опцией --slot, должен быть создан перед началом резервного копирования. Если слот уже существует, будет сгенерирована ошибка.

Устанавливает метку для резервной копии. Если не указано никакое значение, будет использовано значение по умолчанию “pg_basebackup базовая резервная копия”.

По умолчанию, когда pg_basebackup прерывается с ошибкой, он удаляет все созданные им ранее каталоги перед обнаружением того, что не может завершить задачу (например, целевой каталог и каталог журнала предварительной записи). Этот параметр подавляет очистку и поэтому полезен для отладки.

Обратите внимание, что каталоги табличного пространства не очищаются ни одним из способов.

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

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

Устанавливает максимальную скорость передачи данных с исходного сервера. Это может быть полезно для ограничения влияния pg_basebackup на сервер. Значения указываются в килобайтах в секунду. Для указания мегабайт в секунду используется суффикс M. Суффикс k также принимается, но не оказывает никакого эффекта. Допустимые значения находятся в диапазоне от 32 килобайт в секунду до 1024 мегабайт в секунду.

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

Эта опция может использоваться только вместе с -X stream. Она заставляет потоковую передачу WAL использовать указанный слот репликации. Если базовая резервная копия предназначена для использования в качестве резервной копии потоковой репликации с использованием слота репликации, резервная копия должна использовать то же имя слота репликации, что и primary_slot_name. Это гарантирует, что основной сервер не удаляет необходимые данные WAL во время между окончанием базовой резервной копии и началом потоковой репликации на новой резервной копии.

Указанный слот репликации должен существовать, если не используется опция -C.

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

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

Определяет алгоритм контрольной суммы, который должен быть применен к каждому файлу, включенному в резервную копию. В настоящее время доступны следующие алгоритмы: NONE, CRC32C, SHA224, SHA256, SHA384 и SHA512. По умолчанию используется CRC32C.

Если выбрано значение NONE, то в резервной копии не будет содержаться никаких контрольных сумм. В противном случае, она будет содержать контрольную сумму каждого файла в резервной копии с использованием указанного алгоритма. Кроме того, в манифесте всегда будет содержаться контрольная сумма SHA256 его собственного содержимого. Алгоритмы SHA требуют значительно больше вычислительных ресурсов, чем CRC32C, поэтому выбор одного из них может увеличить время, необходимое для завершения резервного копирования.

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

pg_verifybackup может быть использовано для проверки целостности резервной копии по отношению к манифесту резервной копии.

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

Сохраняет сервер от оценки общего объема резервных данных, которые будут передаваться, что приводит к тому, что столбец backup_total в представлении pg_stat_progress_basebackup всегда будет иметь значение NULL.

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

Этот параметр не разрешен при использовании --progress.

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

Предотвращает создание временного слота репликации для резервной копии.

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

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

Отключает проверку контрольных сумм, если они включены на сервере, с которого выполняется базовое резервное копирование.

По умолчанию, контрольные суммы проверяются и сбои в контрольных суммах приводят к ненулевому коду завершения. Однако, в таком случае резервная копия базы данных не будет удалена, как если бы был использован параметр --no-clean. Сбои при проверке контрольных сумм также будут отображаться в представлении pg_stat_database.

Указывает параметры, используемые для подключения к серверу, в виде строки подключения; эти параметры переопределяют любые конфликтующие параметры командной строки.

Опция называется --dbname для согласованности с другими клиентскими приложениями, но поскольку pg_basebackup не подключается к какой-либо конкретной базе данных в кластере, любое имя базы данных в строке подключения будет проигнорировано.

Указывает имя хоста машины, на которой работает сервер. Если значение начинается с косой черты, оно используется в качестве каталога для Unix-сокета. По умолчанию берется значение из переменной среды PGHOST, если она установлена, в противном случае выполняется попытка подключения через Unix-сокет.

Определяет TCP-порт или расширение локального файла сокета Unix, на котором сервер прослушивает соединения. По умолчанию используется переменная окружения PGPORT, если она установлена, или скомпилированное значение по умолчанию.

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

Указывает имя пользователя для подключения.

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

Заставляет pg_basebackup запрашивать пароль перед подключением к исходному серверу.

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

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

Показывает справку о командной строке аргументов для pg_basebackup и выходит.