ClusterKV (cluster_kv v0.2.0)

Documentation for ClusterKV.

Link to this section Summary

Functions

See ClusterKV.Ring.batch/3.

Returns a specification to start this module under a supervisor.

See ClusterKV.Ring.get_wildcard_key/4.

Callback implementation for Supervisor.init/1.

See ClusterKV.Ring.put/4.

See ClusterKV.Ring.stream/2.

See ClusterKV.Ring.update/5.

See ClusterKV.Ring.update_if/5.

Link to this section Functions

Link to this function

batch(name, keyspace, batch)

See ClusterKV.Ring.batch/3.

Link to this function

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

cluster_supervisor_name(name)

Link to this function

get(name, keyspace, key, timeout \\ :infinity)

See ClusterKV.Ring.get/4.

Link to this function

get_wildcard_key(key, split_on, join, wildcard)

See ClusterKV.Ring.get_wildcard_key/4.

Callback implementation for Supervisor.init/1.

Link to this function

prefix(name, keyspace, key, split_on, min, timeout \\ :infinity)

See ClusterKV.Ring.prefix/6.

Link to this function

put(name, keyspace, key, value)

See ClusterKV.Ring.put/4.

Link to this function

put_wildcard(name, keyspace, key, value, split_on, join, wildcard)

See ClusterKV.Ring.put_wildcard/7.

Link to this function

ring_name(name)

Link to this function

start_link(list)

Specs

start_link(
  name: atom(),
  topologies: list(),
  replicas: integer(),
  quorum: integer()
) ::
  {:ok, pid()}
  | {:error, {:already_started, pid()} | {:shutdown, term()} | term()}
Link to this function

stream(name, timeout \\ :infinity)

See ClusterKV.Ring.stream/2.

Link to this function

update(name, keyspace, key, value, fun)

See ClusterKV.Ring.update/5.

Link to this function

update_if(name, keyspace, key, value, fun)

See ClusterKV.Ring.update_if/5.

Link to this function

wildcard(name, keyspace, key, split_on, join, wildcard, timeout \\ :infinity)

See ClusterKV.Ring.wildcard/7.