redis

Documentation

Overview

Package redis provides a client for interacting with Redis key-value stores.This package allows creating and managing Redis clients, executing Redis commands, and handling connections to Redis databases.

Package redis is a generated GoMock package.

Index

• type Config
• type Metrics
• type MockMetrics
  • func NewMockMetrics(ctrl *gomock.Controller) *MockMetrics
  • func (m *MockMetrics) EXPECT() *MockMetricsMockRecorder
  • func (m *MockMetrics) RecordHistogram(ctx context.Context, name string, value float64, labels ...string)
• type MockMetricsMockRecorder
  • func (mr *MockMetricsMockRecorder) RecordHistogram(ctx, name, value interface{}, labels ...interface{}) *gomock.Call
• type QueryLog
  • func (ql *QueryLog) PrettyPrint(writer io.Writer)
  • func (ql *QueryLog) String() string
• type Redis
  • func NewClient(c config.Config, logger datasource.Logger, metrics Metrics) *Redis
  • func (r *Redis) Close() error
  • func (r *Redis) HealthCheck() datasource.Health

Types

type Config

type Config struct {
	HostName string
	Username string
	Password string
	Port     int
	DB       int
	Options  *redis.Options
}

type Metrics

type Metrics interface {
	RecordHistogram(ctx context.Context, name string, value float64, labels ...string)
}

type MockMetrics

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

MockMetrics is a mock of Metrics interface.

func NewMockMetrics

func NewMockMetrics(ctrl *gomock.Controller) *MockMetrics

NewMockMetrics creates a new mock instance.

func (*MockMetrics) EXPECT

func (m *MockMetrics) EXPECT() *MockMetricsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockMetrics) RecordHistogram

func (m *MockMetrics) RecordHistogram(ctx context.Context, name string, value float64, labels ...string)

RecordHistogram mocks base method.

type MockMetricsMockRecorder

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

MockMetricsMockRecorder is the mock recorder for MockMetrics.

func (*MockMetricsMockRecorder) RecordHistogram

func (mr *MockMetricsMockRecorder) RecordHistogram(ctx, name, value interface{}, labels ...interface{}) *gomock.Call

RecordHistogram indicates an expected call of RecordHistogram.

type QueryLog

type QueryLog struct {
	Query    string      `json:"query"`
	Duration int64       `json:"duration"`
	Args     interface{} `json:"args,omitempty"`
}

QueryLog represents a logged Redis query.

func (*QueryLog) PrettyPrint

func (ql *QueryLog) PrettyPrint(writer io.Writer)

func (*QueryLog) String

func (ql *QueryLog) String() string

type Redis

type Redis struct {
	*redis.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(c config.Config, logger datasource.Logger, metrics Metrics) *Redis

NewClient return a redis client if connection is successful based on Config. In case of error, it returns an error as second parameter.

func (*Redis) Close

func (r *Redis) Close() error

Close shuts down the Redis client, ensuring the current dataset is saved before exiting.

func (*Redis) HealthCheck

func (r *Redis) HealthCheck() datasource.Health