A PostgreSQL Interface for CockroachDB Data

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 the Remoting features of the CockroachDB JDBC Driver to create a PostgreSQL entry-point for data access.

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access CockroachDB data as a PostgreSQL database, use the CData JDBC Driver for CockroachDB and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query CockroachDB data from PostgreSQL Server.

Connect to CockroachDB Data as a JDBC Data Source

To connect to CockroachDB as a JDBC data source, you will need the following:

  • Driver JAR path: The JAR is located in the lib subfolder of the installation directory.
  • Driver class: cdata.jdbc.cockroachdb.CockroachDBDriver

  • JDBC URL: The URL must start with "jdbc:cockroachdb:" and can include any of the connection properties in name-value pairs separated with semicolons.

    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

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

  1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example: ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
  2. Start the build: make install USE_PGXS=1

Query CockroachDB Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to CockroachDB data:

  1. Log into your database.
  2. Load the extension for the database: CREATE EXTENSION jdbc2_fdw;
  3. Create a server object for CockroachDB: CREATE SERVER CockroachDB FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.cockroachdb.CockroachDBDriver', url 'jdbc:cockroachdb:User=root;Password=root;Database=system;Server=localhost;Port=26257', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.cockroachdb.jar');
  4. Create a user mapping for the username and password of a user known to the MySQL daemon. CREATE USER MAPPING for postgres SERVER CockroachDB OPTIONS ( username 'admin', password 'test');
  5. Create a foreign table in your local database: postgres=# CREATE FOREIGN TABLE orders ( orders_id text, orders_ShipName text, orders_ShipCity numeric) SERVER CockroachDB OPTIONS ( table_name 'orders');
You can now execute read/write commands to CockroachDB: postgres=# SELECT * FROM orders;