Query CockroachDB 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 CockroachDB, DataGrip can work with live CockroachDB data. This article shows how to establish a connection to CockroachDB data in DataGrip and use the table editor to load CockroachDB data.

Create a New Driver Definition for CockroachDB

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

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 CockroachDB 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.cockroachdb.jar).
   • Set Class to cdata.jdbc.cockroachdb.CockroachDB.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 CockroachDB

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

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.cockroachdb.jar

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

   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.
3. Set URL to the connection string, e.g., jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257
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 CockroachDB

To browse through the CockroachDB 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 ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'

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