Ready to get started?

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

 Download Now

Learn more:

Sugar Icon Sugar Python Connector

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

How to use SQLAlchemy ORM to access Sugar CRM Data in Python

Create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Sugar CRM data.

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

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

Connecting to Sugar CRM Data

Connecting to Sugar CRM 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, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

Additionally, specify the URL to the SugarCRM account.

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

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

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Sugar CRM 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("sugarcrm:///?User=MyUser&Password=MyPassword&URL=MySugarCRMAccountURL&CacheMetadata=True")

Declare a Mapping Class for Sugar CRM 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) AnnualRevenue = Column(String) ...

Query Sugar CRM 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("sugarcrm:///?User=MyUser&Password=MyPassword&URL=MySugarCRMAccountURL&CacheMetadata=True") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Accounts).filter_by(Name="Bob"): print("Name: ", instance.Name) print("AnnualRevenue: ", instance.AnnualRevenue) 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( == "Bob")): print("Name: ", instance.Name) print("AnnualRevenue: ", instance.AnnualRevenue) print("---------")

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

Insert Sugar CRM Data

To insert Sugar CRM 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 Sugar CRM.

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

Update Sugar CRM Data

To update Sugar CRM 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 Sugar CRM.

updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.Name = "Bob" session.commit()

Delete Sugar CRM Data

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