Use SQLAlchemy ORMs to Access SuiteCRM Data in Python

Ready to get started?

Download a free trial of the SuiteCRM Connector to get started:

 Download Now

Learn more:

SuiteCRM Icon SuiteCRM Python Connector

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

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

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

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

Connecting to SuiteCRM Data

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

The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example

Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

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

You can now connect with a connection string. Use the create_engine function to create an Engine for working with SuiteCRM 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("suitecrm:///?URL=")

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

Query SuiteCRM 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("suitecrm:///?URL=") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Accounts).filter_by(Industry="Manufacturing"): print("Name: ", instance.Name) print("Industry: ", instance.Industry) 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

Accounts_table = Accounts.metadata.tables["Accounts"] for instance in session.execute( == "Manufacturing")): print("Name: ", instance.Name) print("Industry: ", instance.Industry) print("---------")

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

Insert SuiteCRM Data

To insert SuiteCRM 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 SuiteCRM.

new_rec = Accounts(Name="placeholder", Industry="Manufacturing") session.add(new_rec) session.commit()

Update SuiteCRM Data

To update SuiteCRM 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 SuiteCRM.

updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Industry = "Manufacturing" session.commit()

Delete SuiteCRM Data

To delete SuiteCRM 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(Accounts).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 SuiteCRM Python Connector to start building Python apps and scripts with connectivity to SuiteCRM data. Reach out to our Support Team if you have any questions.