Query Neo4J Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Neo4J, DataGrip can work with live Neo4J data. This article shows how to establish a connection to Neo4J data in DataGrip.

Create a New Driver Definition for Neo4J

The steps below describe how to create a new Data Source in DataGrip for Neo4J.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Neo4J Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.neo4j.jar).
   • Set Class to cdata.jdbc.neo4j.Neo4j.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Neo4J

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Neo4J Driver" to create a new Neo4J Data Source.
2. In the new window, configure the connection to Neo4J with a JDBC URL.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Neo4J JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.neo4j.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   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.
3. Set URL to the connection string, e.g., jdbc:neo4j:Server=localhost;Port=7474;User=my_user;Password=my_password;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Neo4J

To browse through the Neo4J entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT CategoryId, CategoryName FROM ProductCategory WHERE CategoryOwner = 'CData Software'

Download a free, 30-day trial of the CData JDBC Driver for Neo4J and start working with your live Neo4J data in DataGrip. Reach out to our Support Team if you have any questions.