Ready to get started?

Learn more about the CData ODBC Driver for Gmail or download a free trial:

Download Now

Using the CData ODBC Driver for Gmail in PyCharm

Connect to Gmail as an ODBC data source in PyCharm using the CData ODBC Driver for Gmail.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Gmail from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Gmail as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to Gmail

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData Gmail Source] Driver = CData ODBC Driver for Gmail Description = My Description User = username Password = password

Execute SQL to Gmail

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for Gmail};User = username;Password = password;') cursor = cnxn.cursor() cursor.execute("SELECT Subject, Size FROM Inbox WHERE From = 'test@test.com'") rows = cursor.fetchall() for row in rows: print(row.Subject, row.Size)

After connecting to Gmail in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Gmail data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.