A PostgreSQL Interface for Box Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Box JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Box cloud storage data including Files, Folders, Tasks, Groups, and more!



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

Connect to Box Data as a JDBC Data Source

To connect to Box 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.box.BoxDriver

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

    Box uses the OAuth standard to authenticate. To authenticate to Box, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app. 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 Box JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

    java -jar cdata.jdbc.box.jar

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

    A typical JDBC URL is below:

    jdbc:box:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;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 Box Data as a PostgreSQL Database

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

  1. Log into your database.
  2. Load the extension for the database: CREATE EXTENSION jdbc2_fdw;
  3. Create a server object for Box: CREATE SERVER Box FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.box.BoxDriver', url 'jdbc:box:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.box.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 Box OPTIONS ( username 'admin', password 'test');
  5. Create a foreign table in your local database: postgres=# CREATE FOREIGN TABLE files ( files_id text, files_Name text, files_Size numeric) SERVER Box OPTIONS ( table_name 'files');
You can now execute read/write commands to Box: postgres=# SELECT * FROM files;