Neo4J Clojure client

Neo4clj is an idiomatic Clojure client, exclusively using Bolt for performance.

Installation

Add the following dependency to project.clj:

Getting started

(require '[neo4clj.client :as client])

;; Create a connection to the Neo4j server
(def connection
  (client/connect "bolt://localhost:7687" "neo4j" "password"))

;; Create a new node on the connected server and return it
(client/create-node
  connection
  {:ref-id "N"
   :labels [:person]
   :props {:first-name "Thomas"
           :last-name "Anderson"}})

;; Close the connection to the Neo4J server
(client/disconnect connection)

Clojure representations

Neo4clj uses Clojure maps to represent Nodes and Relationships. To learn more please see Clojure Representations

Examples

To learn more about how to use Neo4clj please take a look at our examples

Supported Features

Neo4clj supports the following features via the Bolt Protocol:

• Cypher queries
• Sessions
• Transactions

Neo4clj also supports the following operations through idiomatic functions:

• Create, read, update and delete nodes
• Create, read, update and delete relationships
• Create and read a complete graph
• Create and delete indexes

Test utilities

It is possible to write unit tests for Neo4clj executions, using our test utilities.

Installation

Add the following dependency to project.clj under your test profile:

Usage

Require the test utils in your test namespace:

(:require [neo4clj.test-utils :as test-utils])

Then initialize an in-memory Neo4J database using with-db:

(test-utils/with-db conn {:initial-data ["CREATE (n:TestNode) RETURN n"]}
  ;; Your test code here
  (client/execute! conn "MATCH (n:TestNode) RETURN n")
  )

The symbol conn contains the Neo4J DB connection and can be used in all neo4clj client calls.

The :initial-data key value is a vector of Cypher strings, these Cypher strings are run when the database is created.

Version matrix

Neo4clj	Clojure	neo-java-driver	Neo4j Server
1.1.0	1.11.1	5.3.0	5.3.x
1.0.1	1.11.1	4.4.9	4.4.x
1.0.0	1.11.1	4.4.9	4.4.x
1.0.0-ALPHA7	1.10.3	4.4.3	4.4.x
1.0.0-ALPHA6	1.10.3	4.2.5	4.2.x
1.0.0-ALPHA5	1.10.0	4.2.0	4.2.x
1.0.0-ALPHA4	1.10.0	4.2.0	4.2.x
1.0.0-ALPHA3	1.10.0	4.2.0	4.2.x
1.0.0-ALPHA2	1.10.0	4.2.0	4.2.x
1.0.0-ALPHA1	1.10.0	4.2.0	4.2.x
1.0.0-SNAPSHOT	1.10.0	1.7.2	3.5.x

Acknowledgements

This project has been inspired by the work of two other projects listed below.

Neocons by Michael Klishin (https://github.com/michaelklishin/neocons) neo4j-clj by Christian Betz (https://github.com/gorillalabs/neo4j-clj)

License

Copyright (C) 2021 Claus Engel-Christensen, Jacob Emcken, and the Full Spectrum team.

Licensed under the Eclipse Public License