FerricStore (ferricstore_sdk v0.4.2)

Copy Markdown View Source

High-level FerricStore and FerricFlow API over the topology-aware native client.

FerricStore.start_link/1 and FerricStore.SDK.start_link/1 return the same client type. This facade unwraps successful SDK result tuples for concise application code; FerricStore.SDK retains explicit {:ok, value} results.

Summary

Functions

Functions

async_native(client, opcode, payload, opts \\ [])

See FerricStore.Client.async_native/4.

async_pipeline(client, commands, opts \\ [])

See FerricStore.Client.async_pipeline/3.

await(request, timeout \\ 5000)

See FerricStore.Client.await/2.

cancel_async(request)

See FerricStore.Client.cancel_async/1.

child_spec(opts)

@spec child_spec(keyword() | binary()) :: Supervisor.child_spec()

close(client)

See FerricStore.Client.close/1.

close(client, timeout)

See FerricStore.Client.close/2.

command(client, command, args \\ [], opts \\ [])

connect!(opts \\ [])

See FerricStore.Client.connect!/1.

delete(client, key_or_keys, opts \\ [])

get(client, key)

hget(client, key, field)

hgetall(client, key)

hmget(client, key, fields)

hset(client, key, field, value)

lpop(client, key)

lpush(client, key, values)

lrange(client, key, start, stop)

mget(client, keys)

minimum_server_version()

See FerricStore.Compatibility.minimum_server_version/0.

mset(client, pairs, opts \\ [])

msetnx(client, pairs, opts \\ [])

ping(client)

pipeline(client, commands, opts \\ [])

See FerricStore.Client.pipeline/3.

rpop(client, key)

rpush(client, key, values)

sadd(client, key, members)

server_version_requirement()

See FerricStore.Compatibility.server_version_requirement/0.

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

sismember(client, key, member)

smembers(client, key)

srem(client, key, members)

start_link(opts \\ [])

See FerricStore.Client.start_link/1.

yield(request, timeout \\ 0)

See FerricStore.Client.yield/2.

zadd(client, key, score, member)

zrange(client, key, start, stop, opts \\ [])

zrem(client, key, members)

zscore(client, key, member)