You can start coding with some simple templates, or just follow the little guide below!

Dependencies for Neo4j-OGM

<dependency>
    <groupId>org.neo4j</groupId>
    <artifactId>neo4j-ogm-core</artifactId>
    <version>3.2.20</version>
</dependency>

<dependency> <!-- If you're using the HTTP driver -->
    <groupId>org.neo4j</groupId>
    <artifactId>neo4j-ogm-http-driver</artifactId>
    <version>3.2.20</version>
</dependency>

<dependency> <!-- If you're using the Bolt driver -->
    <groupId>org.neo4j</groupId>
    <artifactId>neo4j-ogm-bolt-driver</artifactId>
    <version>3.2.20</version>
</dependency>

<dependency> <!-- If you're using the Embedded driver -->
    <groupId>org.neo4j</groupId>
    <artifactId>neo4j-ogm-embedded-driver</artifactId>
    <version>3.2.20</version>
</dependency>

dependencies {
    compile 'org.neo4j:neo4j-ogm-core:3.2.20'
    compile 'org.neo4j:neo4j-ogm-http-driver:3.2.20'
    compile 'org.neo4j:neo4j-ogm-bolt-driver:3.2.20'
    compile 'org.neo4j:neo4j-ogm-embedded-driver:3.2.20'
}

<dependency org="org.neo4j" name="neo4j-ogm-core" rev="3.2.20"/>
<dependency org="org.neo4j" name="neo4j-ogm-http-driver" rev="3.2.20"/>
<dependency org="org.neo4j" name="neo4j-ogm-bolt-driver" rev="3.2.20"/>
<dependency org="org.neo4j" name="neo4j-ogm-embedded-driver" rev="3.2.20"/>

Set up domain entities

@NodeEntity
public class Actor {

	@Id @GeneratedValue
	private Long id;
	private String name;

	@Relationship(type = "ACTS_IN", direction = Relationship.OUTGOING)
	private Set<Movie> movies = new HashSet<>();

	public Actor() {
	}

	public Actor(String name) {
		this.name = name;
	}

	public void actsIn(Movie movie) {
		movies.add(movie);
		movie.getActors().add(this);
	}
}

@NodeEntity
public class Movie {

	@Id @GeneratedValue
	private Long id;
	private String title;
	private int released;

	@Relationship(type = "ACTS_IN", direction = Relationship.INCOMING)
	Set<Actor> actors = new HashSet<>();

	public Movie() {
	}

	public Movie(String title, int year) {
		this.title = title;
		this.released = year;
	}

}

Configuration

Persist/Load entities

//Set up the Session
SessionFactory sessionFactory = new SessionFactory(configuration, "movies.domain");
Session session = sessionFactory.openSession();

Movie movie = new Movie("The Matrix", 1999);

Actor keanu = new Actor("Keanu Reeves");
keanu.actsIn(movie);

Actor carrie = new Actor("Carrie-Ann Moss");
carrie.actsIn(movie);

//Persist the movie. This persists the actors as well.
session.save(movie);

//Load a movie
Movie matrix = session.load(Movie.class, movie.getId());
for(Actor actor : matrix.getActors()) {
    System.out.println("Actor: " + actor.getName());
}

The reference guide is the best place to get started.

Feel free to chat with us on the Neo4j-OGM Slack channel, and have a look to some examples like Neo4j-OGM University.

You can also post questions in our community forums or on StackOverflow.

To use the latest development version, just clone this repository and run mvn clean install.

The tests default to Bolt. If you want to change this, you have to define the property ogm.properties when calling Maven. e.g. ./mvnw clean verify -Dogm.properties=ogm-http.properties to use the HTTP transport. Possible values are ogm-bolt.properties, ogm-http.properties and ogm-embedded.properties.

For tests we are using TestContainers. The default image right now is neo4j:3.5.12. If you want to use other images or the enterprise edition, you have to opt-in.

Here is a list of the possible environment variables you can provide.

If you are using embedded-based tests, the TestContainers values are ignored. To switch between various Neo4j versions for embedded, you have to select the right profile. neo4j-3.2 - neo4j-3.5 and neo4j-enterprise or neo4j-3.5-enterprise if you want to test against the enterprise versions.

We would like to thank YourKit for providing us a license for their product, which helps us to make OGM better.

YourKit supports open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.

Neo4j-OGM and it’s modules are licensed under the Apache License v 2.0.

The only exception is the neo4j-embedded-driver which is GPL v3 due to the direct use of the Neo4j Java API.