How to use SQLAlchemy ORM to access Webex Data in Python

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

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

Connecting to Webex Data

Connecting to Webex 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.

To authenticate to Webex, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

Using OAuth Authentication

First, you will need to register an OAuth application with Webex. To do so, navigate to the Webex Developer Portal and create a new integration. Your OAuth application will be assigned a client id and a client secret.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to the client_id that is specified in your app settings.
• OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
• CallbackURL: Set this to the Redirect URI that is specified in your app settings.
• Scope: Set this in ProfileSettings to specify the OAuth scopes requested during authorization. Multiple scopes can be space-separated (e.g. ProfileSettings='Scope=spark:all spark:kms').

Example connection string:

Profile=C:\profiles\Webex.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;ProfileSettings='Scope=your_scopes';

Follow the procedure below to install SQLAlchemy and start accessing Webex 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 Webex Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Webex 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("api:///?Profile=C:\profiles\Webex.apip&Authscheme=OAuth&InitiateOAuth=GETANDREFRESH&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url&ProfileSettings='Scope=your_scopes'")

Declare a Mapping Class for Webex 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 AdminAuditEvents 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 AdminAuditEvents(base):
	__tablename__ = "AdminAuditEvents"
	 = Column(String,primary_key=True)
	 = Column(String)
	...

Query Webex 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("api:///?Profile=C:\profiles\Webex.apip&Authscheme=OAuth&InitiateOAuth=GETANDREFRESH&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url&ProfileSettings='Scope=your_scopes'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(AdminAuditEvents).filter_by(OrgId="org123"):
	print(": ", instance.)
	print(": ", instance.)
	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

AdminAuditEvents_table = AdminAuditEvents.metadata.tables["AdminAuditEvents"]
for instance in session.execute(AdminAuditEvents_table.select().where(AdminAuditEvents_table.c.OrgId == "org123")):
	print(": ", instance.)
	print(": ", instance.)
	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 CData API Driver for Python to start building Python apps and scripts with connectivity to Webex data. Reach out to our Support Team if you have any questions.