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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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). Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров.
cascade_drop булево	Удалить схему с CASCADE, чтобы удалить дочерние объекты. Варианты: `false` ← (по умолчанию) `true`
comment строка добавлен в community.postgresql 3.3.0	Устанавливает комментарий к схеме. Для сброса комментария передайте пустую строку.
connect_params словарь добавлен в community.postgresql 2.3.0	Любые дополнительные параметры, которые должны быть переданы в libpg. Эти параметры имеют приоритет. По умолчанию: `{}`
database псевдонимы: db, login_db строка	Имя базы данных для подключения и добавления или удаления схемы. По умолчанию: `"postgres"`
login_host псевдонимы: host строка	Хост, на котором работает база данных. Если у вас проблемы с подключением при использовании `localhost`, попробуйте использовать `127.0.0.1` вместо этого. По умолчанию: `""`
login_password строка	Пароль, который этот модуль должен использовать для установления сеанса PostgreSQL. По умолчанию: `""`
login_unix_socket псевдонимы: unix_socket строка	Путь к сокету Unix-домена для локальных подключений. По умолчанию: `""`
login_user псевдонимы: login строка	Имя пользователя, которое этот модуль должен использовать для установления сеанса PostgreSQL. По умолчанию: `"postgres"`
name псевдонимы: schema строка / обязательно	Имя схемы для добавления или удаления.
owner строка	Имя роли, которая должна быть установлена в качестве владельца схемы. По умолчанию: `""`
port псевдонимы: login_port целое число	Порт базы данных для подключения. По умолчанию: `5432`
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"` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

trust_input

boolean

added in community.postgresql 0.2.0

Если false, проверяет, являются ли значения параметров schema, owner, session_role потенциально опасными.

Использование false имеет смысл только тогда, когда возможны SQL-инъекции через параметры.

Выбо� ры:

false
true ← (по умолчанию)

Атрибуты

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

Примечания

Примечание

По умолчанию используется аутентификация, предполагающая, что вы входите как или используете sudo для учетной записи postgres на хосте.
Чтобы избежать ошибки «Ошибка проверки подлинности Peer для пользователя postgres», используйте пользователя postgres в качестве become_user.
Этот модуль использует psycopg, адаптер Python PostgreSQL базы данных. Вы должны убедиться, что 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:
    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 список / элементы=строка	Список выполненных запросов. Возвращается: success Пример: `["CREATE SCHEMA \"acme\""]`
schema строка	Имя схемы. Возвращается: success Пример: `"acme"`

Авторы

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

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

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