Learn more
 

Ready to get started?

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

 Download Now

Learn more:

SuiteCRM Icon SuiteCRM JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SuiteCRM account data including Leads, Contacts, Opportunities, Accounts, and more!

In this article

Related articles

Use JayDeBeApi to access SuiteCRM Data in Python


Use standard Python scripting and the development environment of your choice to access live SuiteCRM data.

Access SuiteCRM data with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for SuiteCRM and the JayDeBeApi module to work with remote SuiteCRM data in Python. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular Python language. This article shows how to use the driver to execute SQL queries to SuiteCRM and visualize SuiteCRM data with standard Python.

Use the JayDeBeApi module

JayDeBeApi is a Python library that serves as a JDBC (Java Database Connectivity) bridge, allowing Python programs to interact with Java databases, including CData JDBC Drivers. Use the pip install command to install the module:

pip install JayDeBeApi

Create the JDBC URL

Once you have JayDeBeApi installed, you are ready to work with SuiteCRM data in Python using SQL.

The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example http://suite.crm.com.

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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the SuiteCRM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.suitecrm.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a sample variable assignment, including a typical JDBC connection string:

jdbc_url = "jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;"

Access SuiteCRM data in Python

With the JDBC URL configured, you only need the absolute path to the JDBC driver JAR file, which is in the "lib" folder in the installation directory ("C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.suitecrm.jar" on Windows).

NOTE: If you haven't already, set the JAVA_HOME environment variable to the Java installation directory.

Use code similar to the follow to read and print data from SuiteCRM:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;" username = "****" password = "****" #The absolute Path to the JDBC driver JAR file, typically: jdbc_driver_jar = "C:\Program Files\CData[product_name] 20XX\lib\cdata.jdbc.suitecrm.jar" conn = jaydebeapi.connect( "cdata.jdbc.suitecrm.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Accounts;") results = cursor.fetchall() for row in results: print(row) cursor.close() conn.close()

Free trial & more information

Download a free, 30-day trial of the CData JDBC Driver for SuiteCRM and start working with your live SuiteCRM data in Python. Reach out to our Support Team if you have any questions.