ADQM Notebook

Elena Dvoryadkina

ADQM Notebook is a tool for working with ADQM databases that extends the capabilities of the built-in ClickHouse web interface. It is only available in the Enterprise edition of ADQM (starting with the ADQM version 25.8.16.34.1.b1).

To open the ADQM Notebook interface, enter http://<adqm_host_IP>:8123/notebook in your browser, where <adqm_host_IP> is an IP address of an ADQM host. In the user and password input fields located at the top right of the interface, enter a username and password for connecting to the ClickHouse server (a user should be defined in the users section of the server’s users.xml configuration file). By default, the default username and empty password are used.

When you first launch ADQM Notebook, it highlights the main interface elements, providing brief instructions on how to use them.

ADQM Notebook interface
ADQM Notebook interface
ADQM Notebook interface
ADQM Notebook interface
NOTE

ADQM Notebook can also work via Chproxy — in this case, queries will be automatically evenly distributed across all servers, balancing the cluster load. Use the address http://<chproxy_host_IP>:9090/notebook to open the ADQM Notebook interface on a host with the Chproxy service installed.

 
The schema below shows the ADQM Notebook architecture.

ADQM Notebook architecture
ADQM Notebook architecture
ADQM Notebook architecture
ADQM Notebook architecture

Main objects that can be operated in the ADQM Notebook interface are notebooks and cells.

A notebook is a set of cells that can be of two types:

  • SQL cells for executing SQL queries with a wide range of features to edit SQL code, view query results as interactive data grids or graphs, and save results in various formats.

  • Text cells for notes and comments with markdown markup support for text formatting.

The ADQM Notebook interface provides the ability to create multiple notebooks and an option to automatically save them. Notebook snapshots can be exported to JSON files or saved in a separate database on the ClickHouse server, and then imported for sharing or backup.

 
On the left side of the interface, there are panels:

  • NOTEBOOKS — to manage notebooks;

  • DATABASES — to view information about databases and tables on a single host or in an ADQM cluster in an interactive format;

  • VARIABLES — to create variables that can be used in queries inside SQL cells.

 
In the upper right corner of the interface, there are icons that provide access to the following functionality:

  • keyboard shortcuts icon dark keyboard shortcuts icon light Keyboard shortcuts — to view keyboard shortcuts that allow performing various cell management commands in the interface;

  • share notebook icon dark share notebook icon light Share notebook — to get a link to a notebook that you can share with other users;

  • settings icon dark settings icon light Settings — to access interface settings;

  • theme icon dark theme icon light / theme sun icon dark theme sun icon light Toggle theme — to switch between the dark and light interface themes.

Found a mistake? Seleсt text and press Ctrl+Enter to report it