Ready to get started?

Learn more about the CData JDBC Driver for Gmail or download a free trial:

Download Now

Connect to Gmail Data in Aqua Data Studio

Access Gmail data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Gmail integrates Gmail data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Gmail data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Gmail data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, Gmail.
    • Driver Location: Click the Browse button and select the cdata.jdbc.gmail.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.gmail.GmailDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:gmail: and is followed by a semicolon-separated list of connection properties.

      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.

      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.

      A typical JDBC URL is below:

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

Query Gmail Data

You can now query the tables exposed.