Awesome

Hibernate OGM

Version: 5.4.2.Final - 2024-09-24

Description

Hibernate OGM stores data in a NoSQL data grid using the Hibernate ORM engine.

The benefits are fairly obvious:

• write your model once using well known JPA annotations and select the right NoSQL data grid for your project
• Hibernate is familiar to many people
• you end up being able to use all the tools of the Hibernate ecosystem such as Hibernate Search or Hibernate Validator

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

Core datastores and contrib datastores

Hibernate OGM supports a large number of NoSQL datastores.

Some are included in this very repository:

• Infinispan
• MongoDB
• Neo4j

Others are in separate repositories, called contrib:

• Cassandra
• CouchDB
• Ehcache
• Redis
• Ignite

Useful pointers

Latest Documentation:

• Reference guide: https://docs.jboss.org/hibernate/stable/ogm/reference/en-US/html_single/
• Additional content: http://community.jboss.org/en/hibernate/ogm

Bug Reports:

• Hibernate JIRA (preferred): https://hibernate.atlassian.net/projects/OGM/
• Mailing list: hibernate-dev@lists.jboss.org

Support:

• The hibernate-ogm tag on Stackoverflow: http://stackoverflow.com/questions/tagged/hibernate-ogm
• Our forum: https://discourse.hibernate.org/c/hibernate-ogm

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

Note that for running the test suite against separately installed MongoDB or Neo4j 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

The following sections describe these options in more detail.

Importing sources in Eclipse

Import the project as any standard Maven project. This might trigger a dialog to automatically find and install additional m2e plugins: allow that.

Make sure that annotation processing is enabled in your project settings (see "Properties" - "Maven" - "Annotation Processing", the setting should be "Automatically configure JDT APT").

Integration tests

You can skip integration tests by specifying the skipITs property:

mvn clean install -DskipITs

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

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

By default, the following command only builds the HTML version of the documentation:

mvn clean install -f documentation/manual/pom.xml

If you also wish to generate the PDF version of the documentation, you need to use the documentation-pdf profile:

mvn clean install -f documentation/manual/pom.xml -Pdocumentation-pdf

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

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.

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, by default 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 -DembeddedMongoDbTempDir=<my-temp-dir> -DembeddedMongoDbPort=<my-port>

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

mvn clean install -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 -DuseExternalMongoDb

Neo4j

For running the tests in the neo4j and integrationtest/neo4j modules, by default the embedded Neo4j configuration is used.

Hibernate OGM can connect to a Neo4j server remotely via the Bolt protocol or via HTTP. These tests are not executed by default, you can run them using the following commands:

mvn clean install -Pneo4j-http

or

mvn clean install -Pneo4j-bolt

This assumes Neo4j 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 and/or the environment variables NEO4J_HOSTNAME, NEO4J_PORT, NEO4J_USERNAME and NEO4J_PASSWORD prior to running the tests:

export NEO4J_HOSTNAME=neo4j-machine
export NEO4J_PORT=1234
export NEO4J_USERNAME=someUsername
export NEO4J_PASSWORD=someP@ssw0rd

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).