Neo4j Spring Boot Starter

A Spring Boot starter with automatic configuration for the Neo4j Java Driver.

Important

This project is now superseded by the automatic configuration in Spring Boot 2.4. Spring Boot 2.4 includes the same means of configuring a standalone Neo4j Driver instance, including the same health checks. There is a dedicated starter for Spring Data Neo4j 6 (formerly known as SDN/RX).

Introduction

This starter provides a convenient way to configure all aspects of the Neo4j-Java-Driver from within a Spring Boot application. It provides a single, managed Spring Bean of type org.neo4j.driver.Driver, configured to your needs.

The starter does not add any additional functionality on top of the driver, but only exposes the drivers configuration in a Spring friendly way. However, it configures the driver to use Springs JCL logging variation by default.

The 4.x.y. line of the starter only supports the 4.x.y line of the Neo4j Java Driver. It is tested and developed against Spring Boot 2.3.12.RELEASE.

The starter supports Neo4j server mode only, that is: A connection against a Neo4j server over the Bolt protocol.

Manual

For a gentle introduction and some getting started guides, please use our Manual. The manual contains descriptions of all examples, which you’ll find in the project source directory under examples.