Build a PostgreSQL Interface for Smartsheet Data using the CData JDBC Driver

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

Getting Started

---

Connect to Smartsheet Data as a JDBC Data Source

To connect to Smartsheet 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.smartsheet.SmartsheetDriver
  

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

  Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

  However, for testing purposes you can instead use the Personal Access Token you get when you create an application; set this to the OAuthAccessToken connection property.

  Built-in Connection String Designer

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

  java -jar cdata.jdbc.smartsheet.jar
  

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

  👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  

  A typical JDBC URL is below:

  jdbc:smartsheet: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 Smartsheet Data as a PostgreSQL Database

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

1. Log into your database.
2. Load the extension for the database:

   CREATE EXTENSION jdbc2_fdw;
   

3. Create a server object for Smartsheet:

   CREATE SERVER Smartsheet 
   FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
   drivername 'cdata.jdbc.smartsheet.SmartsheetDriver',
   url 'jdbc:smartsheet: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.smartsheet.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 Smartsheet OPTIONS (
   username 'admin', 
   password 'test');
   

5. Create a foreign table in your local database:

   postgres=# CREATE FOREIGN TABLE sheet_event_plan_budget (
   sheet_event_plan_budget_id text,
   sheet_event_plan_budget_TaskName text,
   sheet_event_plan_budget_Progress numeric) 
   SERVER Smartsheet OPTIONS (
   table_name 'sheet_event_plan_budget');
   

You can now execute read/write commands to Smartsheet:

postgres=# SELECT * FROM sheet_event_plan_budget;