Ready to get started?

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

 Download Now

Learn more:

Gmail Icon Gmail JDBC Driver

Rapidly create and deploy powerful Java applications that integrate powerful Gmail send and receive capabilities. . Send & Receive Email, manage Gmail folders & Messages, and more!

Validate Gmail Data with QuerySurge



Access and validate Gmail 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 Gmail, QuerySurge can work with live Gmail data. This article walks through connecting to Gmail data from QuerySurge.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Gmail data. When you issue complex SQL queries to Gmail, the driver pushes supported SQL operations, like filters and aggregations, directly to Gmail 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 Gmail data using native data types.

Connecting to Gmail Data in QuerySurge

To connect to live Gmail 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 Gmail 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 Gmail\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 Gmail

  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 Gmail).
  6. Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
  7. Set the Driver Class to cdata.jdbc.gmail.GmailDriver and click Next.
  8. Set the Connection URL using the necessary connection properties to authenticate with Gmail. Your Connection URL will look something like the following:

    jdbc:gmail:User=username;Password=password;

    Built-in Connection String Designer

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

    java -jar cdata.jdbc.gmail.jar

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

    There are two ways to authenticate to Gmail. Before selecting one, first ensure that you have enabled IMAP access in your Gmail account settings. See the "Connecting to Gmail" section under "Getting Started" in the installed documentation for a guide.

    The User and Password properties, under the Authentication section, can be set to valid Gmail user credentials.

    Alternatively, instead of providing the Password, you can use the OAuth authentication standard. To access Google APIs on behalf on individual users, you can use the embedded credentials or you can register your own OAuth app.

    OAuth also enables you to use a service account to connect on behalf of users in a Google Apps domain. To authenticate with a service account, you will need to register an application to obtain the OAuth JWT values.

    In addition to the OAuth values, you will need to provide the User. See the "Getting Started" chapter in the help documentation for a guide to using OAuth.

  9. Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM Inbox 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 Gmail data in QuerySurge.

Compare Gmail Data Queries with a QueryPair

With the connection configured, you can follow the steps below to compare querying Gmail 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 Gmail twice or another connection to perform a comparison)
  6. Write queries in the Editor for each pane, e.g. SELECT * FROM Inbox
  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 Gmail data returned by the query

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