Модуль community.clickhouse.clickhouse_role – создаёт или удаляет роль ClickHouse.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.clickhouse.clickhouse_role.

Добавлено в community.clickhouse 0.5.0

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

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

Создаёт или удаляет роль ClickHouse.

Требования

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

clickhouse-driver

Параметры

Параметр	Комментарии
client_kwargs словарь	Дополнительные аргументы-ключевые слова, которые нужно передать интерфейсу Client при создании его объекта. По умолчанию: `{}`
cluster строка	Выполнить команду на всех узлах кластера. Если кластер не настроен, выполнение команды завершится ошибкой.
login_db строка	Аналог аргумента `Client(database='...')`. Если аргумент не указан, используется его значение по умолчанию в драйвере.
login_host строка	Аналог аргумента `Client(host='...')`. По умолчанию: `"localhost"`
login_password строка	Аналог аргумента `Client(password='...')`. Если аргумент не указан, используется его значение по умолчанию в драйвере.
login_port целое число	Аналог аргумента `Client(port='...')`. Если аргумент не указан, используется его значение по умолчанию в драйвере.
login_user строка	Аналог аргумента `Client(user='...')`. Если аргумент не указан, используется его значение по умолчанию в драйвере. Убедитесь, что у пользователя есть разрешения на чтение системных таблиц, перечисленных в разделе RETURN.
name строка / обязательный	Имя роли, которую нужно добавить или удалить.
settings список / элементы=строка	Настройки с ограничениями, применяемые к роли. Также можно указать профиль, из которого будут наследоваться настройки.
state строка	Состояние роли. `present` создаёт роль, если она не существует. `absent` удаляет роль, если она существует. Варианты: `"present"` ← (по умолчанию) `"absent"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Поддерживает check_mode.

Примечания

Примечание

Дополнительные сведения об интерфейсе драйвера см. в документации clickhouse-driver.

Примеры

- name: Create role
  community.clickhouse.clickhouse_role:
    name: test_role
    state: present

- name: Create a role with settings
  community.clickhouse.clickhouse_role:
    name: test_role
    state: present
    settings:
      - max_memory_usage = 15000 MIN 15000 MAX 16000 READONLY
      - PROFILE restricted
    cluster: test_cluster

- name: Remove role
  community.clickhouse.clickhouse_role:
    name: test_role
    state: absent

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

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

Ключ	Описание
executed_statements список / элементы=строка	Выполненные инструкции, изменяющие данные. Возвращается: при успешном выполнении Пример: `["CREATE ROLE test_role"]`

Авторы

Don Naro (@oranod)
Aleksandr Vagachev (@aleksvagachev)
Andrew Klychkov (@Andersson007)

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

© 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/clickhouse/clickhouse_role_module.html