Skip to content

Latest commit

 

History

History
155 lines (92 loc) · 5.64 KB

README.md

File metadata and controls

155 lines (92 loc) · 5.64 KB
Raw

Neocons, a Clojure client for the Neo4J REST API

Neocons is a feature rich idiomatic Clojure client for the Neo4J REST API.

Supported Features

Neocons currently supports the following features (all via REST API, so you can use open source Neo4J Server edition for commercial projects):

  • Create, read, update and delete nodes
  • Create, read, update and delete relationships
  • Fetch relationships for given node
  • Create and delete indexes
  • Index nodes
  • Query node indexes for exact matches and using full text search queries
  • Query automatic node index
  • Traverse nodes, relationships and paths
  • Find shortest path or all paths between nodes
  • Predicates over paths, for example, if they include specific nodes/relationships
  • Cypher queries (with Neo4J Server 1.6 and later)
  • Basic HTTP authentication, including Heroku Neo4J add-on compatibility
  • Efficient multi-get via Cypher queries
  • Convenience functions for working with relationships and paths

Documentation & Examples

To get started and see what using Neocons feels like, please use our Getting started with Clojure and Neo4J Server guide.

Our main focus since June 2012 is finishing documentation guides. For more examples, see our test suite.

Community

Neocons has a mailing list. Feel free to join it and ask any questions you may have.

To subscribe for announcements of releases, important changes and so on, please follow @ClojureWerkz on Twitter.

Project Maturity

Neocons is not a young project: it is more than 1 year old, with active production use from week 1. It is now past 1.0, all API parts are set in stone and most documentation guides in good shape.

Maven Artifacts

The Most Recent Release

Neocons artifacts are released to Clojars. If you are using Maven, add the following repository definition to your pom.xml:

<repository>
  <id>clojars.org</id>
  <url>http://clojars.org/repo</url>
</repository>

The Most Recent Stable Release

With Leiningen:

[clojurewerkz/neocons "1.0.3"]

With Maven:

<dependency>
  <groupId>clojurewerkz</groupId>
  <artifactId>neocons</artifactId>
  <version>1.0.3</version>
</dependency>

The Most Recent Preview Release

With Leiningen:

[clojurewerkz/neocons "1.1.0-beta4"]

With Maven:

<dependency>
  <groupId>clojurewerkz</groupId>
  <artifactId>neocons</artifactId>
  <version>1.1.0-beta4</version>
</dependency>

Continuous Integration

Continuous Integration status

CI is hosted by travis-ci.org

Supported Clojure versions

Neocons is built from the ground up for Clojure 1.3 and up. The most recent stable Clojure release is highly recommended.

Supported Neo4J Server versions

Neocons supports Neo4J Server 1.5.0 and later versions. For the Cypher query language support, 1.6 is the minimum recommended versions because Cypher is supported by the REST API directly without any plugins. Some features (in Cypher in particular) may be specific to later version. We recommend using the most recent stable release. Neocons is actively tested against bleeding edge Neo4J Server snapshots and we try to support important new features before stable server releases come out.

If you use OpsCode Chef, there is a Neo4J Server Chef cookbook.

Neocons Is a ClojureWerkz Project

Neocons is part of the group of libraries known as ClojureWerkz, together with Monger, Langohr, Welle, Quartzite, Validateur and several others.

Development

Neocons uses Leiningen 2. Make sure you have it installed and then run tests against all supported Clojure versions using

lein2 all test

Then create a branch and make your changes on it. Once you are done with your changes and all tests pass, submit a pull request on Github.

License

Copyright (C) 2011-2013 Michael S. Klishin, Alex Petrov

Distributed under the Eclipse Public License, the same as Clojure.

FAQ

Will embedding be supported in the future?

Because Neo4J is GPL software, linking against it will require your project to be open source. While there are perfectly valid use cases for this, Neocons was developed to be used in commercial projects and Neocons authors strongly prefer business-friendly licenses and Clojure community commitment to the Eclipse Public License v1.

Neocons namespace structure leave the door open for future Neo4J Server features like the binary protocol but it is highly unlikely that it will ever cover embedding, should Neo4J license stay GPL forever.

If you need a solid well-maintained EPLv1-licensed embeddable graph database for Clojure 1.3.0 and later, please take a look at Titanium and Jiraph.