redis

Documentation

Overview

Package redis contains shared functionality related to Redis

Index

• type BasicInterface
  • func NewRedisClient(address string, databaseIndex int, password string, timeoutSeconds int) (BasicInterface, error)
• type Client
  • func (redis *Client) HealthCheck() (err error)

Types

type BasicInterface

type BasicInterface interface {
	HealthCheck() error
}

BasicInterface represents an interface for shared Redis-related functions, which will be extended.

func NewRedisClient

func NewRedisClient(
	address string,
	databaseIndex int,
	password string,
	timeoutSeconds int,
) (BasicInterface, error)

NewRedisClient creates a new Redis client based on configuration and returns RedisInterface

type Client

type Client struct {
	Client *redisV9.Client
}

Client is an implementation of the Redis client for Redis server

func (*Client) HealthCheck

func (redis *Client) HealthCheck() (err error)

HealthCheck executes PING command to check for liveness status of Redis server