How to connect to CockroachDB Data from IntelliJ

The CData JDBC Driver for CockroachDB enables you to access CockroachDB as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to CockroachDB data in IntelliJ.

Create a JBDC Data Source for CockroachDB

Follow the steps below to add the driver JAR and define connection properties required to connect to CockroachDB data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.cockroachdb.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.cockroachdb.CockroachDBDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:cockroachdb: and includes connection properties separated with semicolons.

     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.

     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.

     A typical JDBC URL is the following:

     jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257

Edit and Save CockroachDB Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.