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 CloverDX (formerly CloverETL)

Transfer Gmail data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Gmail enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Gmail as sources and destinations. In this article, you will use the JDBC Driver for Gmail to set up a simple transfer into a flat file. The CData JDBC Driver for Gmail enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Gmail as sources and destinations. In this article, you will use the JDBC Driver for Gmail to set up a simple transfer into a flat file.

Connect to Gmail as a JDBC Data Source

  1. Create the connection to Gmail data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.gmail.jar file.
  3. Enter the JDBC URL.

    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 with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Gmail JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Subject, Size FROM Inbox

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Inbox table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.