Learn more
 

Ready to get started?

Download a free trial of the Office 365 Connector to get started:

 Download Now

Learn more:

Office 365 Icon Office 365 Python Connector

Python Connector Libraries for Office 365 Data Connectivity. Integrate Office 365 with popular Python tools like Pandas, SQLAlchemy, Dash & petl.

In this article

Related articles

How to use SQLAlchemy ORM to access Office 365 Data in Python


The CData Python Connector for Office 365 enables you to create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Office 365 data.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for Office 365 and the SQLAlchemy toolkit, you can build Office 365-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Office 365 data to query, update, delete, and insert Office 365 data.

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

Connecting to Office 365 Data

Connecting to Office 365 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.

Office 365 uses the OAuth authentication standard. To authenticate requests, you will need to obtain the OAuthClientId, OAuthClientSecret, and OAuthCallbackURL by registering an app with Office 365. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Follow the procedure below to install SQLAlchemy and start accessing Office 365 through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker

Model Office 365 Data in Python

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

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("office365:///?OAuthClientId=MyApplicationId&OAuthClientSecret=MyAppKey&OAuthCallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Declare a Mapping Class for Office 365 Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Files table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base() class Files(base): __tablename__ = "Files" Name = Column(String,primary_key=True) Size = Column(String) ...

Query Office 365 Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("office365:///?OAuthClientId=MyApplicationId&OAuthClientSecret=MyAppKey&OAuthCallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Files).filter_by(UserId="54f34750-0d34-47c9-9949-9fac4791cddb"): print("Name: ", instance.Name) print("Size: ", instance.Size) print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Files_table = Files.metadata.tables["Files"] for instance in session.execute(Files_table.select().where(Files_table.c.UserId == "54f34750-0d34-47c9-9949-9fac4791cddb")): print("Name: ", instance.Name) print("Size: ", instance.Size) print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Insert Office 365 Data

To insert Office 365 data, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to Office 365.

new_rec = Files(Name="placeholder", UserId="54f34750-0d34-47c9-9949-9fac4791cddb") session.add(new_rec) session.commit()

Update Office 365 Data

To update Office 365 data, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to Office 365.

updated_rec = session.query(Files).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.UserId = "54f34750-0d34-47c9-9949-9fac4791cddb" session.commit()

Delete Office 365 Data

To delete Office 365 data, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided records (rows).

deleted_rec = session.query(Files).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()

Free Trial & More Information

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