Ready to get started?

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

Download Now

Use SQLAlchemy ORMs to Access Microsoft OneDrive Data in Python

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

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

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

Connecting to Microsoft OneDrive Data

Connecting to Microsoft OneDrive 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.

OneDrive uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the OAuth section of the Help documentation for an authentication guide.

Follow the procedure below to install SQLAlchemy and start accessing Microsoft OneDrive through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit:

pip install sqlalchemy

Be sure to import the module with the following:

import sqlalchemy

Model Microsoft OneDrive Data in Python

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

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

Declare a Mapping Class for Microsoft OneDrive 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"
	Id = Column(String,primary_key=True)
	Name = Column(String)
	...

Query Microsoft OneDrive 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("onedrive///?OAuthClientId=MyApplicationId&OAuthClientSecret=MySecretKey&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(Id="Jq74mCczmFXk1tC10GB"):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	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.Id == "Jq74mCczmFXk1tC10GB")):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

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

Free Trial & More Information

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