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

You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

<>CatalogName: Set this to the CatalogName associated with your Azure Data Catalog. To get your Catalog name, navigate to your Azure Portal home page > Data Catalog > Catalog Name

Connect Using OAuth Authentication

You must use OAuth to authenticate with Azure Data Catalog. OAuth requires the authenticating user to interact with Azure Data Catalog using the browser. For more information, refer to the OAuth section in the help documentation.

Below is the syntax for a DSN:

[CData AzureDataCatalog Source]
Driver = CData ODBC Driver for Azure Data Catalog
Description = My Description
InitiateOAuth = GETANDREFRESH

Execute SQL to Azure 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 AzureDataCatalog};InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT DslAddressDatabase, Type FROM Tables WHERE Name = 'FactProductInventory'")
rows = cursor.fetchall()
for row in rows:
 print(row.DslAddressDatabase, row.Type)

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