Memcachir (memcachir v3.3.1) View Source

Module with a friendly API for memcached servers.

It provides connection pooling, and cluster support.

Examples

{:ok} = Memcachir.set("hello", "world")
{:ok, "world"} = Memcachir.get("hello")

Link to this section Summary

Functions

Removes the item with the specified key.

Accepts a memcache operation closure, a grouped map of %{node => args} and executes the operations in parallel for all given nodes.

Removes all the items from the server.

Gets the value associated with the key. Returns {:error, "Key not found"} if the given key doesn't exist.

increments the key by value.

List all currently registered node names, like [:"localhost:11211"].

Accepts a list of mcached keys, and returns either {:ok, %{key => val}} for each found key or {:error, any}.

Accepts a list of {key, val} pairs and returns the store results for each node touched.

Multi-set with cas option.

Sets the key to value.

Callback implementation for Application.start/2.

Link to this section Functions

Removes the item with the specified key.

Returns {:ok, :deleted}.

Link to this function

exec_parallel(fun, grouped, args \\ [], merge_fun \\ &Map.merge/2)

View Source

Accepts a memcache operation closure, a grouped map of %{node => args} and executes the operations in parallel for all given nodes.

The result is of form {:ok, enumerable} where enumerable is the merged result of all operations.

Additionally, you can pass args to supply memcache ops to each of the executions and merge_fun (a 2-arity func) which configures how the result is merged into the final result set.

For instance, mget/2 returns a map of key, val pairs in its result, and utilizes Map.merge/2.

Removes all the items from the server.

Returns {:ok}.

Gets the value associated with the key. Returns {:error, "Key not found"} if the given key doesn't exist.

Link to this function

incr(key, value \\ 1, opts \\ [])

View Source

increments the key by value.

List all currently registered node names, like [:"localhost:11211"].

Accepts a list of mcached keys, and returns either {:ok, %{key => val}} for each found key or {:error, any}.

Link to this function

mset(commands, opts \\ [])

View Source

Accepts a list of {key, val} pairs and returns the store results for each node touched.

Link to this function

mset_cas(commands, opts \\ [])

View Source

Multi-set with cas option.

Link to this function

set(key, value, opts \\ [])

View Source

Sets the key to value.

Valid option are:

  • :ttl - The time in seconds that the value will be stored.

Callback implementation for Application.start/2.