redis

Documentation

Overview

redis provides the Redis implementation of the StoreClient interface.

Index

• func NewClient(config db.DatabaseInfo, credentials bootstrapConfig.Credentials) (interfaces.StoreClient, error)
• type Client
  • func (c Client) Disconnect() error
  • func (c Client) RemoveFromStore(o contracts.StoredObject) error
  • func (c Client) RetrieveFromStore(appServiceKey string) (objects []contracts.StoredObject, err error)
  • func (c Client) Store(o contracts.StoredObject) (string, error)
  • func (c Client) Update(o contracts.StoredObject) error

Functions

func NewClient

func NewClient(config db.DatabaseInfo, credentials bootstrapConfig.Credentials) (interfaces.StoreClient, error)

NewClient provides a factory for building a StoreClient

Types

type Client

type Client struct {
	Pool      *redis.Pool // A thread-safe pool of connections to Redis
	BatchSize int
}

Client provides an implementation for the Client interface for Redis

func (Client) Disconnect

func (c Client) Disconnect() error

Disconnect ends the connection.

func (Client) RemoveFromStore

func (c Client) RemoveFromStore(o contracts.StoredObject) error

RemoveFromStore removes an object from the data store.

func (Client) RetrieveFromStore

func (c Client) RetrieveFromStore(appServiceKey string) (objects []contracts.StoredObject, err error)

RetrieveFromStore gets an object from the data store.

func (Client) Store

func (c Client) Store(o contracts.StoredObject) (string, error)

Store persists a stored object to the data store. Three ("Three shall be the number thou shalt count, and the number of the counting shall be three") keys are used:

• the object id to point to a STRING which is the marshal'ed JSON.
• the object AppServiceKey to point to a SET containing all object ids associated with this app service. Note the key is prefixed to avoid key collisions.
• the object id to point to a HASH which contains the object AppServiceKey.

func (Client) Update

func (c Client) Update(o contracts.StoredObject) error

Update replaces the data currently in the store with the provided data.