Модуль community.clickhouse.clickhouse_info — сбор информации о сервере ClickHouse с помощью интерфейса Client clickhouse-driver

Примечание

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

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

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

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

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

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

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

Сбор информации о сервере ClickHouse с помощью интерфейса Client clickhouse-driver.
Не изменяет состояние сервера.

Требования

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

clickhouse-driver

Параметры

Параметр	Комментарии
client_kwargs словарь	Любые дополнительные именованные аргументы, которые требуется передать интерфейсу Client при создании его объекта. По умолчанию: `{}`
limit список / элементы=строка добавлено в community.clickhouse 0.2.0	Ограничивает набор возвращаемых значений, которые требуется получить. Допустимые значения см. в разделе «Возвращаемые значения». Если параметр не указан, возвращаются все поддерживаемые значения.
login_db строка	Соответствует аргументу `Client(database='...')`. Если параметр не передан, используется значение аргумента по умолчанию драйвера.
login_host строка	Соответствует аргументу `Client(host='...')`. По умолчанию: `"localhost"`
login_password строка	Соответствует аргументу `Client(password='...')`. Если параметр не передан, используется значение аргумента по умолчанию драйвера.
login_port целое число	Соответствует аргументу `Client(port='...')`. Если параметр не передан, используется значение аргумента по умолчанию драйвера.
login_user строка	Соответствует аргументу `Client(user='...')`. Если параметр не передан, используется значение аргумента по умолчанию драйвера. Убедитесь, что у пользователя есть разрешения на чтение системных таблиц, перечисленных в разделе «ВОЗВРАЩАЕМЫЕ ЗНАЧЕНИЯ».

Атрибуты

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

Примечания

Примечание

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

Примеры

- name: Get server information
  register: result
  community.clickhouse.clickhouse_info:
    login_host: localhost
    login_user: alice
    login_db: foo
    login_password: my_password

- name: Print returned data
  ansible.builtin.debug:
    var: result

- name: Limit return values with users and roles
  register: result
  community.clickhouse.clickhouse_info:
    limit:
      - users
      - roles

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

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

Ключ	Описание
clusters словарь	Содержимое таблицы system.clusters, где ключами являются имена. Возвращается: при успехе Пример: `{"test_cluster_two_shards": "..."}`
databases словарь	Содержимое таблицы system.databases, где ключами являются имена. Убедитесь, что у пользователя login_user есть необходимые разрешения. Возвращается: при успехе Пример: `{"system": "..."}`
dictionaries словарь добавлено в community.clickhouse 0.3.0	Содержимое таблицы system.dictionaries, где ключами являются имена словарей. Возвращается: при успехе Пример: `{"database": {"dictionary": "..."}}`
driver словарь	Информация о драйвере Python. Возвращается: при успехе Пример: `{"version": "0.2.6"}`
grants словарь добавлено в community.clickhouse 0.7.0	Содержимое таблицы system.grants; ключами являются пользователи и роли. Возвращается: при успехе Пример: `{"roles": {"...": null}, "users": {"...": null}}`
merge_tree_settings словарь добавлено в community.clickhouse 0.3.0	Содержимое таблицы system.merge_tree_settings, где ключами являются имена. Возвращается: при успехе Пример: `{"merge_max_block_size": "..."}`
quotas словарь добавлено в community.clickhouse 0.4.0	Содержимое таблицы system.quotas, где ключами являются имена квот. Возвращается: при успехе Пример: `{"default": "..."}`
roles словарь	Содержимое таблицы system.roles, где ключами являются имена. Убедитесь, что у пользователя login_user есть необходимые разрешения. Возвращается: при успехе Пример: `{"accountant": "..."}`
settings словарь	Содержимое таблицы system.settings, где ключами являются имена. Возвращается: при успехе Пример: `{"zstd_window_log_max": "..."}`
settings_profile_elements словарь добавлено в community.clickhouse 0.7.0	Содержимое таблицы system.settings_profile_elements; ключами являются пользователи, роли и профили. Возвращается: при успехе Пример: `{"profiles": {"...": null}, "roles": {"...": null}, "users": {"...": null}}`
settings_profiles словарь добавлено в community.clickhouse 0.4.0	Содержимое таблицы system.settings_profiles, где ключами являются имена профилей. Возвращается: при успехе Пример: `{"readonly": "..."}`
storage_policies словарь добавлено в community.clickhouse 0.4.0	Содержимое таблицы system.storage_policies, где ключами являются имена политик хранения. Возвращается: при успехе Пример: `{"storage_policies": "..."}`
tables словарь добавлено в community.clickhouse 0.3.0	Содержимое таблицы system.tables, где ключами являются имена таблиц. Возвращается: при успехе Пример: `{"system": {"settings": "..."}}`
users словарь	Содержимое таблицы system.users, где ключами являются имена. Убедитесь, что у пользователя login_user есть необходимые разрешения. Возвращается: при успехе Пример: `{"default": "..."}`
version словарь	Версия сервера ClickHouse. Возвращается: при успехе Пример: `{"build": 59, "feature": 12, "maintenance": 2, "raw": "23.12.2.59", "type": null, "year": 23}`

Авторы

Andrew Klychkov (@Andersson007)
Aleksandr Vagachev (@aleksvagachev)

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

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