Spec-Zone.ru › Ansible 2.8

postgresql_ext – Добавление или удаление расширений PostgreSQL из базы данных

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Добавление или удаление расширений PostgreSQL из базы данных.

Требования

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

  • psycopg2

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ca_cert
строка
добавлен в 2.8
Указывает имя файла, содержащего сертификат(ы) центра сертификации (CA).
Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров сертификации.

псевдонимы: ssl_rootcert
cascade
булево
добавлен в 2.8
    Варианты:
  • нет ←
  • да
Автоматически устанавливать/удалять расширения, от которых зависит это расширение, если они еще не установлены/удалены (поддерживается начиная с PostgreSQL 9.6).
db
строка / обязательно
Имя базы данных, к которой необходимо добавить или из которой удалить расширение.

псевдонимы: login_db
login_host
строка
Хост, на котором работает база данных.
login_password
строка
Пароль, используемый для аутентификации.
login_unix_socket
строка
добавлен в 2.8
Путь к сокету Unix-домена для локальных соединений.
login_user
строка
По умолчанию:
"postgres"
Имя пользователя, используемое для аутентификации.
name
строка / обязательно
Имя расширения, которое нужно добавить или удалить.

псевдонимы: ext
port
целое число
По умолчанию:
5432
Порт базы данных для подключения.

псевдонимы: login_port
schema
строка
добавлен в 2.8
Имя схемы, к которой нужно добавить расширение.
session_role
строка
добавлен в 2.8
Переключение на роль сеанса после подключения.
Указанная роль сеанса должна быть ролью, членом которой является текущий пользователь login_user.
Проверка разрешений для SQL-команд выполняется так, как будто роль сеанса была той, которая изначально вошла в систему.
ssl_mode
строка
добавлен в 2.8
    Варианты:
  • разрешить
  • отключить
  • предпочитать ←
  • требовать
  • проверить-ca
  • полная-проверка
Определяет, будет ли и с каким приоритетом устанавливаться безопасное SSL TCP/IP-соединение с сервером.
См. https://www.postgresql.org/docs/current/static/libpq-ssl.html для получения дополнительной информации о режимах.
Значение по умолчанию prefer соответствует значению по умолчанию libpq.
state
строка
    Варианты:
  • отсутствует
  • присутствует ←
Состояние расширения базы данных.

Примечания

Примечание

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

Примеры

- name: Adds postgis extension to the database acme in the schema foo
  postgresql_ext:
    name: postgis
    db: acme
    schema: foo

- name: Removes postgis extension to the database acme
  postgresql_ext:
    name: postgis
    db: acme
    state: absent

- name: Adds earthdistance extension to the database template1 cascade
  postgresql_ext:
    name: earthdistance
    db: template1
    cascade: true

# In the example below, if earthdistance extension is installed,
# it will be removed too because it depends on cube:
- name: Removes cube extension from the database acme cascade
  postgresql_ext:
    name: cube
    db: acme
    cascade: yes
    state: absent

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

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

Ключ Возвращаемое значение Описание
query
список
всегда
Список выполненных запросов.

Пример:
['DROP EXTENSION "acme"']


Статус

  • Гарантии обратной совместимости интерфейса этого модуля нет. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Daniel Schep (@dschep)
  • Thomas O’Donnell (@andytom)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/postgresql_ext_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API