Learn more
 

Use JayDeBeApi to access Odoo Data in Python


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

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

About Odoo Data Integration

Accessing and integrating live data from Odoo has never been easier with CData. Customers rely on CData connectivity to:

  • Access live data from both Odoo API 8.0+ and Odoo.sh Cloud ERP.
  • Extend the native Odoo features with intelligent handling of many-to-one, one-to-many, and many-to-many data properties. CData's connectivity solutions also intelligently handle complex data properties within Odoo. In addition to columns with simple values like text and dates, there are also columns that contain multiple values on each row. The driver decodes these kinds of values differently, depending upon the type of column the value comes from:
    • Many-to-one columns are references to a single row within another model. Within CData solutions, many-to-one columns are represented as integers, whose value is the ID to which they refer in the other model.
    • Many-to-many columns are references to many rows within another model. Within CData solutions, many-to-many columns are represented as text containing a comma-separated list of integers. Each value in that list is the ID of a row that is being referenced.
    • One-to-many columns are references to many rows within another model - they are similar to many-to-many columns (comma-separated lists of integers), except that each row in the referenced model must belong to only one in the main model.
  • Use SQL stored procedures to call server-side RFCs within Odoo.

Users frequently integrate Odoo with analytics tools such as Power BI and Qlik Sense, and leverage our tools to replicate Odoo data to databases or data warehouses.


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

To connect, set the Url to a valid Odoo site, User and Password to the connection details of the user you are connecting with, and Database to the Odoo database.

Built-in Connection String Designer

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

java -jar cdata.jdbc.odoo.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:odoo:User=MyUser;Password=MyPassword;URL=http://MyOdooSite/;Database=MyDatabase;"

Access Odoo 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.odoo.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 Odoo:

import jaydebeapi #The JDBC connection string jdbc_url = "jdbc:odoo:User=MyUser;Password=MyPassword;URL=http://MyOdooSite/;Database=MyDatabase;" 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.odoo.jar" conn = jaydebeapi.connect( "cdata.jdbc.odoo.OdooDriver", jdbc_url, [username, password], jdbc_driver_jar, ) cursor = conn.cursor() cursor.execute("SELECT * FROM res_users;") 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 Odoo and start working with your live Odoo data in Python. Reach out to our Support Team if you have any questions.

Ready to get started?

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

 Download Now

Learn more:

Odoo Icon Odoo JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Odoo ERP data, including Sales Orders, Purchase Orders, Accounts, and more!

In this article

Related articles