How to integrate Metabase with MySQL Data

Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect AI, users can easily create visualizations and dashboards linked to live MySQL data. This article describes how to connect to MySQL and build a simple visualization using MySQL data.

CData Connect provides a pure cloud-to-cloud interface for MySQL, allowing you to easily integrate with live MySQL data in Metabase — without replicating the data. Connect looks exactly like a SQL Server database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to MySQL, leveraging server-side processing to quickly return MySQL data.

Configure MySQL Connectivity for Metabase

Connectivity to MySQL from Metabase is made possible through CData Connect AI. To work with MySQL data from Metabase, we start by creating and configuring a MySQL connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "MySQL" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect to MySQL.

   The CData Provider supports connecting to on-premises and cloud-hosted versions of MySQL such as Amazon RDS for MySQL, Google Cloud SQL for MySQL, Azure Database for MySQL, or Oracle MySQL HeatWave. The Server and Port properties must be set to a MySQL server. If IntegratedSecurity is set to false, then User and Password must be set to valid user credentials. Optionally, Database can be set to connect to a specific database. If not set, tables from all databases will be returned.

   SSH Connectivity for MySQL

   You can use SSH (Secure Shell) to authenticate with MySQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

   SSH Connections to MySQL in Password Auth Mode

   To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

   • User: MySQL User name
   • Password: MySQL Password
   • Database: MySQL database name
   • Server: MySQL Server name
   • Port: MySQL port number like 3306
   • UserSSH: "true"
   • SSHAuthMode: "Password"
   • SSHPort: SSH Port number
   • SSHServer: SSH Server name
   • SSHUser: SSH User name
   • SSHPassword: SSH Password

   SSH Connections to MySQL in Public Key Auth Mode

   To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

   • User: MySQL User name
   • Password: MySQL Password
   • Database: MySQL database name
   • Server: MySQL Server name
   • Port: MySQL port number like 3306
   • UserSSH: "true"
   • SSHAuthMode: "Public_Key"
   • SSHPort: SSH Port number
   • SSHServer: SSH Server name
   • SSHUser: SSH User name
   • SSHClientCret: the path for the public key certificate file
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add MySQL Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to MySQL data from Metabase.

Connect to CData Connect AI from Metabase

After creating the connection in Connect AI, navigate to your Metabase instance. Use the SQL Server interface to connect to Connect AI.

1. Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab 👁 Adding a new database connection to Metabase.
   
2. Configure the connection to Connect AI and click "Save"
   • Database type: Select "SQL Server"
   • Name: Name the connection (e.g. "MySQL (Connect AI)")
   • Host: tds.cdata.com
   • Port: 14333
   • Database name: The name of the connection you just created (e.g. MySQL1)
   • Username: A Connect AI username (e.g. [email protected])
   • Password: The PAT previously created
   • Click to Use a secure connection (SSL)
   👁 Configuring the connection to Connect AI.
   

Execute MySQL Data with Metabase

Once you configure the connection to Connect AI, you can query MySQL and build visualizations.

1. Use the "Write SQL" tool to retrieve the MySQL data 👁 Click the 'Write SQL' button.
   
2. Write a SQL query based on the MySQL connection in CData Connect AI, e.g.
   
   

   SELECT ShipName, Freight FROM Orders

   👁 Collected data (Salesforce is shown).
   
3. Navigate to the "Visualization" screen, choose a visualization, and configure the visualization 👁 Collected data (Salesforce is shown).
   

More Information & Free Trial

At this point, you have built a simple visualization from MySQL data in Metabase. You can continue to work with live MySQL data in Metabase just like you would any SQL Server database. For more information on creating a live connection to MySQL (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live MySQL data in Metabase today.