postgresql_db - Добавление или удаление баз данных PostgreSQL на удалённом хосте.
Описание
- Добавление или удаление баз данных PostgreSQL на удалённом хосте.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- psycopg2
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| encoding | По умолчанию: None | Кодировка базы данных |
| lc_collate | По умолчанию: None | Порядок сортировки (LC_COLLATE) для использования в базе данных. Должен совпадать с порядком сортировки шаблонной базы данных, за исключением случаев использования template0. |
| lc_ctype | По умолчанию: None | Классификация символов (LC_CTYPE) для использования в базе данных (например, нижний регистр, верхний регистр, ...). Должен совпадать с LC_CTYPE шаблонной базы данных, за исключением случаев использования template0. |
| login_host | По умолчанию: None | Хост, на котором работает база данных |
| login_password | По умолчанию: None | Пароль для аутентификации |
| login_unix_socket | По умолчанию: None | Путь к Unix-сокету для локальных соединений |
| login_user | По умолчанию: postgres | Имя пользователя для аутентификации |
| maintenance_db (добавлен в 2.5) | По умолчанию: postgres | Значение определяет начальную базу данных (также называемую базой данных технического обслуживания), с которой Ansible подключается. |
| name обязательно | По умолчанию: None | Имя базы данных для добавления или удаления псевдонимы: db |
| owner | По умолчанию: None | Имя роли, которая будет установлена как владелец базы данных |
| port | По умолчанию: 5432 | Порт базы данных для подключения. |
| ssl_mode (добавлен в 2.3) |
| Определяет, будет ли и с каким приоритетом устанавливаться защищённое SSL-соединение с сервером TCP/IP. См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах. Значение по умолчанию prefer соответствует значению по умолчанию libpq. |
| ssl_rootcert (добавлен в 2.3) | По умолчанию: None | Указывает имя файла, содержащего сертификаты SSL-центра сертификации. Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров. |
| state |
| Состояние базы данных. present означает, что база данных должна быть создана, если необходимо. absent означает, что база данных должна быть удалена, если она существует. dump требует определения целевого файла для резервного копирования базы данных. (Добавлен в 2.4) restore также требует определения целевого файла для восстановления базы данных. (Добавлен в 2.4) Формат резервной копии будет определён на основе имени целевого файла. Поддерживаемые форматы сжатия для dump и restore: .bz2, .gz и .xz Поддерживаемые форматы для dump и restore: .sql и .tar |
| target (добавлен в 2.4) | Файл для резервного копирования или восстановления из него. Используется при state "dump" или "restore" | |
| target_opts (добавлен в 2.4) | Дополнительные аргументы для pg_dump или pg_restore. Используется при state "dump" или "restore" | |
| template | По умолчанию: None | Шаблон, используемый для создания базы данных |
Примечания
Примечание
- Аутентификация по умолчанию предполагает, что вы вошли как или используете sudo для учётной записи
postgresна хосте. - Этот модуль использует psycopg2, адаптер Python для базы данных PostgreSQL. Необходимо убедиться, что psycopg2 установлен на хосте перед использованием этого модуля. Если удалённый хост является сервером PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удалённом хосте. Для систем на базе Ubuntu установите пакеты
postgresql,libpq-dev, иpython-psycopg2на удалённом хосте перед использованием этого модуля. - Параметр ssl_rootcert требует как минимум Postgres версии 8.4 и psycopg2 версии 2.4.3.
Примеры
# Create a new database with name "acme"
- postgresql_db:
name: acme
# Create a new database with name "acme" and specific encoding and locale
# settings. If a template different from "template0" is specified, encoding
# and locale settings must match those of the template.
- postgresql_db:
name: acme
encoding: UTF-8
lc_collate: de_DE.UTF-8
lc_ctype: de_DE.UTF-8
template: template0
# Dump an existing database to a file
- postgresql_db:
name: acme
state: dump
target: /tmp/acme.sql
# Dump an existing database to a file (with compression)
- postgresql_db:
name: acme
state: dump
target: /tmp/acme.sql.gz
# Dump a single schema for an existing database
- postgresql_db:
name: acme
state: dump
target: /tmp/acme.sql
target_opts: "-n public"
Статус
Этот модуль помечен как stableinterface, что означает, что разработчики гарантируют, что не будут вносить изменения в интерфейс, которые могут привести к несовместимости с предыдущими версиями.
Автор
- Команда Ansible Core
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/postgresql_db_module.html