FerricStore.SDK (ferricstore_sdk v0.4.2)

Copy Markdown View Source

Topology-aware Elixir SDK entry points.

Functions in this namespace accept clients returned by either start_link/1 or FerricStore.start_link/1; both entry points create the same canonical topology-aware client.

Summary

Functions

acl_del_user(client, username, opts \\ [])

See FerricStore.SDK.Management.del_user/3.

acl_get_user(client, username, opts \\ [])

See FerricStore.SDK.Management.get_user/3.

acl_list_users(client, opts \\ [])

See FerricStore.SDK.Management.list_users/2.

acl_save(client, opts \\ [])

See FerricStore.SDK.Management.save_acl/2.

acl_set_user(client, username, rules, opts \\ [])

See FerricStore.SDK.Management.set_user/4.

await_event(client, timeout \\ 5000)

See FerricStore.SDK.Native.Client.await_event/2.

capabilities(client, opts \\ [])

See FerricStore.SDK.Management.capabilities/2.

cas(client, key, expected, value, opts \\ [])

See FerricStore.SDK.KV.cas/5.

child_spec(opts)
close(client)

See FerricStore.SDK.Native.Client.close/1.

close(client, timeout)

See FerricStore.SDK.Native.Client.close/2.

cluster_info(client, opts \\ [])

See FerricStore.SDK.Management.cluster_info/2.

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

See FerricStore.SDK.Native.Client.command_exec/4.

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

See FerricStore.SDK.KV.del/3.

delete_namespace(client, prefix, opts \\ [])

See FerricStore.SDK.Management.delete_namespace/3.

ensure_namespace(client, prefix, attrs \\ %{}, opts \\ [])

See FerricStore.SDK.Management.ensure_namespace/4.

extend(client, key, owner, ttl_ms, opts \\ [])

See FerricStore.SDK.KV.extend/5.

fetch_or_compute(client, key, ttl_ms, opts \\ [])

See FerricStore.SDK.KV.fetch_or_compute/4.

fetch_or_compute_error(client, key, token, message, opts \\ [])

See FerricStore.SDK.KV.fetch_or_compute_error/5.

fetch_or_compute_result(client, key, token, value, ttl_ms, opts \\ [])

See FerricStore.SDK.KV.fetch_or_compute_result/6.

flow_history(client, id, attrs \\ %{}, opts \\ [])

See FerricStore.SDK.Management.flow_history/4.

flow_query(client, attrs \\ %{}, opts \\ [])

See FerricStore.SDK.Management.flow_query/3.

from_url(url, opts \\ [])

See FerricStore.SDK.Native.Client.from_url/2.

get(client, key, opts \\ [])

See FerricStore.SDK.KV.get/3.

get_namespace(client, prefix, opts \\ [])

See FerricStore.SDK.Management.get_namespace/3.

get_quota(client, namespace, opts \\ [])

See FerricStore.SDK.Management.get_quota/3.

hget(client, key, field, opts \\ [])

See FerricStore.SDK.KV.hget/4.

hgetall(client, key, opts \\ [])

See FerricStore.SDK.KV.hgetall/3.

hmget(client, key, fields, opts \\ [])

See FerricStore.SDK.KV.hmget/4.

hset(client, key, fields, opts \\ [])

See FerricStore.SDK.KV.hset/4.

invocation_create(client, name, attrs, opts \\ [])

See FerricStore.SDK.Invocation.create/4.

invocation_definition_get(client, name, opts \\ [])

See FerricStore.SDK.Invocation.get_definition/3.

invocation_definition_list(client, opts \\ [])

See FerricStore.SDK.Invocation.list_definitions/2.

invocation_definition_put(client, definition, opts \\ [])

See FerricStore.SDK.Invocation.put_definition/3.

invocation_get(client, id, opts \\ [])

See FerricStore.SDK.Invocation.get/3.

invocation_partition_list(client, name, opts \\ [])

See FerricStore.SDK.Invocation.list_partitions/3.

list_namespaces(client, opts \\ [])

See FerricStore.SDK.Management.list_namespaces/2.

lock(client, key, owner, ttl_ms, opts \\ [])

See FerricStore.SDK.KV.lock/5.

lpop(client, key, count \\ 1, opts \\ [])

See FerricStore.SDK.KV.lpop/4.

lpush(client, key, values, opts \\ [])

See FerricStore.SDK.KV.lpush/4.

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

See FerricStore.SDK.KV.lrange/5.

mget(client, keys, opts \\ [])

See FerricStore.SDK.KV.mget/3.

minimum_server_version()

See FerricStore.Compatibility.minimum_server_version/0.

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

See FerricStore.SDK.KV.mset/3.

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

See FerricStore.SDK.KV.msetnx/3.

namespace_usage(client, prefix, opts \\ [])

See FerricStore.SDK.Management.namespace_usage/3.

ping(client, message \\ "PONG", opts \\ [])

See FerricStore.SDK.Native.Client.ping/3.

quota_usage(client, namespace, opts \\ [])

