mgoutil

Documentation

Overview

Package mgoutil provides utilities for working with mgo library.

Index

• func Dial(conf *Config) (*mgo.Session, error)
• func HealthCheck(s *mgo.Session) health.CheckFunc
• type Config
  • func ReadConfigFromEnv(opts ...config.ReadOption) *Config
  • func (conf *Config) DialInfo() *mgo.DialInfo

Functions

func Dial

func Dial(conf *Config) (*mgo.Session, error)

Dial dial to target server with Monotonic mode

func HealthCheck

func HealthCheck(s *mgo.Session) health.CheckFunc

HealthCheck return a health check function.

Types

type Config

type Config struct {
	Addrs    []string      `envconfig:"MONGODB_ADDRS" default:"mongodb:27017"`
	Database string        `envconfig:"MONGODB_DATABASE" default:"goway"`
	Username string        `envconfig:"MONGODB_USERNAME"`
	Password string        `envconfig:"MONGODB_PASSWORD"`
	Timeout  time.Duration `envconfig:"MONGODB_TIMEOUT" default:"10s"`
	Mode     mgo.Mode      `envconfig:"MONGODB_MODE" default:"1"`
	Refresh  bool          `envconfig:"MONGODB_REFRESH" default:"true"`
}

Config hold MongoDB common configuration.

func ReadConfigFromEnv

func ReadConfigFromEnv(opts ...config.ReadOption) *Config

ReadConfigFromEnv returns a Config object populated from environment variables.

func (*Config) DialInfo

func (conf *Config) DialInfo() *mgo.DialInfo

DialInfo return dial info from config