typredis

package

v0.8.28 Latest Latest Go to latest Published: May 13, 2020 License: MIT Imports: 8 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/typical-go/typical-rest-server

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Commands(c *typgo.BuildTool) []*cli.Command
func Configuration() *typgo.Configuration
func Connect(cfg *Config) (client *redis.Client, err error)
func Disconnect(client *redis.Client) (err error)
func DockerRecipeV3() *typdocker.Recipe
func Utility() typgo.Utility
type Config

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// DefaultDockerName is default value for docker name
	DefaultDockerName = "redis"

	// DefaultDockerImage is default value for docker image
	DefaultDockerImage = "redis:4.0.5-alpine"
)

View Source

var (
	// DefaultConfigName is default value for redis config name
	DefaultConfigName = "REDIS"

	// DefaultHost is default value for redis host
	DefaultHost = "localhost"

	// DefaultPort is default value for redis port
	DefaultPort = "6379"

	// DefaultPassword is default value for redis password
	DefaultPassword = "redispass"

	// DefaultConfig for redis
	DefaultConfig = &Config{
		Host:     DefaultHost,
		Port:     DefaultPort,
		Password: DefaultPassword,
	}
)

Functions ¶

func Commands ¶ added in v0.8.25

func Commands(c *typgo.BuildTool) []*cli.Command

Commands of redis utility

func Configuration ¶ added in v0.8.25

func Configuration() *typgo.Configuration

Configuration of redis

func Connect ¶ added in v0.8.25

func Connect(cfg *Config) (client *redis.Client, err error)

Connect redis server

func Disconnect ¶ added in v0.8.25

func Disconnect(client *redis.Client) (err error)

Disconnect from redis server

func DockerRecipeV3 ¶ added in v0.8.25

func DockerRecipeV3() *typdocker.Recipe

DockerRecipeV3 return recipe for docker-compose v3

func Utility ¶ added in v0.8.25

func Utility() typgo.Utility

Utility of redis

Types ¶

type Config ¶

type Config struct {
	Host     string `required:"true" default:"localhost"`
	Port     string `required:"true" default:"6379"`
	Password string `default:"redispass"`
	DB       int    `default:"0"`

	PoolSize           int           `envconfig:"POOL_SIZE"  default:"20" required:"true"`
	DialTimeout        time.Duration `envconfig:"DIAL_TIMEOUT" default:"5s" required:"true"`
	ReadWriteTimeout   time.Duration `envconfig:"READ_WRITE_TIMEOUT" default:"3s" required:"true"`
	IdleTimeout        time.Duration `envconfig:"IDLE_TIMEOUT" default:"5m" required:"true"`
	IdleCheckFrequency time.Duration `envconfig:"IDLE_CHECK_FREQUENCY" default:"1m" required:"true"`
	MaxConnAge         time.Duration `envconfig:"MAX_CONN_AGE" default:"30m" required:"true"`
}

Config is Redis Configuration

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL