Ready to get started?

Learn more about the CData JDBC Driver for IBM Cloud SQL Query or download a free trial:

Download Now

A PostgreSQL Interface for IBM Cloud SQL Query Data

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

Connect to IBM Cloud SQL Query Data as a JDBC Data Source

To connect to IBM Cloud SQL Query 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.ibmcloudsqlquery.IBMCloudSQLQueryDriver

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

    IBM Cloud SQL 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 SQL Query JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.ibmcloudsqlquery.jar

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

    A typical JDBC URL is below:

    jdbc:ibmcloudsqlquery: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.

  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 SQL Query Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to IBM Cloud SQL Query 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 SQL Query: CREATE SERVER IBMCloudSQLQuery FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.ibmcloudsqlquery.IBMCloudSQLQueryDriver', url 'jdbc:ibmcloudsqlquery: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.ibmcloudsqlquery.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 IBMCloudSQLQuery 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 IBMCloudSQLQuery OPTIONS ( table_name 'jobs');
You can now execute read/write commands to IBM Cloud SQL Query: postgres=# SELECT * FROM jobs;