See FerricStore.SDK.Management.quota_usage/3.

ratelimit_add(client, key, window_ms, max, count \\ 1, opts \\ [])

See FerricStore.SDK.KV.ratelimit_add/6.

refresh_topology(client, timeout \\ 5000)

See FerricStore.SDK.Native.Client.refresh_topology/2.

request(client, opcode, payload \\ %{}, opts \\ [])

See FerricStore.SDK.Native.Client.request/4.

request_by_items(client, opcode, items, key_fun, payload_builder, opts \\ [])

See FerricStore.SDK.Native.Client.request_by_items/6.

request_by_key(client, opcode, key, payload, opts \\ [])

See FerricStore.SDK.Native.Client.request_by_key/5.

request_by_keys(client, opcode, keys, payload_builder, opts \\ [])

See FerricStore.SDK.Native.Client.request_by_keys/5.

route(client, key)

See FerricStore.SDK.Native.Client.route/2.

rpop(client, key, count \\ 1, opts \\ [])

See FerricStore.SDK.KV.rpop/4.

rpush(client, key, values, opts \\ [])

See FerricStore.SDK.KV.rpush/4.

sadd(client, key, members, opts \\ [])

See FerricStore.SDK.KV.sadd/4.

server_version_requirement()

See FerricStore.Compatibility.server_version_requirement/0.

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

See FerricStore.SDK.KV.set/4.

set_quota(client, namespace, quota_spec, opts \\ [])

See FerricStore.SDK.Management.set_quota/4.

sismember(client, key, member, opts \\ [])

See FerricStore.SDK.KV.sismember/4.

smembers(client, key, opts \\ [])

See FerricStore.SDK.KV.smembers/3.

srem(client, key, members, opts \\ [])

See FerricStore.SDK.KV.srem/4.

start_link(opts)
subscribe_events(client, events \\ [], opts \\ [])

See FerricStore.SDK.Native.Client.subscribe_events/3.

topology(client)

Returns the client's current read-only topology snapshot.

unlock(client, key, owner, opts \\ [])

See FerricStore.SDK.KV.unlock/4.

unsubscribe_events(client, events \\ [], opts \\ [])

See FerricStore.SDK.Native.Client.unsubscribe_events/3.

zadd(client, key, items, opts \\ [])

See FerricStore.SDK.KV.zadd/4.

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

See FerricStore.SDK.KV.zrange/5.

zrem(client, key, members, opts \\ [])

See FerricStore.SDK.KV.zrem/4.

zscore(client, key, member, opts \\ [])

See FerricStore.SDK.KV.zscore/4.

Functions

acl_del_user(client, username, opts \\ [])

See FerricStore.SDK.Management.del_user/3.

acl_get_user(client, username, opts \\ [])

See FerricStore.SDK.Management.get_user/3.

acl_list_users(client, opts \\ [])

See FerricStore.SDK.Management.list_users/2.

acl_save(client, opts \\ [])

See FerricStore.SDK.Management.save_acl/2.

acl_set_user(client, username, rules, opts \\ [])

See FerricStore.SDK.Management.set_user/4.

await_event(client, timeout \\ 5000)

See FerricStore.SDK.Native.Client.await_event/2.

capabilities(client, opts \\ [])

See FerricStore.SDK.Management.capabilities/2.

cas(client, key, expected, value, opts \\ [])

See FerricStore.SDK.KV.cas/5.

child_spec(opts)

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

close(client)

See FerricStore.SDK.Native.Client.close/1.

close(client, timeout)

See FerricStore.SDK.Native.Client.close/2.

cluster_info(client, opts \\ [])

See FerricStore.SDK.Management.cluster_info/2.

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

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

See FerricStore.SDK.Native.Client.command_exec/4.

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

See FerricStore.SDK.KV.del/3.

delete_namespace(client, prefix, opts \\ [])

See FerricStore.SDK.Management.delete_namespace/3.

ensure_namespace(client, prefix, attrs \\ %{}, opts \\ [])

See FerricStore.SDK.Management.ensure_namespace/4.

extend(client, key, owner, ttl_ms, opts \\ [])

See FerricStore.SDK.KV.extend/5.

fetch_or_compute(client, key, ttl_ms, opts \\ [])

See FerricStore.SDK.KV.fetch_or_compute/4.

fetch_or_compute_error(client, key, token, message, opts \\ [])

See FerricStore.SDK.KV.fetch_or_compute_error/5.

fetch_or_compute_result(client, key, token, value, ttl_ms, opts \\ [])

See FerricStore.SDK.KV.fetch_or_compute_result/6.

flow_history(client, id, attrs \\ %{}, opts \\ [])

See FerricStore.SDK.Management.flow_history/4.

flow_query(client, attrs \\ %{}, opts \\ [])

See FerricStore.SDK.Management.flow_query/3.

from_url(url, opts \\ [])

See FerricStore.SDK.Native.Client.from_url/2.

get(client, key, opts \\ [])

See FerricStore.SDK.KV.get/3.

