Skip to content

Getting Started

Wolfgang Schuetzelhofer edited this page Feb 28, 2019 · 19 revisions
Previous Next Table of Contents

Getting Started

JCypher binaries and sources are available on maven central. You can simply add the dependencies to JCypher to your project's pom.xml (in case you build your project with maven).


You also have two other options to start using JCypher. You can either clone the JCypher Git repository from: (this is the master (trunk), which is not guaranteed to be in a stable and consistent state. You are encouraged to switch to a Tag (e.g. 4.2.0). Alternatively you can download a JCypher build in form of a .jar file from the releases page: Sources are also provided at the releases page.

There is a distinct samples project which provides samples for JCypher. This is a good starting point to begin working and experimenting with JCypher. Please have a look at:

Note: JCypher 4.2.0 was adapted for Neo4j 3.5.x and tested against Neo4j 3.5.2.
(JCypher 4.1.1, 4.1.0, 4.0.1 and 4.0.0 were developed and tested with Neo4j 3.4.1).
(JCypher 3.9.0 was developed and tested with Neo4j 3.3.1).
(JCypher 3.8.0 was developed and tested with Neo4j 3.2.2).
(Release 3.7.0 was developed and tested with Neo4j release 3.1.1, JCypher releases 3.5.0 and 3.6.0 with Neo4j release 3.0.3).
Release 3.4.1 was developed and tested with Neo4j 2.3.2 (support for Neo4j 2.2.x started with release 2.6.0).

If you want to use Neo4j 2.1.6 or 2.1.7 you have to do the following:

  • When working with a remote database (using DBType.REMOTE when creating an IDBAccess), you have to set the static property DBVersion.Neo4j_Version = "2.1.x"; (the default is now "3.0.x") prior to calling DBAccessFactory.createDBAccess(...).
    This setting however is valid for your entire application instance (you will not be able to mix 2.2.x and 2.1.x access within one application instance).
    (If mixed acces should become an important requirement for you, please email me, and I will make appropriate code changes in one of the upcoming releases).
  • When working with an embedded database (using DBType.EMBEDDED when creating an IDBAccess), you have to use JCypher 2.5.0 or before.
  • You can use in-memory databases just like before (nothing to consider here).

Previous Next Table of Contents