redisdb

Documentation

Overview

Package implements the redis database helpers

Index

• func GetRedis() *goredis.Client
• func New(dbc *databasecredhelper.VaultDBCredentials, host string, port string) *rediscon
• func Ping() bool
• type RedisDB

Functions

func GetRedis

func GetRedis() *goredis.Client

GetRedis function returns a pointer to the `goredis.Client` instance used to communicate with Redis server. The function simply returns the Redis client instance stored in a `redisdb` singleton object. This function is used to obtain the Redis client connection in other parts of the application.

func New

func New(dbc *databasecredhelper.VaultDBCredentials, host string, port string) *rediscon

func Ping

func Ping() bool

Ping the redis connection

Types

type RedisDB

type RedisDB interface {
	Get(ctx context.Context, key string, output *string) error
	Set(ctx context.Context, key string, value interface{}, expiration time.Duration) error
	Delete(ctx context.Context, key string) error
	GetJSON(context.Context, string, string, interface{}) error
	SetJSON(ctx context.Context, key string, path string, value interface{}) error
	clients.CommonClient
}