A PostgreSQL Interface for Cloudant Data

Ready to get started?

Download a free trial of the Cloudant Driver to get started:

 Download Now

Learn more:

IBM Cloudant Icon Cloudant JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with IBM Cloudant NoSQL databases.



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

Connect to Cloudant Data as a JDBC Data Source

To connect to Cloudant 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.cloudant.CloudantDriver

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

    Set the following connection properties to connect to Cloudant:

    • User: Set this to your username.
    • Password: Set this to your password.

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.cloudant.jar

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

    A typical JDBC URL is below:

    jdbc:cloudant:User=abc123; Password=abcdef;

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

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

  1. Log into your database.
  2. Load the extension for the database: CREATE EXTENSION jdbc2_fdw;
  3. Create a server object for Cloudant: CREATE SERVER Cloudant FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.cloudant.CloudantDriver', url 'jdbc:cloudant:User=abc123; Password=abcdef;', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.cloudant.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 Cloudant OPTIONS ( username 'admin', password 'test');
  5. Create a foreign table in your local database: postgres=# CREATE FOREIGN TABLE movies ( movies_id text, movies_MovieRuntime text, movies_MovieRating numeric) SERVER Cloudant OPTIONS ( table_name 'movies');
You can now execute read/write commands to Cloudant: postgres=# SELECT * FROM movies;