View Source Spear.Client behaviour (Spear v1.4.0)

A macro for defining a module which represents a connection to an EventStoreDB

Like an Ecto.Repo or an Extreme client, this macro allows you to call functions on the module representing the connection instead of passing the connection pid or name as an argument to functions in Spear. This can be useful for client connections central to a service. All callbacks provided by this module are implemented on clients created with use Spear.Client.

This pattern can be useful for applications which depend on an EventStoreDB connection similar to applications which depend on a (e.g.) PostgreSQL connection via Ecto.Repo. Writing clients as modules provides an intuitive "is-a" interface (e.g. "MyEventStoreClient is an EventStoreDB client"). Since this module defines a complete behaviour for a client module, mocking calls to the EventStoreDB is easy via a test dependency like the wonderful Dashbit library Mox.

If a service does not know which connections it may need until runtime, the functions in Spear may be used with a connection processes spawned via DynamicSupervisor.start_child/2 instead.

configuration
Configuration

The __using__/1 macro defined by this module takes an optional :otp_app option. If provided, a helper clause for the start_link/1 callback will be injected which will fetch configuration for the connection from Application.get_env(otp_app, __MODULE__), if available.

Otherwise configuration for the connection may be passed through arguments to start_link/1.

examples
Examples

defmodule MyEventStoreClient do
  use Spear.Client, otp_app: :my_app
end

[MyEventStoreClient] |> Supervisor.start_link(strategy: :one_for_one)

iex> MyEventStoreClient.stream!(:all) |> Enum.take(1)
[%Spear.Event{}]

Link to this section Summary

Callbacks

ack(subscription, event_or_ids)

A wrapper around Spear.ack/3

append(event_stream, stream_name)

A wrapper around Spear.append/3

append(event_stream, stream_name, opts)

A wrapper around Spear.append/4

append_batch(event_stream, request_id, stream_name)

A wrapper around Spear.append_batch/4

append_batch(event_stream, request_id, stream_name, opts)

A wrapper around Spear.append_batch/5

append_batch_stream(batch_stream)

A wrapper around Spear.append_batch_stream/2

cancel_subscription(subscription_reference)

A wrapper around Spear.cancel_subscription/2

cancel_subscription(subscription_reference, timeout)

A wrapper around Spear.cancel_subscription/3

change_user_password(login_name, current_password, new_password)

A wrapper around Spear.change_user_password/4

change_user_password(login_name, current_password, new_password, opts)

A wrapper around Spear.change_user_password/5

cluster_info()

A wrapper around Spear.cluster_info/1

cluster_info(opts)

A wrapper around Spear.cluster_info/2

connect_to_persistent_subscription(subscriber, stream_name, group_name)

A wrapper around Spear.connect_to_persistent_subscription/4

connect_to_persistent_subscription(subscriber, stream_name, group_name, opts)

A wrapper around Spear.connect_to_persistent_subscription/5

create_persistent_subscription(stream_name, group_name, settings)

A wrapper around Spear.create_persistent_subscription/4

create_persistent_subscription(stream_name, group_name, settings, opts)

A wrapper around Spear.create_persistent_subscription/5

create_user(full_name, login_name, password, groups)

A wrapper around Spear.create_user/5

create_user(full_name, login_name, password, groups, opts)

A wrapper around Spear.create_user/6

delete_persistent_subscription(stream_name, group_name)

A wrapper around Spear.delete_persistent_subscription/3

delete_persistent_subscription(stream_name, group_name, opts)

A wrapper around Spear.delete_persistent_subscription/4

delete_stream(stream_name)

A wrapper around Spear.delete_stream/2

delete_stream(stream_name, opts)

A wrapper around Spear.delete_stream/3

delete_user(login_name)

A wrapper around Spear.delete_user/2

delete_user(login_name, opts)

A wrapper around Spear.delete_user/3

disable_user(login_name)

A wrapper around Spear.disable_user/2

disable_user(login_name, opts)

A wrapper around Spear.disable_user/3

enable_user(login_name)

A wrapper around Spear.enable_user/2

enable_user(login_name, opts)

A wrapper around Spear.enable_user/3

get_persistent_subscription_info(stream_name, group_name)

