Model Context Protocol (MCP) finally gives AI models a way to access the business data needed to make them really useful at work. CData MCP Servers have the depth and performance to make sure AI has access to all of the answers.
Try them now for free →
Use JayDeBeApi to access Salesforce Data in Python
Use standard Python scripting and the development environment of your choice to access live Salesforce data.
Access Salesforce 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 Salesforce and the JayDeBeApi module to work with remote Salesforce 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 Salesforce and visualize Salesforce data with standard Python.
About Salesforce Data Integration
Accessing and integrating live data from Salesforce has never been easier with CData. Customers rely on CData connectivity to:
- Access to custom entities and fields means Salesforce users get access to all of Salesforce.
- Create atomic and batch update operations.
- Read, write, update, and delete their Salesforce data.
- Leverage the latest Salesforce features and functionalities with support for SOAP API versions 30.0.
- See improved performance based on SOQL support to push complex queries down to Salesforce servers.
- Use SQL stored procedures to perform actions like creating, retrieving, aborting, and deleting jobs, uploading and downloading attachments and documents, and more.
Users frequently integrate Salesforce data with:
- other ERPs, marketing automation, HCMs, and more.
- preferred data tools like Power BI, Tableau, Looker, and more.
- databases and data warehouses.
For more information on how CData solutions work with Salesforce, check out our Salesforce integration page.
Getting Started
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 Salesforce data in Python using SQL.
There are several authentication methods available for connecting to Salesforce: Login, OAuth, and SSO. The Login method requires you to have the username, password, and security token of the user.
If you do not have access to the username and password or do not wish to require them, you can use OAuth authentication.
SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and TokenUrl connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the help documentation for more information.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Salesforce JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.salesforce.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:salesforce:User=username;Password=password;SecurityToken=Your_Security_Token;"
Access Salesforce 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.salesforce.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 Salesforce:
import jaydebeapi
#The JDBC connection string
jdbc_url = "jdbc:salesforce:User=username;Password=password;SecurityToken=Your_Security_Token;"
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.salesforce.jar"
conn = jaydebeapi.connect(
"cdata.jdbc.salesforce.SalesforceDriver",
jdbc_url,
[username, password],
jdbc_driver_jar,
)
cursor = conn.cursor()
cursor.execute("SELECT * FROM Account;")
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 Salesforce and start working with your live Salesforce data in Python. Reach out to our Support Team if you have any questions.
Ready to get started?
Download a free trial of the Salesforce Driver to get started:
Download NowLearn more:
Salesforce JDBC Driver
Rapidly create and deploy powerful Java applications that integrate with Salesforce account data including Leads, Contacts, Opportunities, Accounts, and more!
