ADQM Notebook

Елена Дворядкина

ADQM Notebook — инструмент для работы с базами данных ADQM, расширяющий возможности встроенного веб-интерфейса ClickHouse. Доступен только в Enterprise-версии ADQM (начиная с 25.8.16.34.1.b1).

Чтобы открыть интерфейс ADQM Notebook, введите в браузере адрес http://<adqm_host_IP>:8123/notebook, где <adqm_host_IP> — IP-адрес хоста ADQM. В полях ввода user и password, расположенных справа в верхней части интерфейса, укажите имя пользователя и пароль для подключения к серверу ClickHouse (пользователь должен быть определен в секции users конфигурационного файла сервера users.xml). По умолчанию используется имя пользователя default без пароля.

При первом запуске ADQM Notebook подсвечивает основные элементы интерфейса, предоставляя краткие инструкции по их использованию.

Интерфейс ADQM Notebook
Интерфейс ADQM Notebook
Интерфейс ADQM Notebook
Интерфейс ADQM Notebook
ПРИМЕЧАНИЕ

ADQM Notebook может также работать через Chproxy — в этом случае запросы будут автоматически равномерно распределяться между всеми серверами, балансируя нагрузку на кластер. Используйте адрес http://<chproxy_host_IP>:9090/notebook, чтобы открыть интерфейс ADQM Notebook на хосте с установленным сервсисом Chproxy.

 
На схеме ниже представлена архитектура ADQM Notebook.

Архитектура ADQM Notebook
Архитектура ADQM Notebook
Архитектура ADQM Notebook
Архитектура ADQM Notebook

Основные объекты, которыми можно оперировать в интерфейсе ADQM Notebook: ноутбуки (notebook) и ячейки (cell).

Ноутбук — набор ячеек, которые могут быть двух типов:

  • SQL-ячейки (SQL cell) — для выполнения SQL-запросов с большим набором функциональных возможностей, включающих редактирование кода запросов, просмотр результатов выполнения запросов в виде интерактивных таблиц или графиков, а также сохранение результатов в различных форматах.

  • Текстовые ячейки (Text cell) — для заметок и комментариев с поддержкой разметки markdown для форматирования текста.

Интерфейс ADQM Notebook предоставляет возможность создания нескольких ноутбуков и опцию для их автоматического сохранения. Снепшоты ноутбуков (notebook snapshot) можно сохранять в JSON-файлы или в отдельной базе данных на сервере ClickHouse и затем импортировать их для использования другими пользователями (sharing) или резервного копирования (backup).

 
В левой части интерфейса расположены панели:

  • NOTEBOOKS — для управления ноутбуками;

  • DATABASES — для просмотра информации о базах данных и таблицах на отдельном хосте или в кластере ADQM в интерактивном формате;

  • VARIABLES — для создания переменных, которые можно использовать в запросах внутри SQL-ячеек.

 
В правом верхнем углу интерфейса расположены иконки для доступа к следующей функциональности:

  • keyboard shortcuts icon dark keyboard shortcuts icon light Keyboard shortcuts — просмотр комбинаций клавиш для выполнения различных команд по управлению ячейками в интерфейсе;

  • share notebook icon dark share notebook icon light Share notebook — получение ссылки на ноутбук, которой можно поделиться с другими пользователями;

  • settings icon dark settings icon light Settings — доступ к настройкам интерфейса;

  • theme icon dark theme icon light / theme sun icon dark theme sun icon light Toggle theme — переключение между темной и светлой темой интерфейса.

Нашли ошибку? Выделите текст и нажмите Ctrl+Enter чтобы сообщить о ней