Consistent Hashing Clojure Library

CHash is a yet another consistent hashing library in Clojure, heavily inspired by the implementation in Riak Core.

Project Maturity

CHash is a young project but based on the consistent hashing implementation from Riak Core which is mature.

Artifacts

CHash 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 Release

With Leiningen:

[clojurewerkz/chash "1.0.0"]

With Maven:

<dependency>
  <groupId>clojurewerkz</groupId>
  <artifactId>chash</artifactId>
  <version>1.0.0</version>
</dependency>

Documentation & Examples

CHash is a very small library so there are no documentation guides.

(require '[clojurewerkz.chash.ring :as ch])

;; create a new ring with 64 partitions and a seed node (value)
(ch/fresh 64 "seed")

;; update a partition
(let [r (ch/fresh 64 "seed")]
  (ch/update r 0 "node2"))

;; retrieve 3 partitions in order starting at the given point on the ring
(let [r (ch/fresh 64 "seed")]
  (ch/successors r (ch/key-of 0) 3))

;; check if a particular node claims any partitions in the ring
(let [r (ch/fresh 64 "seed")]
  (ch/claimant? r "node2"))

;; given a key as an integer, get the next ring partition
(let [r (ch/fresh 64 "seed")]
  (ch/next-index r (ch/key-of 128)))

;; randomized merging of two rings. When two nodes claim the same partition,
;; the owner in the resulting ring is selected randomly
(let [r1 (ch/fresh 64 "node1")
      r2 (ch/fresh 64 "node2")]
  (ch/merge r1 r2))

See documentation strings for clojurewerkz.chash.core functions and our test suite.

Supported Clojure versions

CHash is built from the ground up for Clojure 1.3.0 and up.

Continuous Integration Status

CHash Is a ClojureWerkz Project

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

Development

CHash uses Leiningen 2. Make sure you have it installed and then run tests against 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

Double licensed under the Eclipse Public License (the same as Clojure) or the Apache Public License 2.0.

claj / chash