Load CockroachDB Data to a Database Using Embulk

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.



Use CData JDBC Driver for CockroachDB with the open source ETL/ELT tool Embulk to load CockroachDB data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for CockroachDB, Embulk easily loads data from CockroachDB to any supported destination. In this article, we explain how to use the CData JDBC Driver for CockroachDB in Embulk to load CockroachDB data to a MySQL dtabase.

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).

Configure a JDBC Connection to CockroachDB Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for CockroachDB\lib).

Embulk supports JDBC connectivity, so you can easily connect to CockroachDB and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with 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.

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.

Below is a typical JDBC connection string for CockroachDB:

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

Load CockroachDB Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load CockroachDB data into MySQL using Embulk.

Create a Job to Load CockroachDB Data

Start by creating a config file in Embulk, using a name like cockroachdb-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for CockroachDB, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.cockroachdb.CockroachDBDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (cockroachdb-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for CockroachDB 20xx\lib\cdata.jdbc.cockroachdb.jar driver_class: cdata.jdbc.cockroachdb.CockroachDBDriver url: jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257 table: "Orders" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Orders" mode: insert

After creating the file, run the Embulk job.

embulk run cockroachdb-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered CockroachDB Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for CockroachDB 20xx\lib\cdata.jdbc.cockroachdb.jar driver_class: cdata.jdbc.cockroachdb.CockroachDBDriver url: jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257 query: "SELECT ShipName, ShipCity FROM Orders WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Orders" mode: insert

More Information & Free Trial

By using CData JDBC Driver for CockroachDB as a connector, Embulk can integrate CockroachDB data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.