Learn more
 

Ready to get started?

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

 Download Now

Learn more:

OData Icon OData JDBC Driver

Easy-to-use OData client (consumer) enables developers to build Java applications that easily communicate with OData services.

In this article

Related articles

Use JayDeBeApi to access OData Services in Python


Use standard Python scripting and the development environment of your choice to access live OData services.

Access OData services with Python scripts and standard SQL on any machine where Python and Java can be installed. You can use the CData JDBC Driver for OData and the JayDeBeApi module to work with remote OData services 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 OData and visualize OData services 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 OData services in Python using SQL.

The User and Password properties, under the Authentication section, must be set to valid OData user credentials. In addition, you will need to specify a URL to a valid OData server organization root or OData services file.

Built-in Connection String Designer

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

java -jar cdata.jdbc.odata.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:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;"

Access OData services 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.odata.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 OData:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;" 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.odata.jar" conn = jaydebeapi.connect( "cdata.jdbc.odata.jar", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM Orders;") 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 OData and start working with your live OData services in Python. Reach out to our Support Team if you have any questions.