redigo

README

GoZix Redigo

The bundle provide a Redigo integration to GoZix application.

Installation

go get github.com/gozix/redigo/v4

Dependencies

• viper

Configuration example

{
  "redis": {
    "default": {
      "host": "127.0.0.1",
      "port": "6379",
      "db": 0,
      "password": "somepassword",
      "max_idle": 3,
      "max_active": 100,
      "idle_timeout": "4m"
    }
  }
}

"password" field is optional and ignored if empty "db" field is optional. Default is 0

Documentation

You can find documentation on pkg.go.dev and read source code if needed.

Questions

If you have any questions, feel free to create an issue.

Documentation

Index

• Constants
• Variables
• type Bundle
  • func NewBundle() *Bundle
  • func (b *Bundle) Build(builder di.Builder) error
  • func (b *Bundle) DependsOn() []string
  • func (b *Bundle) Name() string
• type Config
• type Configs
• type Registry
  • func NewRegistry(conf Configs) *Registry
  • func (r *Registry) Close() (err error)
  • func (r *Registry) Connection() (*redis.Pool, error)
  • func (r *Registry) ConnectionWithName(name string) (_ *redis.Pool, err error)

Constants

const BundleName = "redigo"

BundleName is default definition name.

const (
	// DEFAULT is default connection name.
	DEFAULT = "default"
)

Variables

var ErrUnknownConnection = errors.New("unknown connection")

ErrUnknownConnection is error triggered when connection with provided name not founded.

Types

type Bundle

type Bundle struct{}

Bundle implements the glue.Bundle interface.

func NewBundle

func NewBundle() *Bundle

NewBundle create bundle instance.

func (*Bundle) Build

func (b *Bundle) Build(builder di.Builder) error

Build implements the glue.Bundle interface.

func (*Bundle) DependsOn

func (b *Bundle) DependsOn() []string

DependsOn implements the glue.DependsOn interface.

func (*Bundle) Name

func (b *Bundle) Name() string

Name implements the glue.Bundle interface.

type Config

type Config struct {
	Host        string        `json:"host"`
	Port        string        `json:"port"`
	DB          int           `json:"db"`
	Password    string        `json:"password"`
	MaxIdle     int           `json:"max_idle"`
	MaxActive   int           `json:"max_active"`
	IdleTimeout time.Duration `json:"idle_timeout"`
}

Config is registry configuration item.

type Configs

type Configs map[string]Config

Configs is registry configurations.

type Registry

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

Registry is database connection registry.

func NewRegistry

func NewRegistry(conf Configs) *Registry

NewRegistry is registry constructor.

func (*Registry) Close

func (r *Registry) Close() (err error)

Close is method for close connections.

func (*Registry) Connection

func (r *Registry) Connection() (*redis.Pool, error)

Connection is default connection getter.

func (*Registry) ConnectionWithName

func (r *Registry) ConnectionWithName(name string) (_ *redis.Pool, err error)

ConnectionWithName is connection getter by name.