Validate Smartsheet Data with QuerySurge

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Smartsheet JDBC Driver

Easy-to-use Smartsheet client enables Java-based applications to easily consume Smartsheet Sheets, Contacts, Folders, Groups, Users, etc.



Access and validate Smartsheet data in QuerySurge using the CData JDBC Driver.

QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData JDBC Driver for Smartsheet, QuerySurge can work with live Smartsheet data. This article walks through connecting to Smartsheet data from QuerySurge.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Smartsheet data. When you issue complex SQL queries to Smartsheet, the driver pushes supported SQL operations, like filters and aggregations, directly to Smartsheet and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Smartsheet data using native data types.

Connecting to Smartsheet Data in QuerySurge

To connect to live Smartsheet data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.

Deploy the JDBC Driver

  1. Download the CData JDBC Driver for Smartsheet installer, unzip the package, and run the JAR file to install the driver.
  2. Once the driver is installed, stop the Agent Service.
  3. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for Smartsheet\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
  4. Restart the Agent Service.

For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.

Configure a New Connection to Smartsheet

  1. Log into QuerySurge and navigate to the Admin view.
  2. Click Configuration -> Connections in the Administration Tree.
  3. Click Add to create a new connection.
  4. In the QuerySurge Connection Wizard, click Next.
  5. Name the connection (e.g. CData JDBC Connection to Smartsheet).
  6. Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
  7. Set the Driver Class to cdata.jdbc.smartsheet.SmartsheetDriver and click Next.
  8. Set the Connection URL using the necessary connection properties to authenticate with Smartsheet. Your Connection URL will look something like the following:

    jdbc:smartsheet:OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH

    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.

    Smartsheet uses the OAuth authentication standard. To authenticate using OAuth, you will need to 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.

  9. Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM Sheet_Event_Plan_Budget LIMIT 1) and click Next.
  10. Click Test Connection to ensure the connection is configured properly and click Save to add the connection.

Once the connection is added, you can write SQL queries against your Smartsheet data in QuerySurge.

Compare Smartsheet Data Queries with a QueryPair

With the connection configured, you can follow the steps below to compare querying Smartsheet data with a QueryPair.

  1. Select "Design Library" from the Design Menu
  2. Click QueryPairs under QuerySurge Design
  3. Click "Create New QueryPair"
  4. Name the QueryPair and click Save
  5. In either the Source or Target panes, select the connection created above (select the same connection to query Smartsheet twice or another connection to perform a comparison)
  6. Write queries in the Editor for each pane, e.g. SELECT * FROM Sheet_Event_Plan_Budget
  7. Click the "Design-Time Run" tab to execute the queries
  8. When the query execution is finished, click "View Query Results" to see the Smartsheet data returned by the query

Download a free, 30-day trial of the CData JDBC Driver for Smartsheet and start working with your live Smartsheet data in QuerySurge. Reach out to our Support Team if you have any questions.