Jump to: navigation, search

CDO/Hibernate Store

Revision as of 19:05, 21 January 2010 by Mtaal.elver.org (Talk | contribs)

The CDO Hibernate store is a CDO store implemented with Teneo and Hibernate. This combination of tools gives the user/developer the following advantages:

  • Database support: Hibernate provides superior runtime Object Relational Mapping to many different relational databases. We test with mysql and hsqldb but there no known obstacles for using CDO on other databases supported by Hibernate.
  • HQL: the CDO Hibernate store makes it possible to execute HQL queries on the client. The complete HQL syntax is supported (incl. joins, aggregations, functions, etc.).
  • Automatic Model-Relational Mapping: Teneo takes care of automatic mapping of your model to a relation database schema. The relational database schema explicitly implements the domain model. The automatic mapping can be manually overridden using JPA annotations in the model or in a separate XML file. Basically all JPA annotations (and several Hibernate extensions) are supported.

The CDO Hibernate store is focused on creating a readable, sensible, practical and performant relational database schema. The store is especially suited for data oriented business administrative (ERP-like) applications with a RCP interface.


The documentation for the CDO Hibernate Store consists of the following sections.

  • Quick start: in just a few steps you have an up-and-running CDO server with Hibernate and automatic mapping using Teneo.
  • Architecture: describes how the different components of the store operate together.
  • Download and install: lists the required plugins and their download locations. In addition the examples projects used in the tutorials are specified (with their cvs location).
  • Configuration: discusses the setup and configuration of the CDO Hibernate store (database, launch configuration, model, etc.). The description is supported by an example Eclipse project which is available in cvs.
  • Tutorial: gives a quick intro in how to connect from a client to the CDO Hibernate datastore. This tutorial illustrates that for a standard usage there is no difference in using a CDO Hibernate store compared to other stores. A downloadable Example Eclipse project is used to give the reader a good start. The examples use junit testcases on the client to facilitate easy testing and debugging.
  • Hibernate Query Language (HQL) support: several examples of HQL queries, ranging from very simple to queries with functions and array results. The example queries can be run directly using a provided Eclipse project.
  • Model relational mapping page describes how the generated model-relational mapping can be extended and overridden using JPA annotations in the model. The same example Eclipse project as in previous steps is used to illustrate the functions and features.
  • Trouble shooting: when you encounter specific CDO Hibernate issues. For remaining questions visit the EMF newsgroup.


The Hibernate store is build and distributed as part of CDO 3.0. CDO 3.0 is the CDO release for the Eclipse 3.6 (Helios) release. The Hibernate Store works with this software:

  • Eclipse 3.6 (Helios)
  • EMF 2.6
  • CDO 3.0
  • Hibernate 3.3.2 or later
  • Teneo 1.2.0

Visit the download page to download the required dependencies.

Plugins and CVS

The CDO Hibernate Store can be found in cvs in the following location:

  • dev.eclipse.org
  • /cvsroot/modeling
  • main path: org.eclipse.emf/org.eclipse.emf.cdo/hibernate

The functionality is implemented in the following plugins (the other plugins/projects in the same cvs location can be ignored):

  • org.eclipse.emf.cdo.server.hibernate: implements the CDO Hibernate Store itself
  • org.eclipse.emf.cdo.server.hibernate.teneo: integrates Teneo with the CDO Hibernate Store, takes care of calling Teneo to generate the mapping
  • org.eclipse.emf.cdo.test.hibernate: contains the Hibernate specific parts of the cdo tests. This plugin extends the org.eclipse.emf.cdo.tests plugin

The documentation makes use of three projects (used in the documentation) in the org.eclipse.emf/org.eclipse.emf.cdo/examples folder:

  • org.eclipse.emf.cdo.examples.company: contains the test model which has been enabled for use with CDO
  • org.eclipse.emf.cdo.examples.hibernate.server: contains server configuration and a launch configuration
  • org.eclipse.emf.cdo.examples.hibernate.client: contains several test cases showing how a client can create data and query for data in a remote CDO server.

Supported Functions and Features

Currently the CDO Hibernate Store successfully passes 540 out of a total of about 580 testcases. The 40 remaining testcases are related to functions and features not (yet) supported by the CDO Hibernate store (see below).

The CDO Hibernate Store supports the main CDO features except for the following:

  • auditing and revisions: this topic is being researched. Support for auditing as it is currently implemented in CDO implies that there are no foreign key constraints in the database. This has to be matched with the focus of the CDO Hibernate store on supporting more traditional ERP/Business Administration applications.
  • XATransactions: xatransactions are not tested well and not all test cases pass currently

Wikis: CDO | Net4j | EMF | Eclipse