redix_pool

v0.1.0

redix_pool v0.1.0 RedixPool

This module provides an API for using Redix through a pool of workers.

Overview

RedixPool is very simple, it is merely wraps Redix with a pool of Poolboy workers. All function calls get passed through to a Redix connection.

Please see the redix library for more in-depth documentation. Many of the examples in this documentation are pulled directly from the Redix docs.

Link to this section Summary

Types

command()

Functions

command(args, opts \\ [])

Wrapper to call Redix.command/3 inside a poolboy worker

command!(args, opts \\ [])

Wrapper to call Redix.command!/3 inside a poolboy worker, raising if there’s an error

pipeline(args, opts \\ [])

Wrapper to call Redix.pipeline/3 inside a poolboy worker

pipeline!(args, opts \\ [])

Wrapper to call Redix.pipeline!/3 inside a poolboy worker, raising if there are errors issuing the commands (but not if the commands are successfully issued and result in errors)

start(type, args)

Called when an application is started

Link to this section Types

Link to this type command() 
command() :: [binary]

Link to this section Functions

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

Wrapper to call Redix.command/3 inside a poolboy worker.

Examples 

iex> RedixPool.command(["SET", "k", "foo"])
{:ok, "OK"}
iex> RedixPool.command(["GET", "k"])
{:ok, "foo"}

iex> RedixPool.command(["INCR", "k"])
{:error, "ERR value is not an integer or out of range"}
Link to this function command!(args, opts \\ []) 
command!(command, Keyword.t) ::
  Redix.Protocol.redis_value |
  no_return

Wrapper to call Redix.command!/3 inside a poolboy worker, raising if there’s an error.

Examples 

iex> RedixPool.command!(["SET", "k", "foo"])
"OK"
iex> RedixPool.command!(["GET", "k"])
"foo"

iex> RedixPool.command!(["INCR", "k"])
** (Redix.Error) ERR value is not an integer or out of range
Link to this function pipeline(args, opts \\ []) 
pipeline([command], Keyword.t) ::
  {:ok, [Redix.Protocol.redis_value]} |
  {:error, atom}

Wrapper to call Redix.pipeline/3 inside a poolboy worker.

Examples 

iex> RedixPool.pipeline([["INCR", "mykey"], ["INCR", "mykey"], ["DECR", "mykey"]])
{:ok, [1, 2, 1]}

iex> RedixPool.pipeline([["SET", "k", "foo"], ["INCR", "k"], ["GET", "k"]])
{:ok, ["OK", %Redix.Error{message: "ERR value is not an integer or out of range"}, "foo"]}
Link to this function pipeline!(args, opts \\ []) 
pipeline!([command], Keyword.t) ::
  [Redix.Protocol.redis_value] |
  no_return

Wrapper to call Redix.pipeline!/3 inside a poolboy worker, raising if there are errors issuing the commands (but not if the commands are successfully issued and result in errors).

Examples 

iex> RedixPool.pipeline!([["INCR", "mykey"], ["INCR", "mykey"], ["DECR", "mykey"]])
[1, 2, 1]

iex> RedixPool.pipeline!([["SET", "k", "foo"], ["INCR", "k"], ["GET", "k"]])
["OK", %Redix.Error{message: "ERR value is not an integer or out of range"}, "foo"]
Link to this function start(type, args)

Called when an application is started.

This function is called when an the application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application’s supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

  • :normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another mode and the application specification key :start_phases is :undefined.
  • {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
  • {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the PID of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the c:stop/1 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.