Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.03 KB

README.md

File metadata and controls

74 lines (50 loc) · 2.03 KB

Ketamine

A consistent hashing library for Clojure that can be used to allocate resources to different servers. If any server goes down or a new one is added there is a minimum impact on existing resources as they are mapped consistently to the servers.

Based on Ketama algorithm by Karger, et al.

Getting via Leiningen

[ketamine "1.0.0"]

Usage

(require '[ketamine.core :as ketama])

;; let's define a consistent hash ring with some servers
(def chash (atom (ketama/make-ring ["192.168.0.1:1337"
                                    "192.168.0.2:1337"
                                    "192.168.0.3:1337"
                                    "192.168.0.4:1337"])))

;; let's figure out where the resource named "resource-1" should go
(ketama/get-node @chash "resource-1")
;;=> "192.168.0.1:1337"

;; what about "resource-142"?
(ketama/get-node @chash "resource-142")
;;=> "192.168.0.4:1337"

;; and "resource-1kajillion"?
(ketama/get-node @chash "resource-1kajillion")
;;=> "192.168.0.3:1337"

;; now "192.168.0.4:1337" goes down, so let's remove it from the ring
(swap! chash ketama/remove-node "192.168.0.4:1337")

;; let's add a new server to the ring
(swap! chash ketama/add-node "10.10.10.42:1234")

;; so where should "resource-142" go now?
(ketama/get-node @chash "resource-142")
;;=> "10.10.10.42:1234" ; OK

;; and what about the other resources?
(ketama/get-node @chash "resource-1")
;;=> "192.168.0.1:1337"

(ketama/get-node @chash "resource-1kajillion")
;;=> "192.168.0.3:1337"

;; Voila! Consistent hashing ftw.

Contributing

Pull requests are more than welcome! Namasté.

See also

clojurewerkz/chash is another library which does the same thing albeit with a different API. I had no clue about this library when I was writing Ketamine, hence the NIH. Oh well...

License

Copyright © 2013 Baishampayan Ghose

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