redis

Documentation

Index

• Variables
• type Client
  • func OpenClient(ctx context.Context, address, password string, db int) (*Client, error)
  • func OpenClientFrom(ctx context.Context, address string) (*Client, error)
  • func (client *Client) Close() error
  • func (client *Client) CompareAndSwap(ctx context.Context, key storage.Key, oldValue, newValue storage.Value) (err error)
  • func (client *Client) Delete(ctx context.Context, key storage.Key) (err error)
  • func (client *Client) DeleteMultiple(ctx context.Context, keys []storage.Key) (_ storage.Items, err error)
  • func (client *Client) Eval(ctx context.Context, script string, keys []string) (err error)
  • func (client *Client) FlushDB(ctx context.Context) error
  • func (client *Client) Get(ctx context.Context, key storage.Key) (_ storage.Value, err error)
  • func (client *Client) GetAll(ctx context.Context, keys storage.Keys) (_ storage.Values, err error)
  • func (client *Client) IncrBy(ctx context.Context, key storage.Key, value int64) (err error)
  • func (client *Client) Iterate(ctx context.Context, opts storage.IterateOptions, ...) (err error)
  • func (client *Client) IterateUnordered(ctx context.Context, fn func(context.Context, storage.Iterator) error) (err error)
  • func (client *Client) IterateWithoutLookupLimit(ctx context.Context, opts storage.IterateOptions, ...) (err error)
  • func (client *Client) List(ctx context.Context, first storage.Key, limit int) (_ storage.Keys, err error)
  • func (client *Client) LookupLimit() int
  • func (client *Client) Put(ctx context.Context, key storage.Key, value storage.Value) (err error)
  • func (client *Client) SetLookupLimit(v int)
• type ScanIterator
  • func (it *ScanIterator) Next(ctx context.Context, item *storage.ListItem) bool
• type StaticIterator
  • func (it *StaticIterator) Next(ctx context.Context, item *storage.ListItem) bool

Variables

var (
	// Error is a redis error.
	Error = errs.Class("redis")
)

Types

type Client

type Client struct {
	TTL time.Duration
	// contains filtered or unexported fields
}

Client is the entrypoint into Redis.

func OpenClient

func OpenClient(ctx context.Context, address, password string, db int) (*Client, error)

OpenClient returns a configured Client instance, verifying a successful connection to redis.

func OpenClientFrom

func OpenClientFrom(ctx context.Context, address string) (*Client, error)

OpenClientFrom returns a configured Client instance from a redis address, verifying a successful connection to redis.

func (*Client) Close

func (client *Client) Close() error

Close closes a redis client.

func (*Client) CompareAndSwap

func (client *Client) CompareAndSwap(ctx context.Context, key storage.Key, oldValue, newValue storage.Value) (err error)

CompareAndSwap atomically compares and swaps oldValue with newValue.

func (*Client) Delete

func (client *Client) Delete(ctx context.Context, key storage.Key) (err error)

Delete deletes a key/value pair from redis, for a given the key.

func (*Client) DeleteMultiple

func (client *Client) DeleteMultiple(ctx context.Context, keys []storage.Key) (_ storage.Items, err error)

DeleteMultiple deletes keys ignoring missing keys.

func (*Client) Eval

func (client *Client) Eval(ctx context.Context, script string, keys []string) (err error)

Eval evaluates a Lua 5.1 script on Redis Server. This arguments can be accessed by Lua using the KEYS global variable in the form of a one-based array (so KEYS[1], KEYS[2], ...).

func (*Client) FlushDB

func (client *Client) FlushDB(ctx context.Context) error

FlushDB deletes all keys in the currently selected DB.

func (*Client) Get

func (client *Client) Get(ctx context.Context, key storage.Key) (_ storage.Value, err error)

Get looks up the provided key from redis returning either an error or the result.

func (*Client) GetAll

func (client *Client) GetAll(ctx context.Context, keys storage.Keys) (_ storage.Values, err error)

GetAll is the bulk method for gets from the redis data store. The maximum keys returned will be LookupLimit. If more than that is requested, an error will be returned.

func (*Client) IncrBy

func (client *Client) IncrBy(ctx context.Context, key storage.Key, value int64) (err error)

IncrBy increments the value stored in key by the specified value.

func (*Client) Iterate

func (client *Client) Iterate(ctx context.Context, opts storage.IterateOptions, fn func(context.Context, storage.Iterator) error) (err error)

Iterate iterates over items based on opts.

func (*Client) IterateUnordered

func (client *Client) IterateUnordered(ctx context.Context, fn func(context.Context, storage.Iterator) error) (err error)

IterateUnordered iterates over all data, however, does not guarantee ordering. It only guarantees all items are iterated at least once.

func (*Client) IterateWithoutLookupLimit

func (client *Client) IterateWithoutLookupLimit(ctx context.Context, opts storage.IterateOptions, fn func(context.Context, storage.Iterator) error) (err error)

IterateWithoutLookupLimit calls the callback with an iterator over the keys, but doesn't enforce default limit on opts.

func (*Client) List

func (client *Client) List(ctx context.Context, first storage.Key, limit int) (_ storage.Keys, err error)

List returns either a list of keys for which boltdb has values or an error.

func (*Client) LookupLimit

func (client *Client) LookupLimit() int

LookupLimit returns the maximum limit that is allowed.

func (*Client) Put

func (client *Client) Put(ctx context.Context, key storage.Key, value storage.Value) (err error)

Put adds a value to the provided key in redis, returning an error on failure.

func (*Client) SetLookupLimit

func (client *Client) SetLookupLimit(v int)

SetLookupLimit sets the lookup limit.

type ScanIterator

type ScanIterator struct {
	// contains filtered or unexported fields
}

ScanIterator iterates over scan command items.

func (*ScanIterator) Next

func (it *ScanIterator) Next(ctx context.Context, item *storage.ListItem) bool

Next returns the next item from the iterator.

type StaticIterator

type StaticIterator struct {
	Items storage.Items
	Index int
}

StaticIterator implements an iterator over list of items.

func (*StaticIterator) Next

func (it *StaticIterator) Next(ctx context.Context, item *storage.ListItem) bool

Next returns the next item from the iterator.