Ready to get started?

Download a free trial of the IBM Cloud Data Engine Driver to get started:

 Download Now

Learn more:

IBM Cloud Data Engine Icon IBM Cloud Data Engine JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with IBM Cloud Data Engine.

A PostgreSQL Interface for IBM Cloud Data Engine Data



Use the Remoting features of the IBM Cloud Data Engine 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 IBM Cloud Data Engine data as a PostgreSQL database, use the CData JDBC Driver for IBM Cloud Data Engine and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query IBM Cloud Data Engine data from PostgreSQL Server.

Connect to IBM Cloud Data Engine Data as a JDBC Data Source

To connect to IBM Cloud Data Engine 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.ibmclouddataengine.IBMCloudDataEngineDriver

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

    IBM Cloud Data Engine uses the OAuth and HMAC authentication standards. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the IBM Cloud Data Engine JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.ibmclouddataengine.jar

    Fill in the connection properties and copy the connection string to the clipboard.

    A typical JDBC URL is below:

    jdbc:ibmclouddataengine:Api Key=MyAPIKey;Instance CRN=myInstanceCRN;Region=myRegion;Schema=mySchema;OAuth Client Id=myOAuthClientId;OAuth Client Secret=myOAuthClientSecret;InitiateOAuth=GETANDREFRESH

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 IBM Cloud Data Engine Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to IBM Cloud Data Engine data:

  1. Log into your database.
  2. Load the extension for the database: CREATE EXTENSION jdbc2_fdw;
  3. Create a server object for IBM Cloud Data Engine: CREATE SERVER IBMCloudDataEngine FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.ibmclouddataengine.IBMCloudDataEngineDriver', url 'jdbc:ibmclouddataengine:Api Key=MyAPIKey;Instance CRN=myInstanceCRN;Region=myRegion;Schema=mySchema;OAuth Client Id=myOAuthClientId;OAuth Client Secret=myOAuthClientSecret;InitiateOAuth=GETANDREFRESH', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.ibmclouddataengine.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 IBMCloudDataEngine OPTIONS ( username 'admin', password 'test');
  5. Create a foreign table in your local database: postgres=# CREATE FOREIGN TABLE jobs ( jobs_id text, jobs_Id text, jobs_Status numeric) SERVER IBMCloudDataEngine OPTIONS ( table_name 'jobs');
You can now execute read/write commands to IBM Cloud Data Engine: postgres=# SELECT * FROM jobs;