Learn more
 

Create a Data Access Object for Odoo Data using JDBI


A brief overview of creating a SQL Object API for Odoo data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Odoo integrates connectivity to live Odoo data in Java applications. By pairing these technologies, you gain simple, programmatic access to Odoo data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Odoo data.

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


Create a DAO for the Odoo res_users Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface Myres_usersDAO { //insert new data into Odoo @SqlUpdate("INSERT INTO res_users (id, email) values (:id, :email)") void insert(@Bind("id") String id, @Bind("email") String email); //request specific data from Odoo (String type is used for simplicity) @SqlQuery("SELECT email FROM res_users WHERE id = :id") String findemailByid(@Bind("id") String id); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Odoo

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Odoo.

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.

A connection string for Odoo will typically look like the following:

jdbc:odoo:User=MyUser;Password=MyPassword;URL=http://MyOdooSite/;Database=MyDatabase;

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:odoo:User=MyUser;Password=MyPassword;URL=http://MyOdooSite/;Database=MyDatabase;"); Myres_usersDAO dao = dbi.open(Myres_usersDAO.class); //do stuff with the DAO dao.close();

Read Odoo Data

With the connection open to Odoo, simply call the previously defined method to retrieve data from the res_users entity in Odoo.

//disply the result of our 'find' method String email = dao.findemailByid("1"); System.out.println(email);

Write Odoo Data

It is also simple to write data to Odoo, using the previously defined method.

//add a new entry to the res_users entity dao.insert(newid, newemail);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Odoo by integrating with the CData JDBC Driver for Odoo. Download a free trial and work with live Odoo data in custom Java applications today.

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