redis

Documentation

Overview

Package redis contains shared functionality related to Redis

Index

• func CreateRedisClient(address string, databaseIndex int, password string, timeoutSeconds int) (*redisV9.Client, error)
• type Client
  • func (redis *Client) HealthCheck() (err error)

Functions

func CreateRedisClient

func CreateRedisClient(
	address string,
	databaseIndex int,
	password string,
	timeoutSeconds int,
) (*redisV9.Client, error)

CreateRedisClient creates a Redis V9 client, it has explicit checks for config params because the go-redis package lets us create a client with incorrect params so errors are only found during subsequent command executions

Types

type Client

type Client struct {
	Connection *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