Delete one or more keys.

Examples

delete("foo")
delete(["foo", "one"])

Fetch one or more keys, falling back to a function if a key doesn’t exist.

opts is the same as for set/3.

Ex:

fetch(cluster, "foo", fn -> "bar" end)

fetch(cluster, ["foo", "bar"], fn missing_keys ->
  Enum.map(missing_keys, fn missing_key ->
    calc_value(missing_key)
  end)
end)

# In this example, we explicitly associate missing keys with values.
fetch(cluster, ["foo", "bar"], fn missing_keys ->
  Enum.shuffle(missing_keys)
    |> Enum.map(fn missing_key ->
      {missing_key, calc_value(missing_key)}
    end)
end)

Flush all memcached servers in the cluster.

Get one or more keys.

Examples

"bar" = get(pid, "foo")
%{"foo" => "bar", "one" => "one"} = get(pid, ["foo", "bar"])

Set the value of a single key.

This a convenience function for set(cluster, {key, value}, opts). See set/3.

It has a different name because the follow definitions conflict:

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

Set one or more keys.

Single key examples:

set(cluster, {key, value})
set(cluster, {key, value}, ttl: 300)

Multiple key examples:

set(cluster, [{k1, v1}, {k2, v2}])
set(cluster, [{k1, v1}, {k2, v2}], ttl: 300)

set(cluster, %{k1 => v1, k2 => v2})
set(cluster, %{k1 => v1, k2 => v2}, ttl: 300)

Connect to memcached server(s)

Options

• :servers - Servers to connect to. Defaults to ["localhost:11211"].
• :pool - Worker pool size. Defaults to 10.
• :name - Like name argument for GenServer.start_link/3. No default. Ignored if using module based cluster.
• :memcachex - Keyword list passed through to Memcache.start_link/2

Example

{:ok, cluster} = Cream.Cluster.start_link(
  servers: ["host1:11211", "host2:11211"],
  name: MyCluster,
  memcachex: [ttl: 60, namespace: "foo"]
)

Get Memcache connection(s) for one or more keys.

Memcachex doesn’t support clustering. Cream supports clustering, but doesn’t support the full memcached API. This function lets you do both.

The connection yielded to the function can be used with all of the Memcache and Memcache.Connection modules.

Examples

with_conn cluster, keys, fn conn, keys ->
  Memcache.multi_get(conn, keys)
end

For easily putting into supervision tree.

Ex:

Supervisor.start_link([MyCluster], opts)

Or if you want to do runtime config here instead of the init/1 callback for some reason:

Supervisor.start_link([{MyCluster, servers: servers}], opts)

See delete/2.

See fetch/4.

See flush/2.

See get/2.

For dynamic / runtime configuration.

Ex:

defmodule MyCluster do
  use Cream.Cluster, otp_app: :my_app

  def init(config) do
    servers = System.get_env("MEMCACHED_SERVERS") |> String.split(",")
    config = Keyword.put(config, :servers, servers)
    {:ok, config}
  end
end

See put/4.

See set/3.