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
- 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-jdbcto download the compatible version of the ClickHouse® JDBC driver. -
Store the JDBC driver in the
Driversfolder. 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.
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
Your Data Warehouse for ClickHouse® is now integrated into your PowerBI platform.
Refer to the official ClickHouse® and PowerBI documentation portals for more information.
Toucan
Creating a new ClickHouse® connector for your deployment
Toucan is a business intelligence platform that transforms raw data into actionable insights through customizable visualizations and dashboards. Toucan's ClickHouse® connector allows you to use your Data Warehouse for ClickHouse® deployment as a data source.
-
Log in to your Toucan account.
-
From your Toucan App Store, create a new app, or select the one you want to connect to Data Warehouse for ClickHouse®.
-
From the My datasources tab of your Datahub, click Add a connector. A pop-up displays.
-
Select the ClickHouse® from the list, then fill in the fields with the following information:
Field Description Name The name you want to give to your new connection Host Data Warehouse deployment host (available from the Scaleway Console) Port 9440User A user with read ( SELECT) permissionsPassword The user's password SSL_connection Must be enabled to connect to your deployment via SSL Retry Policy (optional) (Optional) enables a retry policy if the connection is unstable Slow Queries Cache Expiration Time (optional) (Optional) slow queries cache expiration time in seconds -
Click Save. Your new ClickHouse® connector appears in the list.
Your Data Warehouse for ClickHouse® is now connected to your Toucan app, and can be used as a data source.
Refer to the official Toucan documentation for more information on the ClickHouse® connector.
Creating new datasets from your deployment
-
Click the + icon in your new connector to create a new dataset. A form displays.
-
Select the desired database from the Database drop-down menu.
-
Select the desired table from the Table or view drop-down menu.
-
Select the columns you want to import from the Columns drop-down menu. Tick/untick the checkboxes to filter data.
-
Click Next. A preview of the data displays, showing the selected columns only.
-
Click Create to proceed.
-
Enter a name for your data set, select Data requested live, then click Save to finish.
Your data set now appears in the Datasets tab of your Datahub, and is now ready to be used.
Refer to the official Toucan documentation for more information on how to create visualizations using your new data set.