Use JayDeBeApi to access SAP Data in Python

Access SAP 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 SAP ERP and the JayDeBeApi module to work with remote SAP 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 SAP and visualize SAP data with standard Python.

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 SAP data in Python using SQL.

The driver supports connecting to an SAP system using the SAP Java Connector (SAP JCo). Install the files (sapjco3.jar and sapjco3.dll) to the appropriate directory for the hosting application or platform. See the "Getting Started" chapter in the help documentation for information on using the SAP JCo files.

In addition, you can connect to an SAP system using Web services (SOAP). To use Web services, you must enable SOAP access to your SAP system and set the Client, RFCUrl, User, and Password properties, under the Authentication section.

For more information, see this guide on obtaining the connection properties needed to connect to any SAP system.

Built-in Connection String Designer

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

java -jar cdata.jdbc.saperp.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:saperp:Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;Location=C:/mysapschemafolder;"

Access SAP 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.saperp.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 SAP:

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:saperp:Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;Location=C:/mysapschemafolder;"

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

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

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


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