Ready to get started?

Learn more about the CData Python Connector for Microsoft CDS or download a free trial:

Download Now

Use pandas to Visualize Microsoft CDS Data in Python

The CData Python Connector for Microsoft CDS enables you use pandas and other modules to analyze and visualize live Microsoft CDS data in Python.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for Microsoft CDS, the pandas & Matplotlib modules, and the SQLAlchemy toolkit, you can build Microsoft CDS-connected Python applications and scripts for visualizing Microsoft CDS data. This article shows how to use the pandas, SQLAlchemy, and Matplotlib built-in functions to connect to Microsoft CDS data, execute queries, and visualize the results.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Microsoft CDS data in Python. When you issue complex SQL queries from Microsoft CDS, the driver pushes supported SQL operations, like filters and aggregations, directly to Microsoft CDS and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Microsoft CDS Data

Connecting to Microsoft CDS data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

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.

Follow the procedure below to install the required modules and start accessing Microsoft CDS through Python objects.

Install Required Modules

Use the pip utility to install the pandas & Matplotlib modules and the SQLAlchemy toolkit:

pip install pandas
pip install matplotlib
pip install sqlalchemy

Be sure to import the module with the following:

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engine

Visualize Microsoft CDS Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Microsoft CDS data.

engine = create_engine("cds:///?OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Execute SQL to Microsoft CDS

Use the read_sql function from pandas to execute any SQL statement and store the resultset in a DataFrame.

df = pandas.read_sql("SELECT AccountId, Name FROM Accounts WHERE Name = 'MyAccount'", engine)

Visualize Microsoft CDS Data

With the query results stored in a DataFrame, use the plot function to build a chart to display the Microsoft CDS data. The show method displays the chart in a new window.

df.plot(kind="bar", x="AccountId", y="Name")
plt.show()

Free Trial & More Information

Download a free, 30-day trial of the Microsoft CDS Python Connector to start building Python apps and scripts with connectivity to Microsoft CDS data. Reach out to our Support Team if you have any questions.



Full Source Code

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engin

engine = create_engine("cds:///?OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
df = pandas.read_sql("SELECT AccountId, Name FROM Accounts WHERE Name = 'MyAccount'", engine)

df.plot(kind="bar", x="AccountId", y="Name")
plt.show()