|
5 | 5 | :com-neo4j-dbms-api-EnterpriseDatabaseManagementServiceBuilder: {neo4j-javadocs-base-uri}/com/neo4j/dbms/api/EnterpriseDatabaseManagementServiceBuilder.html |
6 | 6 | :com-neo4j-dbms-api-ClusterDatabaseManagementServiceBuilder: {neo4j-javadocs-base-uri}/com/neo4j/dbms/api/ClusterDatabaseManagementServiceBuilder.html |
7 | 7 |
|
8 | | - |
9 | 8 | [[java-embedded-setup]] |
10 | 9 | = Embedding Neo4j in your Java application |
11 | 10 |
|
12 | 11 | After selecting the appropriate <<editions,edition>> for your platform, you can embed Neo4j in your Java application by including the Neo4j library JARs in your build. |
13 | 12 | The following sections show how to do this by either altering the build path directly or by using dependency management. |
14 | 13 |
|
15 | | - |
16 | | -== Adding Neo4j to the build path |
17 | | - |
18 | | -Get the Neo4j libraries from one of these sources: |
19 | | - |
20 | | -* Extract a link:https://neo4j.com/download/other-releases/#releases[Neo4j zip/tarball^], and use the JAR files found in the _lib/_ directory. |
21 | | -* Use the JAR files available from link:http://search.maven.org/#search|ga|1|g%3A%22org.neo4j%22[Maven Central Repository^]. |
22 | | - |
23 | | -Add the JAR files to your project: |
24 | | - |
25 | | -JDK tools:: |
26 | | - Append to `-classpath` |
27 | | -Eclipse:: |
28 | | - * Right-click on the project and then go to _Build Path -> Configure Build Path_. |
29 | | - In the dialog, select _Add External JARs_, browse the Neo4j _lib/_ directory, and select all the JAR files. |
30 | | - * Another option is to use link:http://help.eclipse.org/indigo/index.jsp?topic=/org.eclipse.jdt.doc.user/reference/preferences/java/buildpath/ref-preferences-user-libraries.htm[User Libraries^]. |
31 | | -IntelliJ IDEA:: |
32 | | - See link:http://www.jetbrains.com/help/idea/2016.1/configuring-project-and-global-libraries.html[Libraries, Global Libraries, and the Configure Library dialog^]. |
33 | | -NetBeans:: |
34 | | - * Right-click on the _Libraries_ node of the project, select _Add JAR/Folder_, browse the Neo4j _lib/_ directory and select all the JAR files. |
35 | | - * You can also handle libraries from the project node, see link:http://netbeans.org/kb/docs/java/project-setup.html#projects-classpath[Managing a Project's Classpath^]. |
36 | | - |
37 | | - |
38 | | -[[editions]] |
39 | | -== Editions |
40 | | - |
41 | | -The following table outlines the available editions and their names for use with dependency management tools. |
42 | | - |
43 | | -[TIP] |
44 | | -==== |
45 | | -Follow the links in the table for details on dependency configuration with Apache Maven, Apache Buildr, Apache Ivy, Groovy Grape, Grails, and Scala SBT. |
46 | | -==== |
47 | | - |
48 | | -.Neo4j editions |
49 | | -[cols="<20,<30,<50", options="header"] |
50 | | -|=== |
51 | | - |
52 | | -| Neo4j Edition |
53 | | -| Dependency |
54 | | -| Description |
55 | | - |
56 | | -| Community |
57 | | -| link:http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.neo4j%22%20AND%20a%3A%22neo4j%22[org.neo4j:neo4j^] |
58 | | -| A high-performance, fully ACID transactional graph database. |
59 | | - |
60 | | -| Enterprise |
61 | | -| link:http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.neo4j%22%20AND%20a%3A%22neo4j-enterprise%22[org.neo4j:neo4j-enterprise^] |
62 | | -| Adding advanced monitoring, online backup, and clustering. |
63 | | - |
64 | | -|=== |
65 | | - |
66 | | -Note that the listed dependencies do not contain the implementation, but pull it transitively. |
67 | | - |
68 | | -For information regarding licensing, see the link:https://neo4j.com/licensing[Licensing Guide^]. |
69 | | - |
70 | | -Javadocs can be downloaded in JAR files from Maven Central or read in link:{neo4j-javadocs-base-uri}/[Neo4j Javadocs^]. |
71 | | - |
72 | | - |
73 | 14 | == Adding Neo4j as a dependency |
74 | 15 |
|
75 | 16 | You can either go with the top-level artifact or include the individual components directly. |
@@ -334,3 +275,59 @@ The database has to already exist in this case. |
334 | 275 | ==== |
335 | 276 | Concurrent access to the same database files by multiple (read-only or write) instances is not supported. |
336 | 277 | ==== |
| 278 | + |
| 279 | +== Adding Neo4j to the build path |
| 280 | + |
| 281 | +Get the Neo4j libraries from one of these sources: |
| 282 | + |
| 283 | +* Extract a link:https://neo4j.com/download/other-releases/#releases[Neo4j zip/tarball^], and use the JAR files found in the _lib/_ directory. |
| 284 | +* Use the JAR files available from link:http://search.maven.org/#search|ga|1|g%3A%22org.neo4j%22[Maven Central Repository^]. |
| 285 | + |
| 286 | +Add the JAR files to your project: |
| 287 | + |
| 288 | +JDK tools:: |
| 289 | + Append to `-classpath` |
| 290 | +Eclipse:: |
| 291 | + * Right-click on the project and then go to _Build Path -> Configure Build Path_. |
| 292 | + In the dialog, select _Add External JARs_, browse the Neo4j _lib/_ directory, and select all the JAR files. |
| 293 | + * Another option is to use link:http://help.eclipse.org/indigo/index.jsp?topic=/org.eclipse.jdt.doc.user/reference/preferences/java/buildpath/ref-preferences-user-libraries.htm[User Libraries^]. |
| 294 | +IntelliJ IDEA:: |
| 295 | + See link:http://www.jetbrains.com/help/idea/2016.1/configuring-project-and-global-libraries.html[Libraries, Global Libraries, and the Configure Library dialog^]. |
| 296 | +NetBeans:: |
| 297 | + * Right-click on the _Libraries_ node of the project, select _Add JAR/Folder_, browse the Neo4j _lib/_ directory and select all the JAR files. |
| 298 | + * You can also handle libraries from the project node, see link:http://netbeans.org/kb/docs/java/project-setup.html#projects-classpath[Managing a Project's Classpath^]. |
| 299 | + |
| 300 | + |
| 301 | +[[editions]] |
| 302 | +== Editions |
| 303 | + |
| 304 | +The following table outlines the available editions and their names for use with dependency management tools. |
| 305 | + |
| 306 | +[TIP] |
| 307 | +==== |
| 308 | +Follow the links in the table for details on dependency configuration with Apache Maven, Apache Buildr, Apache Ivy, Groovy Grape, Grails, and Scala SBT. |
| 309 | +==== |
| 310 | + |
| 311 | +.Neo4j editions |
| 312 | +[cols="<20,<30,<50", options="header"] |
| 313 | +|=== |
| 314 | + |
| 315 | +| Neo4j Edition |
| 316 | +| Dependency |
| 317 | +| Description |
| 318 | + |
| 319 | +| Community |
| 320 | +| link:http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.neo4j%22%20AND%20a%3A%22neo4j%22[org.neo4j:neo4j^] |
| 321 | +| A high-performance, fully ACID transactional graph database. |
| 322 | + |
| 323 | +| Enterprise |
| 324 | +| link:http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.neo4j%22%20AND%20a%3A%22neo4j-enterprise%22[org.neo4j:neo4j-enterprise^] |
| 325 | +| Adding advanced monitoring, online backup, and clustering. |
| 326 | + |
| 327 | +|=== |
| 328 | + |
| 329 | +Note that the listed dependencies do not contain the implementation, but pull it transitively. |
| 330 | + |
| 331 | +For information regarding licensing, see the link:https://neo4j.com/licensing[Licensing Guide^]. |
| 332 | + |
| 333 | +Javadocs can be downloaded in JAR files from Maven Central or read in link:{neo4j-javadocs-base-uri}/[Neo4j Javadocs^]. |
0 commit comments