RedixCluster v1.2.1 RedixCluster View Source

RedixCluster

The main API to interface with a Redis Cluster using Redix as a client.

NOTE: When using Redis, make sure CROSSSLOT Keys in request hash to the same slot.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor

Callback invoked to start the supervisor and during hot code upgrades

Starts RedixCluster as a supervisor in your supervision tree

Link to this section Types

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function command(conn, command, opts \\ []) View Source
command(conn(), command(), Keyword.t()) ::
  {:ok, Redix.Protocol.redis_value()} | {:error, Redix.Error.t() | atom()}

command/3

Runs a command on the Redis cluster.

Link to this function init(conn_name) View Source
init(conn_name :: conn()) :: Supervisor.on_start()

Callback invoked to start the supervisor and during hot code upgrades.

Developers typically invoke Supervisor.init/2 at the end of their init callback to return the proper supervision flags.

Callback implementation for Supervisor.init/1.

Link to this function pipeline(conn, commands, opts \\ []) View Source
pipeline(conn(), [command()], Keyword.t()) ::
  {:ok, [Redix.Protocol.redis_value()]} | {:error, atom()}

pipeline/3

Runs a pipeline on the Redis cluster.

Link to this function start_link(opts \\ []) View Source
start_link(opts :: Keyword.t()) :: Supervisor.on_start()

Starts RedixCluster as a supervisor in your supervision tree.