Conectar Superset con ClickHouse

Apache Superset es una plataforma de código abierto para la exploración y visualización de datos.

Apache Superset es una plataforma de código abierto para la exploración y visualización de datos escrita en Python. Superset se conecta a ClickHouse con un controlador de Python proporcionado por ClickHouse. Veamos cómo funciona…

​

Objetivo

En esta guía crearás un dashboard en Superset con datos de una base de datos de ClickHouse. El dashboard tendrá este aspecto:

Agrega algunos datos

Si no tienes un conjunto de datos con el que trabajar, puedes añadir uno de los conjuntos de datos de ejemplo. Esta guía utiliza el conjunto de datos UK Price Paid, así que puedes elegir ese. Hay varios más en la misma categoría de la documentación.

​

1. Recopila los datos de conexión

Para conectarse a ClickHouse con HTTP(S), necesita esta información:

Parámetro(s)	Descripción
HOST and PORT	Normalmente, el puerto es 8443 cuando se usa TLS o 8123 cuando no se usa TLS.
DATABASE NAME	De forma predeterminada, existe una base de datos llamada default; use el nombre de la base de datos a la que desea conectarse.
USERNAME and PASSWORD	De forma predeterminada, el nombre de usuario es default. Use el nombre de usuario adecuado para su caso de uso.

Los detalles de su servicio de ClickHouse Cloud están disponibles en la consola de ClickHouse Cloud. Seleccione un servicio y haga clic en Connect:

Elija HTTPS. Los detalles de conexión se muestran en un comando curl de ejemplo.

Si usa ClickHouse autogestionado, los detalles de conexión los establece su administrador de ClickHouse.

​

2. Instale el controlador

1. Superset usa el controlador clickhouse-connect para conectarse a ClickHouse. Encontrará más información sobre clickhouse-connect en https://pypi.org/project/clickhouse-connect/, y puede instalarse con el siguiente comando:

   pip install clickhouse-connect
   

Configuración de Docker Compose

Para instalaciones basadas en Docker, consulte la guía de configuración de bases de datos de Superset para obtener instrucciones sobre cómo añadir clickhouse-connect a su contenedor.

2. Inicie (o reinicie) Superset.

​

3. Conectar Superset a ClickHouse

1. En Superset, selecciona Data en el menú superior y luego Databases en el menú desplegable. Agrega una nueva base de datos haciendo clic en el botón + Database:

2. En el primer paso, selecciona ClickHouse Connect como tipo de base de datos:

3. En el segundo paso:

• Activa o desactiva SSL.
• Introduce la información de conexión que recopilaste antes.
• Especifica el DISPLAY NAME: puede ser cualquier nombre que prefieras. Si te vas a conectar a varias bases de datos de ClickHouse, haz que el nombre sea más descriptivo.

4. Haz clic en los botones CONNECT y luego FINISH para completar el asistente de configuración, y deberías ver tu base de datos en la lista de bases de datos.

​

4. Añadir un conjunto de datos

1. Para interactuar con sus datos de ClickHouse en Superset, debe definir un conjunto de datos. En el menú superior de Superset, seleccione Data y, a continuación, Datasets en el menú desplegable.

2. Haga clic en el botón para añadir un conjunto de datos. Seleccione su nueva base de datos como origen de datos y debería ver las tablas definidas en ella:

3. Haga clic en el botón ADD en la parte inferior del cuadro de diálogo y su tabla aparecerá en la lista de conjuntos de datos. Ya está listo para crear un dashboard y analizar sus datos de ClickHouse.

​

5. Creación de gráficos y un dashboard en Superset

Si ya conoces Superset, esta sección te resultará muy familiar. Si no, bueno… es como muchas otras herramientas de visualización: empezar es rápido, pero los detalles y matices se van aprendiendo con el tiempo a medida que usas la herramienta.

1. Se empieza con un dashboard. En el menú superior de Superset, selecciona Dashboards. Haz clic en el botón de la esquina superior derecha para añadir un nuevo dashboard. El siguiente dashboard se llama UK property prices:

2. Para crear un nuevo gráfico, selecciona Charts en el menú superior y haz clic en el botón para añadirlo. Verás muchas opciones. El siguiente Example muestra un gráfico Pie Chart usando el conjunto de datos uk_price_paid del desplegable CHOOSE A DATASET:

3. Los gráficos circulares de Superset necesitan una Dimension y una Metric; el resto de la configuración es opcional. Puedes elegir los campos que quieras para la dimensión y la métrica; en este Example se usa el campo district de ClickHouse como dimensión y AVG(price) como métrica.

5. Si prefieres los gráficos de dona a los gráficos circulares, puedes configurar esa y otras opciones en CUSTOMIZE:

6. Haz clic en el botón SAVE para guardar el gráfico; después, selecciona UK property prices en el desplegable ADD TO DASHBOARD. Luego, SAVE & GO TO DASHBOARD guarda el gráfico y lo añade al dashboard:

7. Eso es todo. Crear dashboards en Superset a partir de datos de ClickHouse abre todo un mundo de analítica de datos ultrarrápida.