-
Notifications
You must be signed in to change notification settings - Fork 166
Versions
Those are all combinations:
| Neo4j-OGM | Neo4j Java Driver | Neo4j |
|---|---|---|
| Supported versions | ||
| 4.0.x | >=5.0.0 | 4.4.x4, 5.x |
| 3.2.x+ | >=4.0.0 | 3.3.x, 3.4.x, 3.5.x, 4.0, 4.11, 4.21, 4.3 3, 4.4 3 |
| No further development or support | ||
| 3.1.x | 1.6.x, 1.7.x | 3.2.x, 3.3.x, 3.4.x, 3.5.x |
| 3.0.x | 1.5.x, 1.6.x | 3.0.x, 3.1.x, 3.2.x, 3.3.x, 3.4.x |
| 2.1.x | 1.2.3 | 2.3.x2, 3.0.x, 3.1.x |
| 2.0.x | 1.0.6 | 2.3.x2, 3.0.x |
- 1 Only with 4.1 Neo4j Java Driver
- 2 Embedded
- 3 Neo4j-OGM 3.2.24+ only
- 4 Technical working but not officially supported
OGM 3.2.x is API compatible with Spring Data Neo4j 5.1 (Lovelace) and can serve as a drop in by setting <neo4j-ogm.version>3.2.x</version.properties> in the build description of your Spring Boot application
We offer the neo4j-java-driver-spring-boot-starter. This Spring Boot module offers all the properties of the Java / Bolt driver and exposes an instance of the driver as a bean explicitly, without enforcing OGM onto your application. It is however compatible with OGM.
You might combine the following versions:
| neo4j-java-driver-spring-boot-starter | Spring Boot | Neo4j Java Driver | Neo4j-OGM |
|---|---|---|---|
| 4.1.1.x | 2.3.x | >=4.1.1 | >=3.2.3 |
| 4.0.3.x | 2.3.x | >=4.0.1 | >=3.2.3 |
| 4.0.1.x | 2.2.x | >=4.0.1 | >=3.2.3 |
| 4.0.0.x | 2.2.x | >=4.0.0 | >=3.2.3 |
| 1.7.5.1 | 2.1.x | 1.7.x | 3.1.x |
The starter offers integration with Spring Boot health for both 1.7.x and 4.0.0 drivers and Micrometer integration for 4.0.0 drivers.
Neo4j-OGM does the main work for Spring Data Neo4j (SDN) up to and including version 5.3. Since version 6.0 of SDN there is no dependency to Neo4j-OGM anymore. Please note that the all SDN 5.x and previous versions are out of support. For the archive, the following versions were bundled together:
| Neo4j-OGM | Spring Data Neo4j | Spring Boot | Neo4j Java Driver | Neo4j |
|---|---|---|---|---|
| 3.2.24+ | 5.3.x (Neumann) | 2.3.x | >=4.0.0 | 3.5.x, 4.0, 4.1, 4.2, 4.3, 4.4 |
| 3.2.24+ | 5.2.x (Moore) | 2.2.x | >=4.0.0 | 3.5.x, 4.0, 4.1, 4.2, 4.3, 4.4 |
| 3.1.22 | 5.1.x (Lovelace) | 2.1.x | 1.7.x | 3.4.x |
| 3.0.x | 5.0.x (Kay) | 2.0.x | 1.6.x | 3.3.x |
IMPORTANT: Starting Neo4j embedded from OGM and using embedded API is only supported up and including to Neo4j 3.5. If you need an embedded 4.0 database in your application, create it as a standard bean and open up a local bolt socket connection using our Neo4j Java Driver against it.
Neo4j-OGM offers the embedded mode and starts an embedded instance for you. This is comfortable during development and also in deployment. But bare in mind that you bind yourself with the database version very closely not only to your Object graph mapping framework, but also to your application framework. For example, if you started a Spring Boot application based on OGM embedded 2.1.x and database 3.1, you cannot simply exchange the database dependencies or OGM dependencies to go to something higher than database 3.1, as the mentioned components are inter dependend.
If you really want to run an embedded database in production, you should consider providing the database bean yourself and explicitly open the embedded databases bolt port and use the OGM bolt transport.