Connect to CockroachDB Data in DBeaver

The CData JDBC Driver for CockroachDB implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to CockroachDB data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for CockroachDB Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
2. In the Driver Name box, enter a user-friendly name for the driver.
3. To add the .jar, click Add File.
4. In the create new driver dialog that appears, select the cdata.jdbc.cockroachdb.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the CockroachDBDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.cockroachdb.CockroachDBDriver.
6. Add jdbc:cockroachdb: in the URL Template field.

Create a Connection to CockroachDB Data

Follow the steps below to add credentials and other required connection properties.

1. In the Databases menu, click New Connection.
2. In the Create new connection wizard that results, select the driver.
3. On the next page of the wizard, click the driver properties tab.

4. Enter values for authentication credentials and other properties required 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.

   Below is a typical connection string:

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

Query CockroachDB Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.