Using the CData ODBC Driver for Google Data Catalog in PyCharm

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 Google Data Catalog 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 Google Data Catalog 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 Google Data Catalog

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.

Google Data Catalog uses the OAuth authentication standard. Authorize access to Google APIs on behalf on individual users or on behalf of users in a domain.

Before connecting, specify the following to identify the organization and project you would like to connect to:

• OrganizationId: The ID associated with the Google Cloud Platform organization resource you would like to connect to. Find this by navigating to the cloud console.

  Click the project selection drop-down, and select your organization from the list. Then, click More -> Settings. The organization ID is displayed on this page.

• ProjectId: The ID associated with the Google Cloud Platform project resource you would like to connect to.

  Find this by navigating to the cloud console dashboard and selecting your project from the Select from drop-down. The project ID will be present in the Project info card.

When you connect, the OAuth endpoint opens in your default browser. Log in and grant permissions to the application to completes the OAuth process. For more information, refer to the OAuth section in the Help documentation.

Below is the syntax for a DSN:

[CData GoogleDataCatalog Source]
Driver = CData ODBC Driver for Google Data Catalog
Description = My Description
ProjectId = YourProjectId
InitiateOAuth = GETANDREFRESH

Execute SQL to Google Data Catalog

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 GoogleDataCatalog};ProjectId = YourProjectId;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT Type, DatasetName FROM Schemas WHERE ProjectId = 'bigquery-public-data'")
rows = cursor.fetchall()
for row in rows:
 print(row.Type, row.DatasetName)

After connecting to Google Data Catalog in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Google Data Catalog data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at [email protected].