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!

Load Gmail Data to a Database Using Embulk



Use CData JDBC Driver for Gmail with the open source ETL/ELT tool Embulk to load Gmail data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Gmail, Embulk easily loads data from Gmail to any supported destination. In this article, we explain how to use the CData JDBC Driver for Gmail in Embulk to load Gmail data to a MySQL dtabase.

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).

Configure a JDBC Connection to Gmail Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Gmail\lib).

Embulk supports JDBC connectivity, so you can easily connect to Gmail and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with 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 JDBC connection string for Gmail:

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

Load Gmail Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load Gmail data into MySQL using Embulk.

Create a Job to Load Gmail Data

Start by creating a config file in Embulk, using a name like gmail-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for Gmail, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.gmail.GmailDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (gmail-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Gmail 20xx\lib\cdata.jdbc.gmail.jar driver_class: cdata.jdbc.gmail.GmailDriver url: jdbc:gmail:User=username;Password=password; table: "Inbox" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Inbox" mode: insert

After creating the file, run the Embulk job.

embulk run gmail-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Gmail Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Gmail 20xx\lib\cdata.jdbc.gmail.jar driver_class: cdata.jdbc.gmail.GmailDriver url: jdbc:gmail:User=username;Password=password; query: "SELECT Subject, Size FROM Inbox WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Inbox" mode: insert

More Information & Free Trial

By using CData JDBC Driver for Gmail as a connector, Embulk can integrate Gmail data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.