get_namespace(client, prefix, opts \\ [])

See FerricStore.SDK.Management.get_namespace/3.

get_quota(client, namespace, opts \\ [])

See FerricStore.SDK.Management.get_quota/3.

hget(client, key, field, opts \\ [])

See FerricStore.SDK.KV.hget/4.

hgetall(client, key, opts \\ [])

See FerricStore.SDK.KV.hgetall/3.

hmget(client, key, fields, opts \\ [])

See FerricStore.SDK.KV.hmget/4.

hset(client, key, fields, opts \\ [])

See FerricStore.SDK.KV.hset/4.

invocation_create(client, name, attrs, opts \\ [])

See FerricStore.SDK.Invocation.create/4.

invocation_definition_get(client, name, opts \\ [])

See FerricStore.SDK.Invocation.get_definition/3.

invocation_definition_list(client, opts \\ [])

See FerricStore.SDK.Invocation.list_definitions/2.

invocation_definition_put(client, definition, opts \\ [])

See FerricStore.SDK.Invocation.put_definition/3.

invocation_get(client, id, opts \\ [])

See FerricStore.SDK.Invocation.get/3.

invocation_partition_list(client, name, opts \\ [])

See FerricStore.SDK.Invocation.list_partitions/3.

list_namespaces(client, opts \\ [])

See FerricStore.SDK.Management.list_namespaces/2.

lock(client, key, owner, ttl_ms, opts \\ [])

See FerricStore.SDK.KV.lock/5.

lpop(client, key, count \\ 1, opts \\ [])

See FerricStore.SDK.KV.lpop/4.

lpush(client, key, values, opts \\ [])

See FerricStore.SDK.KV.lpush/4.

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

See FerricStore.SDK.KV.lrange/5.

mget(client, keys, opts \\ [])

See FerricStore.SDK.KV.mget/3.

minimum_server_version()

See FerricStore.Compatibility.minimum_server_version/0.

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

See FerricStore.SDK.KV.mset/3.

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

See FerricStore.SDK.KV.msetnx/3.

namespace_usage(client, prefix, opts \\ [])

See FerricStore.SDK.Management.namespace_usage/3.

ping(client, message \\ "PONG", opts \\ [])

See FerricStore.SDK.Native.Client.ping/3.

quota_usage(client, namespace, opts \\ [])

See FerricStore.SDK.Management.quota_usage/3.

ratelimit_add(client, key, window_ms, max, count \\ 1, opts \\ [])

See FerricStore.SDK.KV.ratelimit_add/6.

refresh_topology(client, timeout \\ 5000)

See FerricStore.SDK.Native.Client.refresh_topology/2.

request(client, opcode, payload \\ %{}, opts \\ [])

See FerricStore.SDK.Native.Client.request/4.

request_by_items(client, opcode, items, key_fun, payload_builder, opts \\ [])

See FerricStore.SDK.Native.Client.request_by_items/6.

request_by_key(client, opcode, key, payload, opts \\ [])

See FerricStore.SDK.Native.Client.request_by_key/5.

request_by_keys(client, opcode, keys, payload_builder, opts \\ [])

See FerricStore.SDK.Native.Client.request_by_keys/5.

route(client, key)

See FerricStore.SDK.Native.Client.route/2.

rpop(client, key, count \\ 1, opts \\ [])

See FerricStore.SDK.KV.rpop/4.

rpush(client, key, values, opts \\ [])

See FerricStore.SDK.KV.rpush/4.

sadd(client, key, members, opts \\ [])

See FerricStore.SDK.KV.sadd/4.

server_version_requirement()

See FerricStore.Compatibility.server_version_requirement/0.

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

See FerricStore.SDK.KV.set/4.

set_quota(client, namespace, quota_spec, opts \\ [])

See FerricStore.SDK.Management.set_quota/4.

sismember(client, key, member, opts \\ [])

See FerricStore.SDK.KV.sismember/4.

smembers(client, key, opts \\ [])

See FerricStore.SDK.KV.smembers/3.

srem(client, key, members, opts \\ [])

See FerricStore.SDK.KV.srem/4.

start_link(opts)

subscribe_events(client, events \\ [], opts \\ [])

See FerricStore.SDK.Native.Client.subscribe_events/3.

topology(client)

@spec topology(pid()) :: FerricStore.SDK.Native.Topology.t() | {:error, term()}

Returns the client's current read-only topology snapshot.

unlock(client, key, owner, opts \\ [])

See FerricStore.SDK.KV.unlock/4.

unsubscribe_events(client, events \\ [], opts \\ [])

See FerricStore.SDK.Native.Client.unsubscribe_events/3.

zadd(client, key, items, opts \\ [])

See FerricStore.SDK.KV.zadd/4.

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

See FerricStore.SDK.KV.zrange/5.

zrem(client, key, members, opts \\ [])

See FerricStore.SDK.KV.zrem/4.

zscore(client, key, member, opts \\ [])

See FerricStore.SDK.KV.zscore/4.