Using the CData ODBC Driver for Microsoft Dataverse 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 Microsoft Dataverse 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 Microsoft Dataverse as well as PyCharm.

Getting Started

---

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 Microsoft Dataverse

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 connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
• Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

Below is the syntax for a DSN:

[CData CDS Source]
Driver = CData ODBC Driver for Microsoft Dataverse
Description = My Description
OrganizationUrl = https://myaccount.crm.dynamics.com/
InitiateOAuth = GETANDREFRESH

Execute SQL to Microsoft Dataverse

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 CDS};OrganizationUrl = https://myaccount.crm.dynamics.com/;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT AccountId, Name FROM Accounts WHERE Name = 'MyAccount'")
rows = cursor.fetchall()
for row in rows:
 print(row.AccountId, row.Name)

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