Модуль community.postgresql.postgresql_schema — добавление или удаление схемы PostgreSQL

Примечание

Этот модуль входит в коллекцию community.postgresql (версия 4.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.postgresql. Для работы с этим модулем нужны дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.postgresql.postgresql_schema.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

psycopg2 >= 2.5.1

Параметры

Параметр	Комментарии
ca_cert псевдонимы: ssl_rootcert строка	Указывает имя файла, содержащего сертификат (или сертификаты) центра сертификации (CA) SSL. Если файл существует, будет проверено, что сертификат сервера подписан одним из указанных центров сертификации.
cascade_drop логический	Удалять схему с параметром CASCADE, чтобы удалить дочерние объекты. Варианты: `false` ← (по умолчанию) `true`
comment строка добавлен в community.postgresql 3.3.0	Задает комментарий для схемы. Чтобы сбросить комментарий, передайте пустую строку.
connect_params словарь добавлен в community.postgresql 2.3.0	Любые дополнительные параметры, передаваемые в libpg. Эти параметры имеют приоритет. По умолчанию: `{}`
login_db псевдонимы: db, database строка	Имя базы данных, к которой нужно подключиться для добавления или удаления схемы. Псевдоним `db` устарел и будет удален в версии 5.0.0. По умолчанию: `"postgres"`
login_host псевдонимы: host строка	Узел, на котором запущена база данных. Если при использовании `localhost` возникают проблемы с подключением, попробуйте вместо него использовать `127.0.0.1`. По умолчанию: `""`
login_password строка	Пароль, который модуль должен использовать для установления сеанса PostgreSQL. По умолчанию: `""`
login_port псевдонимы: port целое число	Порт базы данных для подключения. Псевдоним `port` устарел и будет удален в следующем основном выпуске. Вместо него используйте `login_port`. По умолчанию: `5432`
login_unix_socket псевдонимы: unix_socket строка	Путь к доменному сокету Unix для локальных подключений. По умолчанию: `""`
login_user псевдонимы: login строка	Имя пользователя, которое модуль должен использовать для установления сеанса PostgreSQL. По умолчанию: `"postgres"`
name псевдонимы: schema строка / обязательный	Имя схемы для добавления или удаления.
owner строка	Имя роли, которую нужно назначить владельцем схемы. По умолчанию: `""`
session_role строка	После подключения переключиться на session_role. Указанная session_role должна быть ролью, членом которой является текущий login_user. Проверка разрешений для команд SQL выполняется так, как если бы изначально вошедшим пользователем была session_role.
ssl_cert путь добавлен в community.postgresql 2.4.0	Указывает имя файла клиентского SSL-сертификата.
ssl_key путь добавлен в community.postgresql 2.4.0	Указывает расположение секретного ключа, используемого для клиентского сертификата.
ssl_mode строка	Определяет, будет ли с сервером согласовано безопасное SSL TCP/IP-подключение и какой приоритет ему будет назначен. Дополнительные сведения о режимах см. на странице https://www.postgresql.org/docs/current/static/libpq-ssl.html. Значение по умолчанию `prefer` соответствует значению по умолчанию libpq. Варианты: `"allow"` `"disable"` `"prefer"` ← (по умолчанию) `"require"` `"verify-ca"` `"verify-full"`
state строка	Состояние схемы. Варианты: `"absent"` `"present"` ← (по умолчанию)
trust_input логический добавлен в community.postgresql 0.2.0	Если `false`, проверяет, могут ли значения параметров schema, owner, session_role представлять опасность. Использовать `false` имеет смысл только в том случае, если через параметры возможны SQL-инъекции. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

Примечания

Примечание

По умолчанию предполагается, что вы входите в систему под учетной записью postgres на узле или переключаетесь на нее с помощью sudo.
Чтобы избежать ошибки «Peer authentication failed for user postgres», используйте пользователя postgres в качестве become_user.
Этот модуль использует psycopg — адаптер PostgreSQL для Python. Перед использованием модуля убедитесь, что на узле установлен psycopg2 >= 2.5.1 или psycopg3 >= 3.1.8.
Если удаленный узел является сервером PostgreSQL (это происходит по умолчанию), PostgreSQL также должен быть установлен на удаленном узле.
В системах на основе Ubuntu перед использованием этого модуля установите на удаленный узел пакеты postgresql, libpq-dev и python3-psycopg2.

См. также

Схемы 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:
    login_db: test
    name: acme
    comment: 'My test schema'

- 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: true

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

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

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

Авторы

Flavien Chantelot (@Dorn-)
Thomas O’Donnell (@andytom)

Ссылки на коллекцию

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