Модуль community.clickhouse.clickhouse_db – создание или удаление базы данных 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_db.

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

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

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

Создаёт или удаляет базу данных ClickHouse с помощью интерфейса Client clickhouse-driver.

Требования

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

clickhouse-driver

Параметры

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

Атрибуты

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

Примечания

Примечание

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

Примеры

- name: Create database
  community.clickhouse.clickhouse_db:
    login_host: localhost
    login_user: alice
    login_db: foo
    login_password: my_password
    name: test_db
    engine: Memory
    state: present
    comment: Test DB

- name: Drop database
  community.clickhouse.clickhouse_db:
    login_host: localhost
    login_user: alice
    login_db: foo
    login_password: my_password
    name: test_db
    state: absent

# Rename the database test_db to prod_db.
# If the database test_db exists, it will be renamed to prod_db.
# If the database test_db does not exist and the prod_db database exists,
# the module will report that nothing has changed.
# If both the databases exist, an error will be raised.
- name: Rename database
  community.clickhouse.clickhouse_db:
    login_host: localhost
    login_user: alice
    login_db: foo
    login_password: my_password
    name: test_db
    target: prod_db
    cluster: test_cluster
    state: rename

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

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

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

Авторы

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_db_module.html