Manage CockroachDB Data in DBArtisan as a JDBC Source

The CData JDBC Driver for CockroachDB seamlessly integrates CockroachDB data into database management tools like DBArtisan by enabling you to access CockroachDB data as a database. This article shows how to create a JDBC source for CockroachDB in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate CockroachDB Data into DBArtisan Projects

Follow the steps below to register CockroachDB data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to CockroachDB data. CockroachDB entities are displayed in the Datasource Explorer.

You can now work with CockroachDB data as you work with any other database. See the driver help documentation for more information on the queries supported by the CockroachDB API.