A wrapper around Spear.get_persistent_subscription_info/3

get_persistent_subscription_info(stream_name, group_name, opts)

A wrapper around Spear.get_persistent_subscription_info/4

get_server_version()

A wrapper around Spear.get_server_version/1

get_server_version(t)

A wrapper around Spear.get_server_version/2

get_stream_metadata(stream)

A wrapper around Spear.get_stream_metadata/2

get_stream_metadata(stream, opts)

A wrapper around Spear.get_stream_metadata/3

get_supported_rpcs()

A wrapper around Spear.get_supported_rpcs/1

get_supported_rpcs(t)

A wrapper around Spear.get_supported_rpcs/2

list_persistent_subscriptions()

A wrapper around Spear.list_persistent_subscriptions/1

list_persistent_subscriptions(opts)

A wrapper around Spear.list_persistent_subscriptions/2

merge_indexes()

A wrapper around Spear.merge_indexes/1

merge_indexes(opts)

A wrapper around Spear.merge_indexes/2

nack(subscription, event_or_ids)

A wrapper around Spear.nack/3

nack(subscription, event_or_ids, opts)

A wrapper around Spear.nack/4

ping()

A wrapper around Spear.ping/1

ping(timeout)

A wrapper around Spear.ping/2

read_stream(stream_name)

A wrapper around Spear.read_stream/2

read_stream(stream_name, opts)

A wrapper around Spear.read_stream/3

replay_parked_messages(stream_name, group_name)

A wrapper around Spear.replay_parked_messages/3

replay_parked_messages(stream_name, group_name, opts)

A wrapper around Spear.replay_parked_messages/4

reset_user_password(login_name, new_password)

A wrapper around Spear.reset_user_password/3

reset_user_password(login_name, new_password, opts)

A wrapper around Spear.reset_user_password/4

resign_node()

A wrapper around Spear.resign_node/1

resign_node(opts)

A wrapper around Spear.resign_node/2

restart_persistent_subscription_subsystem()

A wrapper around Spear.restart_persistent_subscription_subsystem/1

restart_persistent_subscription_subsystem(opts)

A wrapper around Spear.restart_persistent_subscription_subsystem/2

restart_persistent_subscriptions()

A wrapper around Spear.restart_persistent_subscriptions/1

restart_persistent_subscriptions(opts)

A wrapper around Spear.restart_persistent_subscriptions/2

set_global_acl(user_acl, system_acl)

A wrapper around Spear.set_global_acl/3

set_global_acl(user_acl, system_acl, opts)

A wrapper around Spear.set_global_acl/4

set_node_priority(priority)

A wrapper around Spear.set_node_priority/2

set_node_priority(priority, opts)

A wrapper around Spear.set_node_priority/3

set_stream_metadata(stream, metadata)

A wrapper around Spear.set_stream_metadata/3

set_stream_metadata(stream, metadata, opts)

A wrapper around Spear.set_stream_metadata/4

shutdown()

A wrapper around Spear.shutdown/1

shutdown(opts)

A wrapper around Spear.shutdown/2

start_link(args)

Starts a client as part of a supervision tree.

start_scavenge()

A wrapper around Spear.start_scavenge/1

start_scavenge(opts)

A wrapper around Spear.start_scavenge/2

stop_scavenge(scavenge_id)

A wrapper around Spear.stop_scavenge/2

stop_scavenge(scavenge_id, opts)

A wrapper around Spear.stop_scavenge/3

stream!(stream_name)

A wrapper around Spear.stream!/2

stream!(stream_name, opts)

A wrapper around Spear.stream!/3

subscribe(subscriber, stream_name)

A wrapper around Spear.subscribe/3

subscribe(subscriber, stream_name, opts)

A wrapper around Spear.subscribe/4

subscribe_to_stats(subscriber)

A wrapper around Spear.subscribe_to_stats/2

subscribe_to_stats(subscriber, opts)

A wrapper around Spear.subscribe_to_stats/3

update_persistent_subscription(stream_name, group_name, settings)

A wrapper around Spear.update_persistent_subscription/4

update_persistent_subscription(stream_name, group_name, settings, opts)

A wrapper around Spear.update_persistent_subscription/5

