Using the CData ODBC Driver for Avaza 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 Avaza 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 Avaza 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 Avaza

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.

Start by setting the Profile connection property to the location of the Avaza Profile on disk (e.g. C:\profiles\Avaza.apip). Next, set the ProfileSettings connection property to the connection string for Avaza (see below).

Avaza API Profile Settings

Register an OAuth application in Avaza under Settings > Manage Developer Apps > OAuth 2 Apps > Add OAuth App to obtain your client ID and secret credentials.

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for Avaza
Description = My Description
Profile = C:\profiles\Avaza.apip
Authscheme = OAuth
OAuthClientId = your_client_id
OAuthClientSecret = your_client_secret
CallbackUrl = your_callback_url

Execute SQL to Avaza

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 API};Profile = C:\profiles\Avaza.apip;Authscheme = OAuth;OAuthClientId = your_client_id;OAuthClientSecret = your_client_secret;CallbackUrl = your_callback_url;')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, CompanyName FROM Account WHERE DefaultCurrencyCode = 'USD'")
rows = cursor.fetchall()
for row in rows:
  print(row.Id, row.CompanyName)

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