Vert.x Neo4j client

The Vert.x Neo4j client is an extension for interacting with Neo4j.

The client is built on top of official Neo4j Java Driver.

WARNING: This module has Tech Preview status, this means the API can change between versions.

Version compatibility matrix

Project	Vert.x	Neo4j Java Driver
0.3.0	3.9.0	4.0.0

At the moment, tests have been performed only on Neo4j Server 3.5.x. Neo4j Server 4.0 should be supported soon.

Javadoc

The Javadoc.

Install

Using maven:

<dependency>
    <groupId>io.reactiverse</groupId>
    <artifactId>neo4j-client</artifactId>
    <version>0.3.0</version>
</dependency>

Using Gradle:

implementation("io.reactiverse:neo4j-client:0.3.0")

Sample usage

Initialize the client:

Neo4jClientOptions options = new Neo4jClientOptions().setHost("localhost").setPort(7687);
Neo4jClient neo4jClient = Neo4jClient.createShared(vertx, options);

Here is a sample usage with Java API where we ask to retrieve a list of friends:

neo4jClient.find("MATCH (you {name:'You'})-[:FRIEND]->(yourFriends) RETURN yourFriends", find -> {
    if (find.succeeded()) {
        List<Record> result = find.result();
        // handle result
    } else {
        Throwable error = find.cause();
        // handle error
    }
});

And here is the RxJava 2 API equivalent:

neo4jClient
    .rxFind("MATCH (you {name:'You'})-[:FRIEND]->(yourFriends) RETURN yourFriends")
    .subscribe(result -> {
        // handle result
    }, error -> {
        // handle error
    });

Running tests in IntelliJ Idea

Before running tests directly in Intellij Idea, please, ensure you have disabled passing JUnit argLine setting at Build, Execution, Deployment > Build Tools > Maven > Running Tests:

Legal

Originally developed by Olympe S.A.

Copyright (c) 2018-2020 Olympe S.A.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.