Connect to CockroachDB Data in HULFT Integrate

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.



Connect to CockroachDB as a JDBC data source in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for CockroachDB, HULFT Integrate can work with live CockroachDB data. This article walks through connecting to CockroachDB and moving the data into a CSV file.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live CockroachDB data. When you issue complex SQL queries to CockroachDB, the driver pushes supported SQL operations, like filters and aggregations, directly to CockroachDB and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze CockroachDB data using native data types.

Enable Access to CockroachDB

To enable access to CockroachDB data from HULFT Integrate projects:

  1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.cockroachdb.jar (and cdata.jdbc.cockroachdb.lic), to the jdbc_adapter subfolder for the Integrate Server
  2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to CockroachDB Data

Once you copy the JAR files, you can create a project with access to CockroachDB data. Start by opening Integrate Studio and creating a new project.

  1. Name the project
  2. Ensure the "Create script" checkbox is checked
  3. Click Next
  4. Name the script (e.g.: CockroachDBtoCSV)

Once you create the project, add components to the script to copy CockroachDB data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

  1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for CockroachDB. Set the following properties:
    • Name: CockroachDB Connection Settings
    • Driver class name: cdata.jdbc.cockroachdb.CockroachDBDriver
    • URL: jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257

      Built-in Connection String Designer

      For assistance 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.
  2. Write your SQL statement. For example:
    SELECT ShipName, ShipCity FROM Orders
  3. Click "Extraction test" to ensure the connection and query are configured properly
  4. Click "Execute SQL statement and set output schema"
  5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

  1. Set a file to write the query results to (e.g. Orders.csv)
  2. Set "Input data" to the "Select SQL" component
  3. Add columns for each field selected in the SQL query
  4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
  5. Click "Finish"

Map CockroachDB Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move CockroachDB data into a CSV file.

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