Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Hibernate Object/Grid Mapper

branch: master
Octocat-spinner-32 core [maven-release-plugin] prepare for next development iteration April 16, 2014
Octocat-spinner-32 couchdb [maven-release-plugin] prepare for next development iteration April 16, 2014
Octocat-spinner-32 distribution [maven-release-plugin] prepare for next development iteration April 16, 2014
Octocat-spinner-32 documentation [maven-release-plugin] prepare for next development iteration April 16, 2014
Octocat-spinner-32 ehcache [maven-release-plugin] prepare for next development iteration April 16, 2014
Octocat-spinner-32 infinispan [maven-release-plugin] prepare for next development iteration April 16, 2014
Octocat-spinner-32 integrationtest OGM-482 Removing unnecessary dependency April 23, 2014
Octocat-spinner-32 modules [maven-release-plugin] prepare for next development iteration April 16, 2014
Octocat-spinner-32 mongodb [maven-release-plugin] prepare for next development iteration April 16, 2014
Octocat-spinner-32 neo4j [maven-release-plugin] prepare for next development iteration April 16, 2014
Octocat-spinner-32 src OGM-207 Updating copyright year for all files modified in 2014 January 30, 2014
Octocat-spinner-32 .gitattributes OGM-220 Fix remaining wrong line endings July 25, 2012
Octocat-spinner-32 .gitignore Exclude bin/ from tracked git folders July 23, 2012
Octocat-spinner-32 changelog.txt Update changelog and readme.md in preparation of 4.1.0.Beta2 release April 16, 2014
Octocat-spinner-32 license.txt OGM-57 rename licence.txt to license.txt April 29, 2011
Octocat-spinner-32 pom.xml OGM-502 Update configuration of the maven-release-plugin April 23, 2014
Octocat-spinner-32 readme.md Update changelog and readme.md in preparation of 4.1.0.Beta2 release April 16, 2014
Octocat-spinner-32 settings-example.xml OGM-482 Add a profile that downloads and uses EAP for integration tests April 13, 2014
readme.md

Hibernate OGM

Version: 4.1.0.Beta2 - 16 Aprile 2014

Description

Hibernate OGM is an attempt to store data in a NoSQL data grid using the Hibernate ORM engine rather than rewriting a JPA engine from scratch.

The benefits are fairly obvious:

  • reimplementing the complex JPA specification is a lot of work
  • a new implementation would mature at a rather slow rate and risk of bugs would be high
  • Hibernate is familiar to many people

Checkout http://ogm.hibernate.org for more information.

Build instructions

The code is available on GitHub at https://github.com/hibernate/hibernate-ogm.

To run the full project build including tests for all backends, documentation etc. execute:

mvn clean install -s settings-example.xml

Note that for running the test suite against separately installed MongoDB and CouchDB servers their host name must be specified via an environment variable. See the sections below for the details.

To speed things up, there are several options for skipping parts of the build. To run the minimum project build without integration tests, documentation and distribution execute:

mvn clean install -DskipITs -DskipDocs -DskipDistro -s settings-example.xml

The following sections describe these options in more detail.

Integration tests

You can skip integration tests by specifying the skipITs property:

mvn clean install -DskipITs -s settings-example.xml

Documentation

The documentation is built by default as part of the project build. You can skip it by specifying the skipDocs property:

mvn clean install -DskipDocs -s settings-example.xml

If you just want to build the documentation, run it from the documentation/manual subdirectory.

For rapid documentation testing, you can limit the generated format to html to speed up the process

mvn clean install -f documentation/manual/pom.xml -s settings-example.xml -Djdocbook.format=html_single

Distribution

The distribution bundle is built by default as part of the project build. You can skip it by specifying the skipDistro property:

mvn clean install -DskipDistro -s settings-example.xml

Integration tests

Integration tests can be run from the integrationtest module and the default behaviour is to download the WildFly application server, unpack the modules in it and run the tests using Arquillian.

There are two additional profiles that can be used to run the test on JBoss EAP 6 instead. The first one will download EAP 6.1:

mvn clean install -Peap -s settings.xml

The second one will use an existing installation of JBoss EAP 6:

mvn clean install -Deap.home=/home/user/eap_home -s settings.xml

[WARNING]

Be careful when using on existing installation since the modules used by the build are going to be extracted into the

server you want to run the test, changing the original setup.

MongoDB

For executing the tests in the mongodb and integrationtest/mongodb modules, the embedmongo-maven-plugin is used which downloads the MongoDB distribution, extracts it, starts a mongod process and shuts it down after test execution.

If required, you can configure the port to which the MongoDB instance binds to (by default 27018) and the target directory for the extracted binary (defaults to ${project.build.directory}/embeddedMongoDb/extracted) like this:

mvn clean install -s settings-example.xml -DembeddedMongoDbTempDir=<my-temp-dir> -DembeddedMongoDbPort=<my-port>

To work with a separately installed MongoDB instance instead, specify the useExternalMongoDb property:

mvn clean install -s settings-example.xml -DuseExternalMongoDb

This assumes MongoDB to be installed on localhost, using the default port and no authentication. If you work with different settings, configure the required properties in hibernate.properties (for the tests in mongodb) and/or the environment variables MONGODB_HOSTNAME MONGODB_PORT MONGODB_USERNAME MONGODB_PASSWORD (for the tests in integrationtest/mongodb) prior to running the tests:

export MONGODB_HOSTNAME=mongodb-machine
export MONGODB_PORT=1234
export MONGODB_USERNAME=someUsername
export MONGODB_PASSWORD=someP@ssw0rd
mvn clean install -s settings-example.xml

CouchDB

For running the tests in the couchdb module an installed CouchDB server is required. Specify its host name by setting the environment variable COUCHDB_HOSTNAME prior to running the test suite:

export COUCHDB_HOSTNAME=couchdb-machine

If this variable is not set, the couchdb module still will be compiled and packaged but the tests will be skipped.

Contact

Latest Documentation:

http://community.jboss.org/en/hibernate/ogm

Bug Reports:

Hibernate JIRA (preferred): https://hibernate.onjira.com/browse/OGM hibernate-dev@lists.jboss.org

Free Technical Support:

https://forum.hibernate.org/viewforum.php?f=31

Notes

If you want to contribute, come to the hibernate-dev@lists.jboss.org mailing list or join us on #hibernate-dev on freenode (login required)

This software and its documentation are distributed under the terms of the FSF Lesser Gnu Public License (see license.txt).

Something went wrong with that request. Please try again.