https://github.com/reactiverse/neo4j-client

A reactive client for Neo4J
https://github.com/reactiverse/neo4j-client

neo4j neo4j-client reactive vertx

Last synced: 2 months ago
JSON representation

A reactive client for Neo4J

• Host: GitHub
• URL: https://github.com/reactiverse/neo4j-client
• Owner: reactiverse
• License: apache-2.0
• Created: 2020-03-19T15:26:35.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-01-04T16:40:36.000Z (almost 3 years ago)
• Last Synced: 2024-09-27T21:41:53.975Z (3 months ago)
• Topics: neo4j, neo4j-client, reactive, vertx
• Language: Java
• Size: 294 KB
• Stars: 6
• Watchers: 5
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/reactiverse/neo4j-client.svg?branch=master)](https://travis-ci.org/github/reactiverse/neo4j-client)

# Vert.x Neo4j client

The Vert.x Neo4j client is an extension for interacting with [Neo4j](https://neo4j.com/neo4j-graph-database/).

The client is built on top of official [Neo4j Java Driver](https://github.com/neo4j/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](./javadoc/index.html).

## Install

Using maven:

```

    io.reactiverse

    neo4j-client

    0.3.0

```

Using Gradle:

```

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

```

## Sample usage

Initialize the client:

```java

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:

```java

neo4jClient.find("MATCH (you {name:'You'})-[:FRIEND]->(yourFriends) RETURN yourFriends", find -> {

    if (find.succeeded()) {

        List result = find.result();

        // handle result

    } else {

        Throwable error = find.cause();

        // handle error

    }

});

```

And here is the RxJava 2 API equivalent:

```java

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**:

![image](https://user-images.githubusercontent.com/16746106/71311902-9206b080-2435-11ea-8278-b249e0c7a22b.png)

## Legal

Originally developed by [Olympe S.A.](https://olympe.ch/)

    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.