How to integrate Metabase with CockroachDB 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 CockroachDB data. This article describes how to connect to CockroachDB and build a simple visualization using CockroachDB data.

CData Connect provides a pure cloud-to-cloud interface for CockroachDB, allowing you to easily integrate with live CockroachDB 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 CockroachDB, leveraging server-side processing to quickly return CockroachDB data.

Configure CockroachDB Connectivity for Metabase

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

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

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

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

   Set the following to connect to CockroachDB.

   • Server: The host name or IP address of the server.
   • Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
   • Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
   • User: The Cockroach DB user account used to authenticate.
   • Password: The password used to authenticate the user.
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add CockroachDB 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 CockroachDB 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. "CockroachDB (Connect AI)")
   • Host: tds.cdata.com
   • Port: 14333
   • Database name: The name of the connection you just created (e.g. CockroachDB1)
   • 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 CockroachDB Data with Metabase

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

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

   SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'

   👁 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 CockroachDB data in Metabase. You can continue to work with live CockroachDB data in Metabase just like you would any SQL Server database. For more information on creating a live connection to CockroachDB (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live CockroachDB data in Metabase today.