Connecter Superset à ClickHouse

Apache Superset est une plateforme open source d’exploration et de visualisation de données.

Apache Superset est une plateforme open-source d’exploration de données et de visualisation écrite en Python. Superset se connecte à ClickHouse à l’aide d’un pilote Python fourni par ClickHouse. Voyons comment cela fonctionne…

​

Objectif

Dans ce guide, vous allez créer un tableau de bord dans Superset à partir de données issues d’une base de données ClickHouse. Le tableau de bord ressemblera à ceci :

Ajoutez des données

Si vous n’avez pas de jeu de données à utiliser, vous pouvez en ajouter un parmi les exemples. Ce guide utilise le jeu de données UK Price Paid, vous pouvez donc choisir celui-ci. Plusieurs autres sont disponibles dans la même catégorie de documentation.

​

1. Rassemblez les informations de connexion

Pour vous connecter à ClickHouse via HTTP(S), vous avez besoin des informations suivantes :

Paramètre(s)	Description
HOST and PORT	En général, le port est 8443 lors de l’utilisation de TLS, ou 8123 sans TLS.
DATABASE NAME	Par défaut, une base de données nommée default est disponible ; utilisez le nom de la base de données à laquelle vous voulez vous connecter.
USERNAME and PASSWORD	Par défaut, le nom d’utilisateur est default. Utilisez le nom d’utilisateur adapté à votre cas d’usage.

Les informations de votre service ClickHouse Cloud sont disponibles dans la console ClickHouse Cloud. Sélectionnez un service, puis cliquez sur Connect :

Choisissez HTTPS. Les détails de connexion s’affichent dans un exemple de commande curl.

Si vous utilisez ClickHouse autogéré, les détails de connexion sont définis par votre administrateur ClickHouse.

​

2. Installer le pilote

1. Superset utilise le pilote clickhouse-connect pour se connecter à ClickHouse. Plus d’informations sur clickhouse-connect sont disponibles à l’adresse https://pypi.org/project/clickhouse-connect/. Vous pouvez l’installer avec la commande suivante :

   pip install clickhouse-connect
   

Configuration avec Docker Compose

Pour les installations basées sur Docker, consultez le guide de configuration de la base de données de Superset pour savoir comment ajouter clickhouse-connect à votre conteneur.

2. Démarrez (ou redémarrez) Superset.

​

3. Connecter Superset à ClickHouse

1. Dans Superset, sélectionnez Data dans le menu supérieur, puis Databases dans le menu déroulant. Ajoutez une nouvelle base de données en cliquant sur le bouton + Database :

2. À la première étape, sélectionnez ClickHouse Connect comme type de base de données :

3. À la deuxième étape :

• Activez ou désactivez SSL.
• Saisissez les informations de connexion que vous avez relevées précédemment.
• Indiquez le DISPLAY NAME : vous pouvez choisir le nom que vous voulez. Si vous vous connectez à plusieurs bases de données ClickHouse, choisissez un nom plus explicite.

4. Cliquez sur CONNECT, puis sur FINISH pour terminer l’assistant de configuration. Votre base de données devrait alors apparaître dans la liste des bases de données.

​

4. Ajouter un jeu de données

1. Pour interagir avec vos données ClickHouse dans Superset, vous devez définir un jeu de données. Dans le menu supérieur de Superset, sélectionnez Data, puis Datasets dans le menu déroulant.

2. Cliquez sur le bouton d’ajout d’un jeu de données. Sélectionnez votre nouvelle base de données comme source de données, et vous devriez voir les tables définies dans votre base de données :

3. Cliquez sur le bouton ADD en bas de la boîte de dialogue, et votre table apparaîtra dans la liste des jeux de données. Vous êtes alors prêt à créer un tableau de bord et à analyser vos données ClickHouse !

​

5. Création de graphiques et d’un tableau de bord dans Superset

Si vous connaissez déjà Superset, vous vous sentirez tout de suite à l’aise dans cette section. Si vous découvrez Superset, eh bien… c’est comme beaucoup d’autres excellents outils de visualisation : la prise en main est rapide, mais on en apprend les détails et les subtilités au fil de l’usage.

1. Vous commencez par un tableau de bord. Dans le menu supérieur de Superset, sélectionnez Dashboards. Cliquez sur le bouton en haut à droite pour ajouter un nouveau tableau de bord. Le tableau de bord suivant s’appelle UK property prices :

2. Pour créer un nouveau graphique, sélectionnez Charts dans le menu supérieur, puis cliquez sur le bouton pour ajouter un nouveau graphique. De nombreuses options s’affichent. L’exemple suivant montre un graphique Pie Chart utilisant le jeu de données uk_price_paid dans la liste déroulante CHOOSE A DATASET :

3. Les graphiques en secteurs de Superset nécessitent une Dimension et une Metric ; tous les autres paramètres sont facultatifs. Vous pouvez choisir les champs de votre choix pour la dimension et la métrique ; dans cet exemple, le champ ClickHouse district est utilisé comme dimension et AVG(price) comme métrique.

5. Si vous préférez les graphiques en anneau aux graphiques en secteurs, vous pouvez définir cette option et d’autres sous CUSTOMIZE :

6. Cliquez sur le bouton SAVE pour enregistrer le graphique, puis sélectionnez UK property prices dans la liste déroulante ADD TO DASHBOARD ; SAVE & GO TO DASHBOARD enregistre alors le graphique et l’ajoute au tableau de bord :

7. C’est tout. Créer des tableaux de bord dans Superset à partir des données de ClickHouse ouvre tout un monde d’analyses de données ultra-rapides !