cache

README

Cache

Cache is a lib to simplify the cache connection and trace it.

Installation

go get github.com/facily-tech/go-core/cache

Documentation

Overview

Package cache help us to connect to the cache using the redis library and with tracing.

Index

• Constants
• Variables
• type Client
  • func InitCache() (*Client, error)
  • func (r *Client) Del(ctx context.Context, keys ...string) error
  • func (r *Client) Get(ctx context.Context, key string) (string, error)
  • func (r *Client) Set(ctx context.Context, key string, value string, expire time.Duration) error
• type ClientI

Constants

const CachePrefix = "CACHE_"

CachePrefix is the prefix for the environment variables.

Variables

var ErrKeyMiss = errors.New("key does not exist")

ErrKeyMiss is the error returned when the key does not exist.

Types

type Client

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

Client is the interface for the cache.

func InitCache

func InitCache() (*Client, error)

InitCache initializes the cache.

func (*Client) Del

func (r *Client) Del(ctx context.Context, keys ...string) error

Del deletes one or more keys.

func (*Client) Get

func (r *Client) Get(ctx context.Context, key string) (string, error)

Get gets the value of a key.

func (*Client) Set

func (r *Client) Set(ctx context.Context, key string, value string, expire time.Duration) error

Set define the value of a key.

type ClientI

type ClientI interface {
	Set(context.Context, string, string, time.Duration) error
	Get(context.Context, string) (string, error)
	Del(context.Context, ...string) error
}

ClientI is the interface for the cache.