update_user(full_name, login_name, password, groups)

A wrapper around Spear.update_user/5

update_user(full_name, login_name, password, groups, opts)

A wrapper around Spear.update_user/6

user_details(login_name)

A wrapper around Spear.user_details/3

user_details(login_name, opts)

A wrapper around Spear.user_details/3

Link to this section Callbacks

ack(subscription, event_or_ids)

(since 0.6.0)

@callback ack(subscription :: reference(), event_or_ids :: Spear.Event.t() | [String.t()]) ::
  :ok | {:error, any()}

A wrapper around Spear.ack/3

append(event_stream, stream_name)

(since 0.1.0)

@callback append(event_stream :: Enumerable.t(), stream_name :: String.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.append/3

append(event_stream, stream_name, opts)

(since 0.1.0)

@callback append(
  event_stream :: Enumerable.t(),
  stream_name :: String.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.append/4

append_batch(event_stream, request_id, stream_name)

(since 0.10.0)

@callback append_batch(
  event_stream :: Enumerable.t(),
  request_id :: reference() | :new,
  stream_name :: String.t()
) :: :ok | {:error, any()} | tuple()

A wrapper around Spear.append_batch/4

append_batch(event_stream, request_id, stream_name, opts)

(since 0.10.0)

@callback append_batch(
  event_stream :: Enumerable.t(),
  request_id :: reference() | :new,
  stream_name :: String.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()} | tuple()

A wrapper around Spear.append_batch/5

append_batch_stream(batch_stream)

(since 0.10.0)

@callback append_batch_stream(batch_stream :: Enumerable.t()) :: Enumerable.t()

A wrapper around Spear.append_batch_stream/2

cancel_subscription(subscription_reference)

(since 0.1.0)

@callback cancel_subscription(subscription_reference :: reference()) ::
  :ok | {:error, any()}

A wrapper around Spear.cancel_subscription/2

cancel_subscription(subscription_reference, timeout)

(since 0.1.0)

@callback cancel_subscription(subscription_reference :: reference(), timeout()) ::
  :ok | {:error, any()}

A wrapper around Spear.cancel_subscription/3

change_user_password(login_name, current_password, new_password)

(since 0.3.0)

@callback change_user_password(
  login_name :: String.t(),
  current_password :: String.t(),
  new_password :: String.t()
) :: :ok | {:error, any()}

A wrapper around Spear.change_user_password/4

change_user_password(login_name, current_password, new_password, opts)

(since 0.3.0)

@callback change_user_password(
  login_name :: String.t(),
  current_password :: String.t(),
  new_password :: String.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.change_user_password/5

cluster_info()

(since 0.5.0)

@callback cluster_info() :: :ok | {:error, any()}

A wrapper around Spear.cluster_info/1

cluster_info(opts)

(since 0.5.0)

@callback cluster_info(opts :: Keyword.t()) :: :ok | {:error, any()}

A wrapper around Spear.cluster_info/2

connect_to_persistent_subscription(subscriber, stream_name, group_name)

(since 0.6.0)

@callback connect_to_persistent_subscription(
  subscriber :: pid() | GenServer.name(),
  stream_name :: String.t() | :all,
  group_name :: String.t()
) :: {:ok, reference()} | {:error, any()}

A wrapper around Spear.connect_to_persistent_subscription/4

connect_to_persistent_subscription(subscriber, stream_name, group_name, opts)

(since 0.6.0)

@callback connect_to_persistent_subscription(
  subscriber :: pid() | GenServer.name(),
  stream_name :: String.t() | :all,
  group_name :: String.t(),
  opts :: Keyword.t()
) :: {:ok, reference()} | {:error, any()}

A wrapper around Spear.connect_to_persistent_subscription/5

create_persistent_subscription(stream_name, group_name, settings)

(since 0.6.0)

@callback create_persistent_subscription(
  stream_name :: String.t() | :all,
  group_name :: String.t(),
  settings :: Spear.PersistentSubscription.Settings.t()
) :: :ok | {:error, any()}

A wrapper around Spear.create_persistent_subscription/4

create_persistent_subscription(stream_name, group_name, settings, opts)

(since 0.6.0)

@callback create_persistent_subscription(
  stream_name :: String.t() | :all,
  group_name :: String.t(),
  settings :: Spear.PersistentSubscription.Settings.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.create_persistent_subscription/5

create_user(full_name, login_name, password, groups)

(since 0.3.0)

@callback create_user(
  full_name :: String.t(),
  login_name :: String.t(),
  password :: String.t(),
  groups :: [String.t()]
) :: :ok | {:error, any()}

A wrapper around Spear.create_user/5

create_user(full_name, login_name, password, groups, opts)

(since 0.3.0)

@callback create_user(
  full_name :: String.t(),
  login_name :: String.t(),
  password :: String.t(),
  groups :: [String.t()],
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.create_user/6

delete_persistent_subscription(stream_name, group_name)

(since 0.6.0)

@callback delete_persistent_subscription(
  stream_name :: String.t() | :all,
  group_name :: String.t()
) :: :ok | {:error, any()}

A wrapper around Spear.delete_persistent_subscription/3

delete_persistent_subscription(stream_name, group_name, opts)

(since 0.6.0)

@callback delete_persistent_subscription(
  stream_name :: String.t() | :all,
  group_name :: String.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.delete_persistent_subscription/4

delete_stream(stream_name)

(since 0.1.0)

@callback delete_stream(stream_name :: String.t()) :: :ok | {:error, any()}

A wrapper around Spear.delete_stream/2

delete_stream(stream_name, opts)

(since 0.1.0)

@callback delete_stream(stream_name :: String.t(), opts :: Keyword.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.delete_stream/3

delete_user(login_name)

(since 0.3.0)

@callback delete_user(login_name :: String.t()) :: :ok | {:error, any()}

A wrapper around Spear.delete_user/2

delete_user(login_name, opts)

(since 0.3.0)

@callback delete_user(login_name :: String.t(), opts :: Keyword.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.delete_user/3

disable_user(login_name)

(since 0.3.0)

@callback disable_user(login_name :: String.t()) :: :ok | {:error, any()}

A wrapper around Spear.disable_user/2

disable_user(login_name, opts)

(since 0.3.0)

@callback disable_user(login_name :: String.t(), opts :: Keyword.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.disable_user/3

enable_user(login_name)

(since 0.3.0)

@callback enable_user(login_name :: String.t()) :: :ok | {:error, any()}

A wrapper around Spear.enable_user/2

enable_user(login_name, opts)

(since 0.3.0)

@callback enable_user(login_name :: String.t(), opts :: Keyword.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.enable_user/3

get_persistent_subscription_info(stream_name, group_name)

(since 1.2.0)

@callback get_persistent_subscription_info(
  stream_name :: String.t() | :all,
  group_name :: String.t()
) :: {:ok, Spear.PersistentSubscription.Info.t()} | {:error, any()}

A wrapper around Spear.get_persistent_subscription_info/3

get_persistent_subscription_info(stream_name, group_name, opts)

(since 1.2.0)

@callback get_persistent_subscription_info(
  stream_name :: String.t() | :all,
  group_name :: String.t(),
  opts :: Keyword.t()
) :: {:ok, Spear.PersistentSubscription.Info.t()} | {:error, any()}

A wrapper around Spear.get_persistent_subscription_info/4

get_server_version()

(since 0.11.0)

@callback get_server_version() :: {:ok, String.t()} | {:error, any()}

A wrapper around Spear.get_server_version/1

get_server_version(t)

(since 0.11.0)

@callback get_server_version(Keyword.t()) :: {:ok, String.t()} | {:error, any()}

A wrapper around Spear.get_server_version/2

get_stream_metadata(stream)

(since 0.2.1)

@callback get_stream_metadata(stream :: String.t()) :: :ok | {:error, any()}

A wrapper around Spear.get_stream_metadata/2

get_stream_metadata(stream, opts)

(since 0.2.1)

@callback get_stream_metadata(stream :: String.t(), opts :: Keyword.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.get_stream_metadata/3

get_supported_rpcs()

(since 0.11.0)

@callback get_supported_rpcs() :: {:ok, [Spear.SupportedRpc.t()]} | {:error, any()}

A wrapper around Spear.get_supported_rpcs/1

get_supported_rpcs(t)

(since 0.11.0)

@callback get_supported_rpcs(Keyword.t()) ::
  {:ok, [Spear.SupportedRpc.t()]} | {:error, any()}

A wrapper around Spear.get_supported_rpcs/2

list_persistent_subscriptions()

(since 0.6.0)

@callback list_persistent_subscriptions() :: {:ok, Enumerable.t()} | {:error, any()}

A wrapper around Spear.list_persistent_subscriptions/1

list_persistent_subscriptions(opts)

(since 0.6.0)

@callback list_persistent_subscriptions(opts :: Keyword.t()) ::
  {:ok, Enumerable.t()} | {:error, any()}

A wrapper around Spear.list_persistent_subscriptions/2

merge_indexes()

(since 0.4.0)

@callback merge_indexes() :: :ok | {:error, any()}

A wrapper around Spear.merge_indexes/1

merge_indexes(opts)

(since 0.4.0)

@callback merge_indexes(opts :: Keyword.t()) :: :ok | {:error, any()}

A wrapper around Spear.merge_indexes/2

nack(subscription, event_or_ids)

(since 0.6.0)

@callback nack(
  subscription :: reference(),
  event_or_ids :: Spear.Event.t() | [String.t()]
) :: :ok | {:error, any()}

A wrapper around Spear.nack/3

nack(subscription, event_or_ids, opts)

(since 0.6.0)

@callback nack(
  subscription :: reference(),
  event_or_ids :: Spear.Event.t() | [String.t()],
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.nack/4

ping()

(since 0.1.2)

@callback ping() :: :pong | {:error, any()}

A wrapper around Spear.ping/1

ping(timeout)

(since 0.1.2)

@callback ping(timeout()) :: :pong | {:error, any()}

A wrapper around Spear.ping/2

read_stream(stream_name)

(since 0.1.0)

@callback read_stream(stream_name :: String.t() | :all) ::
  {:ok, Enumerable.t()} | {:error, any()}

A wrapper around Spear.read_stream/2

read_stream(stream_name, opts)

(since 0.1.0)

@callback read_stream(stream_name :: String.t() | :all, opts :: Keyword.t()) ::
  {:ok, Enumerable.t()} | {:error, any()}

A wrapper around Spear.read_stream/3

replay_parked_messages(stream_name, group_name)

(since 1.2.0)

@callback replay_parked_messages(
  stream_name :: String.t() | :all,
  group_name :: String.t()
) :: :ok | {:error, any()}

A wrapper around Spear.replay_parked_messages/3

replay_parked_messages(stream_name, group_name, opts)

(since 1.2.0)

@callback replay_parked_messages(
  stream_name :: String.t() | :all,
  group_name :: String.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.replay_parked_messages/4

reset_user_password(login_name, new_password)

(since 0.3.0)

@callback reset_user_password(login_name :: String.t(), new_password :: String.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.reset_user_password/3

reset_user_password(login_name, new_password, opts)

(since 0.3.0)

@callback reset_user_password(
  login_name :: String.t(),
  new_password :: String.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.reset_user_password/4

resign_node()

(since 0.4.0)

@callback resign_node() :: :ok | {:error, any()}

A wrapper around Spear.resign_node/1

resign_node(opts)

(since 0.4.0)

@callback resign_node(opts :: Keyword.t()) :: :ok | {:error, any()}

A wrapper around Spear.resign_node/2

restart_persistent_subscription_subsystem()

(since 1.2.0)

@callback restart_persistent_subscription_subsystem() :: :ok | {:error, any()}

A wrapper around Spear.restart_persistent_subscription_subsystem/1

restart_persistent_subscription_subsystem(opts)

(since 1.2.0)

@callback restart_persistent_subscription_subsystem(opts :: Keyword.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.restart_persistent_subscription_subsystem/2

restart_persistent_subscriptions()

(since 0.4.0)

@callback restart_persistent_subscriptions() :: :ok | {:error, any()}

A wrapper around Spear.restart_persistent_subscriptions/1

restart_persistent_subscriptions(opts)

(since 0.4.0)

@callback restart_persistent_subscriptions(opts :: Keyword.t()) :: :ok | {:error, any()}

A wrapper around Spear.restart_persistent_subscriptions/2

set_global_acl(user_acl, system_acl)

(since 0.1.0)

@callback set_global_acl(user_acl :: Spear.Acl.t(), system_acl :: Spear.Acl.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.set_global_acl/3

set_global_acl(user_acl, system_acl, opts)

(since 0.1.0)

@callback set_global_acl(
  user_acl :: Spear.Acl.t(),
  system_acl :: Spear.Acl.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.set_global_acl/4

set_node_priority(priority)

(since 0.4.0)

@callback set_node_priority(priority :: integer()) :: :ok | {:error, any()}

A wrapper around Spear.set_node_priority/2

set_node_priority(priority, opts)

(since 0.4.0)

@callback set_node_priority(priority :: integer(), opts :: Keyword.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.set_node_priority/3

set_stream_metadata(stream, metadata)

(since 0.2.1)

@callback set_stream_metadata(stream :: String.t(), metadata :: Spear.StreamMetadata.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.set_stream_metadata/3

set_stream_metadata(stream, metadata, opts)

(since 0.2.1)

@callback set_stream_metadata(
  stream :: String.t(),
  metadata :: Spear.StreamMetadata.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.set_stream_metadata/4

shutdown()

(since 0.4.0)

@callback shutdown() :: :ok | {:error, any()}

A wrapper around Spear.shutdown/1

shutdown(opts)

(since 0.4.0)

@callback shutdown(opts :: Keyword.t()) :: :ok | {:error, any()}

A wrapper around Spear.shutdown/2

start_link(args)

(optional) (since 0.1.0)

@callback start_link(args :: Keyword.t()) :: GenServer.on_start()

Starts a client as part of a supervision tree.

This function is defaulted to pull connection parameters from application config or from the args

examples
Examples

# lib/my_app/application.ex
[
  {MyEventStoreClient, connection_string: "esdb://localhost:2113"},
  ..
]
|> Supervisor.start_link(strategy: :one_for_one)

start_scavenge()

(since 0.4.0)

@callback start_scavenge() :: :ok | {:error, any()}

A wrapper around Spear.start_scavenge/1

start_scavenge(opts)

(since 0.4.0)

@callback start_scavenge(opts :: Keyword.t()) :: :ok | {:error, any()}

A wrapper around Spear.start_scavenge/2

stop_scavenge(scavenge_id)

(since 0.4.0)

@callback stop_scavenge(scavenge_id :: String.t()) :: :ok | {:error, any()}

A wrapper around Spear.stop_scavenge/2

stop_scavenge(scavenge_id, opts)

(since 0.4.0)

@callback stop_scavenge(scavenge_id :: String.t(), opts :: Keyword.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.stop_scavenge/3

stream!(stream_name)

(since 0.1.0)

@callback stream!(stream_name :: String.t() | :all) :: Enumerable.t()

A wrapper around Spear.stream!/2

stream!(stream_name, opts)

(since 0.1.0)

@callback stream!(stream_name :: String.t() | :all, opts :: Keyword.t()) :: Enumerable.t()

A wrapper around Spear.stream!/3

subscribe_to_stats(subscriber)

(since 0.10.0)

@callback subscribe_to_stats(subscriber :: pid() | GenServer.name()) ::
  {:ok, reference()} | {:error, any()}

A wrapper around Spear.subscribe_to_stats/2

subscribe_to_stats(subscriber, opts)

(since 0.10.0)

@callback subscribe_to_stats(subscriber :: pid() | GenServer.name(), opts :: Keyword.t()) ::
  {:ok, reference()} | {:error, any()}

A wrapper around Spear.subscribe_to_stats/3

update_persistent_subscription(stream_name, group_name, settings)

(since 0.6.0)

@callback update_persistent_subscription(
  stream_name :: String.t() | :all,
  group_name :: String.t(),
  settings :: Spear.PersistentSubscription.Settings.t()
) :: :ok | {:error, any()}

A wrapper around Spear.update_persistent_subscription/4

update_persistent_subscription(stream_name, group_name, settings, opts)

(since 0.6.0)

@callback update_persistent_subscription(
  stream_name :: String.t() | :all,
  group_name :: String.t(),
  settings :: Spear.PersistentSubscription.Settings.t(),
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.update_persistent_subscription/5

update_user(full_name, login_name, password, groups)

(since 0.3.0)

@callback update_user(
  full_name :: String.t(),
  login_name :: String.t(),
  password :: String.t(),
  groups :: [String.t()]
) :: :ok | {:error, any()}

A wrapper around Spear.update_user/5

update_user(full_name, login_name, password, groups, opts)

(since 0.3.0)

@callback update_user(
  full_name :: String.t(),
  login_name :: String.t(),
  password :: String.t(),
  groups :: [String.t()],
  opts :: Keyword.t()
) :: :ok | {:error, any()}

A wrapper around Spear.update_user/6

user_details(login_name)

(since 0.3.0)

@callback user_details(login_name :: String.t()) :: :ok | {:error, any()}

A wrapper around Spear.user_details/3

user_details(login_name, opts)

(since 0.3.0)

@callback user_details(login_name :: String.t(), opts :: Keyword.t()) ::
  :ok | {:error, any()}

A wrapper around Spear.user_details/3

Settings View Source Spear.Client behaviour (Spear v1.4.0)

configuration Configuration

examples Examples

Link to this section Summary

Callbacks

Link to this section Callbacks

ack(subscription, event_or_ids)

append(event_stream, stream_name)

append(event_stream, stream_name, opts)

append_batch(event_stream, request_id, stream_name)

append_batch(event_stream, request_id, stream_name, opts)

append_batch_stream(batch_stream)

cancel_subscription(subscription_reference)

cancel_subscription(subscription_reference, timeout)

change_user_password(login_name, current_password, new_password)

change_user_password(login_name, current_password, new_password, opts)

cluster_info()

cluster_info(opts)

connect_to_persistent_subscription(subscriber, stream_name, group_name)

connect_to_persistent_subscription(subscriber, stream_name, group_name, opts)

create_persistent_subscription(stream_name, group_name, settings)

create_persistent_subscription(stream_name, group_name, settings, opts)

create_user(full_name, login_name, password, groups)

create_user(full_name, login_name, password, groups, opts)

delete_persistent_subscription(stream_name, group_name)

delete_persistent_subscription(stream_name, group_name, opts)

delete_stream(stream_name)

delete_stream(stream_name, opts)

delete_user(login_name)

delete_user(login_name, opts)

disable_user(login_name)

disable_user(login_name, opts)

enable_user(login_name)

enable_user(login_name, opts)

get_persistent_subscription_info(stream_name, group_name)

get_persistent_subscription_info(stream_name, group_name, opts)

get_server_version()

get_server_version(t)

get_stream_metadata(stream)

get_stream_metadata(stream, opts)

get_supported_rpcs()

get_supported_rpcs(t)

list_persistent_subscriptions()

list_persistent_subscriptions(opts)

merge_indexes()

merge_indexes(opts)

nack(subscription, event_or_ids)

nack(subscription, event_or_ids, opts)

ping()

ping(timeout)

read_stream(stream_name)

read_stream(stream_name, opts)

replay_parked_messages(stream_name, group_name)

replay_parked_messages(stream_name, group_name, opts)

reset_user_password(login_name, new_password)

reset_user_password(login_name, new_password, opts)

resign_node()

resign_node(opts)

restart_persistent_subscription_subsystem()

restart_persistent_subscription_subsystem(opts)

restart_persistent_subscriptions()

restart_persistent_subscriptions(opts)

set_global_acl(user_acl, system_acl)

set_global_acl(user_acl, system_acl, opts)

set_node_priority(priority)

set_node_priority(priority, opts)

set_stream_metadata(stream, metadata)

set_stream_metadata(stream, metadata, opts)

shutdown()

shutdown(opts)

start_link(args)

examples Examples

start_scavenge()

start_scavenge(opts)

stop_scavenge(scavenge_id)

stop_scavenge(scavenge_id, opts)

stream!(stream_name)

stream!(stream_name, opts)

subscribe(subscriber, stream_name)

subscribe(subscriber, stream_name, opts)

View Source Spear.Client behaviour (Spear v1.4.0)

configuration
Configuration

examples
Examples

examples
Examples