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

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.

Connecting to Azure Synapse

In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

• Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
• Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

Authenticating to Azure Synapse

Connect to Azure Synapse using the following properties:

• User: The username provided for authentication with Azure.
• Password: The password associated with the authenticating user.

Below is the syntax for a DSN:

[CData AzureSynapse Source]
Driver = CData ODBC Driver for Azure Synapse
Description = My Description
User = myuser
Password = mypassword
Server = localhost
Database = Northwind

Execute SQL to Azure Synapse

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 AzureSynapse};User = myuser;Password = mypassword;Server = localhost;Database = Northwind;')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, ProductName FROM Products WHERE ProductName = 'Konbu'")
rows = cursor.fetchall()
for row in rows:
 print(row.Id, row.ProductName)

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