Use JayDeBeApi to access Salesforce Marketing Data in Python

Access Salesforce Marketing 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 Marketing Cloud and the JayDeBeApi module to work with remote Salesforce Marketing 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 Marketing and visualize Salesforce Marketing 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 Salesforce Marketing data in Python using SQL.

Authenticating to the Salesforce Marketing Cloud APIs

Set the and to your login credentials, or to the credentials for a sandbox user if you are connecting to a sandbox account.

Connecting to the Salesforce Marketing Cloud APIs

By default, the data provider connects to production environments. Set to true to use a Salesforce Marketing Cloud sandbox account.

The default Instance is s7 of the Web Services API; however, if you use a different instance, you can set .

Built-in Connection String Designer

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

java -jar cdata.jdbc.sfmarketingcloud.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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

jdbc_url = "jdbc:sfmarketingcloud:User=myUser;Password=myPassword;InitiateOAuth=GETANDREFRESH;"

Access Salesforce Marketing 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.sfmarketingcloud.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 Marketing:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:sfmarketingcloud:User=myUser;Password=myPassword;InitiateOAuth=GETANDREFRESH;"

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.sfmarketingcloud.jar"

conn = jaydebeapi.connect(
 "cdata.jdbc.sfmarketingcloud.SFMarketingCloudDriver",
 jdbc_url,
 [username, password],
 jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Subscriber;")


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 Marketing Cloud and start working with your live Salesforce Marketing data in Python. Reach out to our Support Team if you have any questions.