How to connect your deployment to BI tools
This page explains how to integrate your Data Warehouse for ClickHouse® deployment with your preferred Business Intelligence (BI) tools.
Before you start
To complete the actions presented below, you must have:
- A Scaleway account logged into the console
- Owner status or IAM permissions allowing you to perform actions in the intended Organization
- Signed up to the private beta and received a confirmation email.
- Created a Data Warehouse deployment
Tableau
Tableau is a powerful data visualization and business intelligence tool that enables users to transform complex data into interactive and shareable dashboards and reports, providing actionable insights through intuitive drag-and-drop interfaces.
Download and install the ClickHouse® connector for Tableau
-
Download and install Tableau Desktop.
-
Follow the instructions for
clickhouse-tableau-connector-jdbc
to download the compatible version of the ClickHouse® JDBC driver. -
Store the JDBC driver in the
Drivers
folder. If the directory does not exist, create it:- macOS/Linux:
~/Library/Tableau/Drivers
- Windows:
C:\Program Files\Tableau\Drivers
- macOS/Linux:
Configure a ClickHouse® data source in Tableau
-
Start or restart Tableau.
-
From the Connect left-side menu, click on More under the To a Server section.
-
Select ClickHouse® by ClickHouse® from the connectors list.
-
Enter the following connection parameters:
-
Enter your connection details:
Setting Value Server Your ClickHouse® host (with no prefixes or suffix) Port 8443 Database default Username default Password Password set at deployment creation -
Click Sign In. A new Tableau workbook appears.
-
Select default from the Schema dropdown menu in the left side panel. A list of tables appears.
-
Your Data Warehouse for ClickHouse® is now integrated into your Tableau platform.
Refer to the official ClickHouse® and Tableau documentation portals for more information.
Metabase
Metabase is an open-source business intelligence tool that allows users to create and share customizable dashboards and reports from various data sources.
Integrating ClickHouse® into Metabase enhances query performance and scalability, for faster data analysis on large datasets, and provides robust support for complex queries and real-time analytics.
Download the ClickHouse® plugin for Metabase
-
Download the latest version of the plugin (JAR file named
clickhouse.metabase-driver.jar
) from the official CLickHouse® GitHub repository. -
Save
clickhouse.metabase-driver.jar
in your Metabase plugins folder. -
Start (or restart) Metabase to load the new plugin.
-
Access your Metabase server.
Connect Metabase to ClickHouse®
-
Click on the gear icon in the top-right corner and select Admin Settings to visit your Metabase admin page.
-
Click Add a database. Alternatively, you can click the Add database button from the Databases tab.
-
If your driver installation worked, you will see ClickHouse® in the dropdown menu for Database type.
-
Enter a display name for your database.
-
Enter the credentials Data Warehouse for ClickHouse® deployment. Toggle on **Use a secure connection (SSL)**if your ClickHouse® server is configured to use SSL.
-
Click Connect database to finish.
Your Data Warehouse for ClickHouse® is now integrated into your Metabase platform.
Refer to the official ClickHouse® and Metabase documentation portals for more information.
PowerBI Desktop
Power BI Desktop is a robust data visualization tool that allows users to create dynamic reports and dashboards from various data sources. To connect to your Data Warehouse for ClickHouse® deployment, PowerBI requires a MySQL connection using a dedicated user with a plain text password.
Creating a dedicated MySQL user
-
Run the SQL query below to create a user with a plain text password. Replace the placeholders with the appropriate values:
CREATE USER mysql_user IDENTIFIED WITH plaintext_password BY 'mysql_user_password';
-
Run the SQL query below to grant the user access to the database:
GRANT SELECT(id) ON my_database.my_table TO mysql_user WITH GRANT OPTION;
Your user can now access the specified database using the credentials you just defined.
Connecting PowerBI to your deployment
-
Make sure you have installed PowerBI Desktop, and MySQL Connector/NET.
-
Open PowerBI Desktop.
-
Click Get Data from the top ribbon, then select More... at the bottom of the drop-down menu. A pop-up displays.
-
Select the Database category, select MySQL database in the list, then click Connect. A connection pop-up displays.
-
Enter the values below, then click OK.
- Server:
<YOUR_DEPLOYMENT_ID>.dtwh.<REGION>.scw.cloud
- Database: the name of the database to import
A credentials pop-up displays.
- Server:
-
Select Database from the left menu, enter the values below, then click Connect.
- User name: your dedicated MySQL user previously created
- Password: the password you set at deployment creation
The Navigator pop-up displays, showing the different schemas and tables contained in your Data Warehouse for ClickHouse® deployment.
-
Select the desired tables, then Load to import data, or Transform Data to start working with your dataset.
-
Access PowerBI Service.
-
From the PowerBI Service interface, click the + New button from the toolbar. A list of data sources displays.
-
Select MySQL Database from the list. A connection wizard displays.
-
Enter the following values.
- Server:
<YOUR_DEPLOYMENT_ID>.dtwh.<REGION>.scw.cloud
- Database: the name of the database to import (
default
if you did not create additional databases in your deployment) - Connection:
<YOUR_DEPLOYMENT_ID>.dtwh.<REGION>.scw.cloud
- Connection name:
<YOUR_DEPLOYMENT_ID>.dtwh.<REGION>.scw.cloud
- Authentication type:
Basic
- Username: your dedicated MySQL user previously created)
- Password: The plain text password assigned to your MySQL user
- Privacy level:
None
- Server:
-
Click Next. The Power Query interface displays, allowing you to use the
MySQL.Database
function from this interface.
Your Data Warehouse for ClickHouse® is now integrated into your PowerBI platform.
Refer to the official ClickHouse® and PowerBI documentation portals for more information.