How to integrate Metabase with Neo4J 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 Neo4J data. This article describes how to connect to Neo4J and build a simple visualization using Neo4J data.
CData Connect provides a pure cloud-to-cloud interface for Neo4J, allowing you to easily integrate with live Neo4J 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 Neo4J, leveraging server-side processing to quickly return Neo4J data.
Configure Neo4J Connectivity for Metabase
Connectivity to Neo4J from Metabase is made possible through CData Connect AI. To work with Neo4J data from Metabase, we start by creating and configuring a Neo4J connection.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "Neo4J" from the Add Connection panel
-
Enter the necessary authentication properties to connect to Neo4J.
To connect to Neo4j, set the following connection properties:
- Server: The server hosting the Neo4j instance.
- Port: The port on which the Neo4j service is running. The provider connects to port 7474 by default.
- User: The username of the user using the Neo4j instance.
- Password: The password of the user using the Neo4j instance.
- Click Save & Test
-
Navigate to the Permissions tab in the Add Neo4J Connection page and update the User-based 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.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- 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 Neo4J 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.
- Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab
- Configure the connection to Connect AI and click "Save"
- Database type: Select "SQL Server"
- Name: Name the connection (e.g. "Neo4J (Connect AI)")
- Host: tds.cdata.com
- Port: 14333
- Database name: The name of the connection you just created (e.g. Neo4j1)
- Username: A Connect AI username (e.g. [email protected])
- Password: The PAT previously created
- Click to Use a secure connection (SSL)
Execute Neo4J Data with Metabase
Once you configure the connection to Connect AI, you can query Neo4J and build visualizations.
- Use the "Write SQL" tool to retrieve the Neo4J data
- Write a SQL query based on the Neo4J connection in CData Connect AI, e.g.
SELECT CategoryId, CategoryName FROM ProductCategory WHERE CategoryOwner = 'CData Software'
- Navigate to the "Visualization" screen, choose a visualization, and configure the visualization
More Information & Free Trial
At this point, you have built a simple visualization from Neo4J data in Metabase. You can continue to work with live Neo4J data in Metabase just like you would any SQL Server database. For more information on creating a live connection to Neo4J (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live Neo4J data in Metabase today.