Manage Gmail Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Gmail seamlessly integrates Gmail data into database management tools like DBArtisan by enabling you to access Gmail data as a database. This article shows how to create a JDBC source for Gmail in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Gmail Data into DBArtisan Projects

Follow the steps below to register Gmail data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in 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.

   Below is a typical connection string:

   jdbc:gmail:User=username;Password=password;
6. Finish the wizard to connect to Gmail data. Gmail entities are displayed in the Datasource Explorer.

You can now work with Gmail data as you work with any other database. See the driver help documentation for more information on the queries supported by the Gmail API.