DeltaCrdt
DeltaCrdt implements a key/value store using concepts from Delta CRDTs, and relies on MerkleMap for efficient synchronization.
There is a (slightly out of date) introductory blog post and the (very much up to date) official documentation on hexdocs.pm is also very good.
The following papers have been used to implement this library:
Delta State Replicated Data Types – Almeida et al. 2016Efficient Synchronization of State-based CRDTs – Enes et al. 2018
Usage
Documentation can be found on hexdocs.pm.
Here's a short example to illustrate adding an entry to a map:
# start 2 Delta CRDTs
{:ok, crdt1} = DeltaCrdt.start_link(DeltaCrdt.AWLWWMap)
{:ok, crdt2} = DeltaCrdt.start_link(DeltaCrdt.AWLWWMap)
# make them aware of each other
DeltaCrdt.set_neighbours(crdt1, [crdt2])
# show the initial value
DeltaCrdt.read(crdt1)
%{}
# add a key/value in crdt1
DeltaCrdt.put(crdt1, "CRDT", "is magic!")
DeltaCrdt.put(crdt1, "magic", "is awesome!")
# read it after it has been replicated to crdt2
DeltaCrdt.read(crdt2)
%{"CRDT" => "is magic!", "magic" => "is awesome!"}
# get only a subset of keys
DeltaCrdt.take(crdt2, ["magic"])
%{"magic" => "is awesome!"}
# get one value
DeltaCrdt.get(crdt2, "magic")
"is awesome!"
# Other map-like functions are available, see the documentation for details.Telemetry metrics
DeltaCrdt publishes the metric [:delta_crdt, :sync, :done].
Installation
The package can be installed by adding delta_crdt to your list of dependencies in mix.exs:
def deps do
[
{:delta_crdt, "~> 0.6.3"}
]
end