How to use SQLAlchemy ORM to access CapsuleCRM 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 CapsuleCRM-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to CapsuleCRM data to query CapsuleCRM data.

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

Connecting to CapsuleCRM Data

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

Start by setting the Profile connection property to the location of the CapsuleCRM Profile on disk (e.g. C:\profiles\Capsulecrm.apip). Next, set the ProfileSettings connection property to the connection string for CapsuleCRM (see below).

CapsuleCRM API Profile Settings

Register an OAuth application at https://developer.capsulecrm.com/signIn using your GitHub credentials to obtain a client ID and client secret.

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

You can now connect with a connection string. Use the create_engine function to create an Engine for working with CapsuleCRM 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\Capsulecrm.apip&Authscheme=OAuth&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url")

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

Query CapsuleCRM 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\Capsulecrm.apip&Authscheme=OAuth&OAuthClientId=your_client_id&OAuthClientSecret=your_client_secret&CallbackUrl=your_callback_url")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(ActivityTypes).filter_by(Name="Phone Call"):
	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

ActivityTypes_table = ActivityTypes.metadata.tables["ActivityTypes"]
for instance in session.execute(ActivityTypes_table.select().where(ActivityTypes_table.c.Name == "Phone Call")):
	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 CData API Driver for Python to start building Python apps and scripts with connectivity to CapsuleCRM data. Reach out to our Support Team if you have any questions.