Using the CData ODBC Driver for Google Cloud Storage 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 Cloud Storage 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 Cloud Storage 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 Cloud Storage

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.

Authenticate with a User Account

You can connect without setting any connection properties for your user credentials. After setting InitiateOAuth to GETANDREFRESH, you are ready to connect.

When you connect, the Google Cloud Storage OAuth endpoint opens in your default browser. Log in and grant permissions, then the OAuth process completes

Authenticate with a Service Account

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes.

You need to create an OAuth application in this flow. See the Help documentation for more information. After setting the following connection properties, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH.
• OAuthJWTCertType: Set this to "PFXFILE".
• OAuthJWTCert: Set this to the path to the .p12 file you generated.
• OAuthJWTCertPassword: Set this to the password of the .p12 file.
• OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
• OAuthJWTIssuer: In the service accounts section, click Manage Service Accounts and set this field to the email address displayed in the service account Id field.
• OAuthJWTSubject: Set this to your enterprise Id if your subject type is set to "enterprise" or your app user Id if your subject type is set to "user".
• ProjectId: Set this to the Id of the project you want to connect to.

The OAuth flow for a service account then completes.

Below is the syntax for a DSN:

[CData GoogleCloudStorage Source]
Driver = CData ODBC Driver for Google Cloud Storage
Description = My Description
ProjectId = 'project1'
InitiateOAuth = GETANDREFRESH

Execute SQL to Google Cloud Storage

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 GoogleCloudStorage};ProjectId = 'project1';InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT Name, OwnerId FROM Buckets WHERE Name = 'TestBucket'")
rows = cursor.fetchall()
for row in rows:
 print(row.Name, row.OwnerId)

After connecting to Google Cloud Storage in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Google Cloud Storage 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].