community.postgresql.postgresql_tablespace модуль — Добавление или удаление PostgreSQL табличных пространств на удалённых хостах

Примечание

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

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

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

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

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

Обзор

Добавляет или удаляет PostgreSQL табличные пространства на удалённых хостах.

Требования

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

psycopg2 >= 2.5.1

Параметры

Параметр	Комментарии
ca_cert псевдонимы: ssl_rootcert строка	Указывает имя файла, содержащего сертификат(ы) сертификационного центра (CA) SSL. Если файл существует, сертификат сервера будет проверен на подпись одним из этих центров.
comment строка добавлен в community.postgresql 3.3.0	Устанавливает комментарий к табличному пространству. Чтобы сбросить комментарий, передайте пустую строку.
connect_params словарь добавлен в community.postgresql 2.3.0	Дополнительные параметры для передачи в libpg. Эти параметры имеют приоритет. По умолчанию: `{}`
db псевдонимы: login_db строка	Имя базы данных для подключения и выполнения запросов.
location псевдонимы: path путь	Путь к каталогу табличного пространства в файловой системе. Убедитесь, что местоположение существует и имеет соответствующие права.
login_host псевдонимы: host строка	Хост, на котором работает база данных. Если у вас возникают проблемы с подключением при использовании `localhost`, попробуйте использовать `127.0.0.1` вместо этого. По умолчанию: `""`
login_password строка	Пароль, который этот модуль должен использовать для создания сессии PostgreSQL. По умолчанию: `""`
login_unix_socket псевдонимы: unix_socket строка	Путь к сокету Unix доменной области для локальных подключений. По умолчанию: `""`
login_user псевдонимы: login строка	Имя пользователя, которое этот модуль должен использовать для создания сессии PostgreSQL. По умолчанию: `"postgres"`
owner строка	Имя роли, которая будет установлена как владелец табличного пространства. Если этот параметр не указан, владельцем табличного пространства является роль, которая создаёт табличное пространство.
port псевдонимы: login_port целое число	Порт базы данных для подключения. По умолчанию: `5432`
rename_to строка	Новое имя табличного пространства. Новое имя не может начинаться с pg_, так как такие имена зарезервированы для системных табличных пространств.
session_role строка	Переключение на session_role после подключения. Указанная session_role должна быть ролью, членом которой является текущий login_user. Проверка разрешений для SQL-команд выполняется так, как будто session_role была той, которая первоначально вошла в систему.
set словарь	Словарь параметров табличного пространства для установки. Поддерживается с PostgreSQL 9.0. Для получения дополнительной информации см. https://www.postgresql.org/docs/current/sql-createtablespace.html. При передаче reset в качестве значения параметра, если параметр был установлен ранее, он будет удалён.
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 string	Состояние табличного пространства. state=present подразумевает, что табличное пространство должно быть создано, если оно не существует. state=absent подразумевает, что табличное пространство должно быть удалено, если оно существует. state=absent несовместимо с location, owner, i(set). См. раздел «Примечания» для получения информации о ограничениях режима проверки. Выборы: `"absent"` `"present"` ← (по умолчанию)
tablespace псевдонимы: name строка / обязательно	Имя табличного пространства для добавления или удаления.
trust_input булево добавлен в community.postgresql 0.2.0	Если `false`, проверьте, являются ли значения параметров tablespace, location, owner, rename_to, session_role, settings_list потенциально опасными. Использование `false` имеет смысл только в том случае, если SQL-инъекции через параметры возможны. Выборы: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: частичная state=absent и state=present (второе, если табличное пространство не существует) не поддерживают режим проверки, потому что соответствующие команды PostgreSQL DROP и CREATE TABLESPACE не могут быть выполнены внутри блока транзакции.	Может работать в режиме check_mode и возвращать прогноз изменённого статуса без изменения целевого объекта.

Примечания

Примечание

По умолчанию аутентификация предполагает, что вы входите как или используете sudo от postgres пользователя на хосте.
Чтобы избежать ошибки «Peer authentication failed for user 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 TABLESPACE: Полное описание документации команды CREATE TABLESPACE.
Ссылка ALTER TABLESPACE: Полное описание документации команды ALTER TABLESPACE.
Ссылка DROP TABLESPACE: Полное описание документации команды DROP TABLESPACE.

Примеры

- name: Create a new tablespace called acme and set bob as an its owner
  community.postgresql.postgresql_tablespace:
    name: acme
    owner: bob
    location: /data/foo
    comment: "Bob's tablespace"

- name: Create a new tablespace called bar with tablespace options
  community.postgresql.postgresql_tablespace:
    name: bar
    set:
      random_page_cost: 1
      seq_page_cost: 1

- name: Reset random_page_cost option
  community.postgresql.postgresql_tablespace:
    name: bar
    set:
      random_page_cost: reset

- name: Rename the tablespace from bar to pcie_ssd
  community.postgresql.postgresql_tablespace:
    name: bar
    rename_to: pcie_ssd

- name: Drop tablespace called bloat
  community.postgresql.postgresql_tablespace:
    name: bloat
    state: absent

Значения возврата

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

Ключ	Описание
comment строка	Комментарий к табличному пространству. Возвращается: успех Пример: `"Test tablespace"`
location строка	Путь к табличному пространству в файловой системе. Возвращается: успех Пример: `"/incredible/fast/ssd"`
newname строка	Новое имя табличного пространства. Возвращается: если существует Пример: `"new_ssd"`
options словарь	Параметры табличного пространства. Возвращается: успех Пример: `{"random_page_cost": 1, "seq_page_cost": 1}`
owner строка	Владелец табличного пространства. Возвращается: успех Пример: `"Bob"`
queries строка	Список запросов, которые были попытки выполнить. Возвращается: успех Пример: `"[\"CREATE TABLESPACE bar LOCATION '/incredible/ssd'\"]"`
state строка	Состояние табличного пространства в конце выполнения. Возвращается: успех Пример: `"present"`
tablespace строка	Имя табличного пространства. Возвращается: успех Пример: `"ssd"`

Авторы

Flavien Chantelot (@Dorn-)
Antoine Levy-Lambert (@antoinell)
Andrew Klychkov (@Andersson007)
Daniele Giudice (@RealGreenDragon)

Ссылки на сборку

© 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_tablespace_module.html