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 DBeaver

Manage Gmail data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for Gmail implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Gmail data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Gmail Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.gmail.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the GmailDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.gmail.GmailDriver.
  6. Add jdbc:gmail: in the URL Template field.

Create a Connection to Gmail Data

Follow the steps below to add credentials and other required connection properties.

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to Gmail.

    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.

    Below is a typical connection string:

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

Query Gmail Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.