community.postgresql.postgresql_schema – Добавить или удалить схему PostgreSQL

Примечание

Этот плагин входит в коллекцию community.postgresql (версия 1.1.1).

Для его установки используйте: ansible-galaxy collection install community.postgresql.

Для использования в плейбуке укажите: community.postgresql.postgresql_schema.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Добавление или удаление схемы PostgreSQL.

Требования

Ниже перечислены требования, необходимые на хосте, который выполняет данный модуль.

psycopg2

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ca_cert строка		Указывает имя файла, содержащего сертификаты центра сертификации (CA). Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров. Псевдонимы: ssl_rootcert
cascade_drop логический	Варианты: нет ← да	Удаление схемы с CASCADE для удаления дочерних объектов.
database строка	Значение по умолчанию: "postgres"	Имя базы данных для подключения и добавления или удаления схемы. Псевдонимы: db, login_db
login_host строка		Хост, на котором работает база данных.
login_password строка		Пароль для аутентификации.
login_unix_socket строка		Путь к сокету Unix-домена для локальных подключений.
login_user строка	Значение по умолчанию: "postgres"	Имя пользователя для аутентификации.
name строка / обязательно		Имя схемы для добавления или удаления. Псевдонимы: schema
owner строка		Имя роли, которая будет установлена владельцем схемы.
port целое число	Значение по умолчанию: 5432	Порт базы данных для подключения. Псевдонимы: login_port
session_role строка		Переключение на session_role после подключения. Указанная session_role должна быть ролью, членом которой является текущий login_user. Проверка разрешений для команд SQL выполняется так, как если бы session_role была той, которая первоначально вошла в систему.
ssl_mode строка	Варианты: разрешить отключить предпочитать ← требовать проверять-ca полная-проверка	Определяет, будет ли и с какой приоритетностью устанавливаться безопасное SSL TCP/IP-соединение с сервером. См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах. Значение по умолчанию `prefer` соответствует значению по умолчанию libpq.
state строка	Варианты: absent present ←	Состояние схемы.
trust_input логический добавлен в 0.2.0 community.postgresql	Варианты: нет да ←	Если `no`, проверяется, являются ли значения параметров schema, owner, session_role потенциально опасными. Использование `no` имеет смысл только в том случае, если SQL-инъекции через параметры возможны.

Примечания

Примечание

Поддерживает check_mode.
Аутентификация по умолчанию предполагает, что вы либо входите как, либо используете sudo для учетной записи postgres на хосте.
Чтобы избежать ошибки «Ошибка проверки подлинности клиента для пользователя postgres», используйте пользователя postgres в качестве become_user.
Этот модуль использует psycopg2, адаптер базы данных Python PostgreSQL. Необходимо убедиться, что psycopg2 установлен на хосте перед использованием этого модуля.
Если удаленный хост — это сервер PostgreSQL (что является стандартным случаем), то PostgreSQL также должен быть установлен на удаленном хосте.
Для систем на основе Ubuntu установите пакеты postgresql, libpq-dev и python-psycopg2 на удалённом хосте перед использованием этого модуля.
Параметр ca_cert требует как минимум версии Postgres 8.4 и psycopg2 версии 2.4.3.

См. также

Схемы PostgreSQL: Общая информация о схемах PostgreSQL.
Ссылка на CREATE SCHEMA: Полное описание документации по команде CREATE SCHEMA.
Ссылка на ALTER SCHEMA: Полное описание документации по команде ALTER SCHEMA.
Ссылка на DROP SCHEMA: Полное описание документации по команде DROP SCHEMA.

Примеры

- name: Create a new schema with name acme in test database
  community.postgresql.postgresql_schema:
    db: test
    name: acme

- name: Create a new schema acme with a user bob who will own it
  community.postgresql.postgresql_schema:
    name: acme
    owner: bob

- name: Drop schema "acme" with cascade
  community.postgresql.postgresql_schema:
    name: acme
    state: absent
    cascade_drop: yes

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:

Ключ	Возвращаемое значение	Описание
queries список / элементы=строка	всегда	Список выполненных запросов. Пример: ['CREATE SCHEMA "acme"']
schema строка	успех, изменено	Имя схемы. Пример: acme

Авторы

Flavien Chantelot (@Dorn-) <contact@flavien.io>
Thomas O’Donnell (@andytom)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/postgresql/postgresql_schema_module.html