How to connect to Gmail Data in DBVisualizer

The CData JDBC Driver for Gmail implements JDBC standards to provide connectivity to Gmail data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Gmail data in DBVisualizer and use the table editor to edit and save Gmail data.

Create a New Driver Definition for Gmail Data

Follow the steps below to use the Driver Manager to provide connectivity to Gmail data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager.
2. Click the plus sign "" to create a new driver.
3. Select "Custom" as the template.
4. On the Driver Settings tab:
   • Set Name to a user-friendly name (e.g. "CData Gmail Driver")
   • Set URL Format to jdbc:gmail: 👁 Setting the Driver Settings (Salesforce is shown).
     
   • In Driver artifacts and jar files (jars are loaded in order from top):
     1. Click the plus sign "" -> "Add Files"
     2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData JDBC Driver for Gmail XXXX\)
     3. Select the JAR file (cdata.jdbc.Gmail.jar) and click "Open"
     👁 Loading the driver JAR file.
     
5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.gmail.GmailDriver).

👁 The configured JDBC driver. (Salesforce is shown.)

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

1. In the "Databases" tab, click the plus sign "" and select the driver you just created.

2. In the "Connection" section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver Type: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:gmail: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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, register an application to obtain the OAuth JWT values.

     In addition to the OAuth values, 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.

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

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

     A typical connection string is below:

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

   • NOTE: Database Userid and Database Password correspond with the User and Password properties for Gmail.
3. On the Connection tab, click Connect. 👁 A newly configured Database Connection. (Salesforce is shown.)
   

To browse through tables exposed by the Gmail JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

👁 The results of a query in DBVisualizer. (Salesforce is shown.)

More Information & Free Trial

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