Connect to CockroachDB Data in CloverDX (formerly CloverETL)

Ready to get started?

Download for a free trial:

Download Now

Learn more:

CockroachDB JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with CockroachDB.



Transfer CockroachDB data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for CockroachDB enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with CockroachDB as sources and destinations. In this article, you will use the JDBC Driver for CockroachDB to set up a simple transfer into a flat file. The CData JDBC Driver for CockroachDB enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with CockroachDB as sources and destinations. In this article, you will use the JDBC Driver for CockroachDB to set up a simple transfer into a flat file.

Connect to CockroachDB as a JDBC Data Source

  1. Create the connection to CockroachDB data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.cockroachdb.jar file.
  3. Enter 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.

    A typical JDBC URL is below:

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

Query CockroachDB Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the CockroachDB JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Orders table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.