> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> Документация по клиентской утилите ClickHouse Keeper
# Утилита clickhouse-keeper-client
Клиентское приложение для взаимодействия с ClickHouse Keeper по собственному протоколу.
## Ключи
* `-q QUERY`, `--query=QUERY` — Запрос для выполнения. Если этот параметр не указан, `clickhouse-keeper-client` запустится в интерактивном режиме.
* `-h HOST`, `--host=HOST` — Хост сервера. Значение по умолчанию: `localhost`.
* `-p N`, `--port=N` — Порт сервера. Значение по умолчанию: 9181
* `-c FILE_PATH`, `--config-file=FILE_PATH` — Задаёт путь к файлу конфигурации, из которого берётся строка подключения. Значение по умолчанию: `config.xml`.
* `--password=PASSWORD` — Пароль для аутентификации. Его также можно задать через переменную окружения `CLICKHOUSE_KEEPER_PASSWORD` или в XML-файле конфигурации по пути ``.
* `--identity=IDENTITY` — Идентификатор для схемы аутентификации `digest`. Его также можно задать через переменную окружения `CLICKHOUSE_KEEPER_IDENTITY` или в XML-файле конфигурации по пути ``.
* `--connection-timeout=TIMEOUT` — Задаёт тайм-аут подключения в секундах. Значение по умолчанию: 10s.
* `--session-timeout=TIMEOUT` — Задаёт тайм-аут сеанса в секундах. Значение по умолчанию: 10s.
* `--operation-timeout=TIMEOUT` — Задаёт тайм-аут операции в секундах. Значение по умолчанию: 10s.
* `--history-file=FILE_PATH` — Задаёт путь к файлу истории. Значение по умолчанию: `~/.keeper-client-history`.
* `--log-level=LEVEL` — Задаёт уровень логирования. Значение по умолчанию: `information`.
* `--no-confirmation` — Если указан, не требует подтверждения для ряда команд. Значение по умолчанию: `false` в интерактивном режиме и `true` в режиме запроса
* `--help` — Показывает справку.
## Переменные окружения
* `CLICKHOUSE_KEEPER_PASSWORD` — Используется в качестве пароля по умолчанию, если `--password` не указан в командной строке.
* `CLICKHOUSE_KEEPER_IDENTITY` — Используется в качестве идентификатора по умолчанию, если `--identity` не указан в командной строке.
## Аутентификация
При подключении к серверу Keeper, требующему аутентификации, пароль выбирается в следующем порядке приоритета (используется первое найденное значение):
1. аргумент командной строки `--password`
2. переменная окружения `CLICKHOUSE_KEEPER_PASSWORD`
3. `` в XML-файле конфигурации, указанном через `--config-file`
Тот же порядок приоритета действует для `--identity` / `CLICKHOUSE_KEEPER_IDENTITY` / ``.
Пример XML-файла конфигурации с настройками аутентификации:
```xml theme={null}
secret
localhost
9181
```
## Пример
```bash theme={null}
./clickhouse-keeper-client -h localhost -p 9181 --connection-timeout 30 --session-timeout 30 --operation-timeout 30
Connected to ZooKeeper at [::1]:9181 with session_id 137
/ :) ls
keeper foo bar
/ :) cd 'keeper'
/keeper :) ls
api_version
/keeper :) cd 'api_version'
/keeper/api_version :) ls
/keeper/api_version :) cd 'xyz'
Path /keeper/api_version/xyz does not exist
/keeper/api_version :) cd ../../
/ :) ls
keeper foo bar
/ :) get 'keeper/api_version'
2
```
## Команды
* `ls '[path]' [watch_id]` -- Выводит список узлов для указанного пути (по умолчанию: cwd). При необходимости устанавливает наблюдение за дочерними узлами с идентификатором `watch_id`
* `cd '[path]'` -- Изменяет рабочий путь (по умолчанию `.`)
* `cp '' ''` -- Копирует узел 'src' в путь 'dest'
* `cpr '' ''` -- Копирует поддерево узла 'src' в путь 'dest'
* `mv '' ''` -- Перемещает узел 'src' в путь 'dest'
* `mvr '' ''` -- Перемещает поддерево узла 'src' в путь 'dest'
* `exists '' [watch_id]` -- Возвращает `1`, если узел существует, иначе `0`. При необходимости устанавливает наблюдение с идентификатором `watch_id`
* `set '' [version]` -- Обновляет значение узла. Обновление выполняется только при совпадении версии (по умолчанию: -1)
* `create '' [mode]` -- Создает новый узел с указанным значением
* `touch ''` -- Создает новый узел с пустой строкой в качестве значения. Не генерирует исключение, если узел уже существует
* `get '' [watch_id]` -- Возвращает значение узла. При необходимости устанавливает наблюдение за данными с идентификатором `watch_id`
* `watch [timeout_seconds]` -- Ожидает событие наблюдения с идентификатором `watch_id` и выводит тип события и путь. Если указан `timeout_seconds`, возвращает ошибку по истечении заданного тайм-аута
* `rm '' [version]` -- Удаляет узел только при совпадении версии (по умолчанию: -1)
* `rmr '' [limit]` -- Рекурсивно удаляет путь, если размер поддерева меньше указанного ограничения. Требуется подтверждение (ограничение по умолчанию = 100)
* `flwc ` -- Выполняет команду из четырех букв
* `help` -- Выводит это сообщение
* `get_direct_children_number '[path]'` -- Возвращает количество непосредственных дочерних узлов для указанного пути
* `get_all_children_number '[path]'` -- Возвращает общее количество дочерних узлов для указанного пути
* `get_stat '[path]'` -- Возвращает статистику узла (по умолчанию `.`)
* `find_super_nodes '[path]'` -- Находит для указанного пути узлы, количество дочерних узлов у которых превышает заданный порог (по умолчанию `.`)
* `delete_stale_backups` -- Удаляет узлы ClickHouse, используемые для резервных копий и ставшие неактивными
* `find_big_family [path] [n]` -- Возвращает n узлов с наибольшим числом потомков в поддереве (по умолчанию path = `.` и n = 10)
* `sync ''` -- Синхронизирует узел между процессами и лидером
* `reconfig "" [version]` -- Перенастраивает кластер Keeper. См. /docs/en/guides/sre/keeper/clickhouse-keeper#reconfiguration