redigo

package module
v3.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 8, 2021 License: MIT Imports: 9 Imported by: 1

README

GoZix Redigo

Dependencies

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

Index

Constants

View Source 
const BundleName = "redigo"

BundleName is default definition name.

View Source 
const DEFAULT = "default"

DEFAULT is default connection name.

Variables

View Source 
var (
	// ErrUnknownConnection is error triggered when connection with provided name not founded.
	ErrUnknownConnection = errors.New("unknown connection")
)

Functions

This section is empty.

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 Pool 

type Pool = redis.Pool

Pool is type alias of redis.Pool

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.