mgo_session

Documentation

Index

• func DialWithInfo(info *DialInfo, enableTLS bool) (*mongo.Client, error)
• func New(c *Config) (*mongo.Client, error)
• type Config
  • func (c *Config) Validate(configKey string) error
• type DialInfo
• type ServerAddr

Functions

func DialWithInfo

func DialWithInfo(info *DialInfo, enableTLS bool) (*mongo.Client, error)

func New

func New(c *Config) (*mongo.Client, error)

Types

type Config

type Config struct {
	DialInfo DialInfo `yaml:",inline"`

	PasswordFile string `yaml:"password_file,omitempty"`
	EnableTLS    bool   `yaml:"enable_tls,omitempty"`
}

Config stores how to connect to the MongoDB server and an optional password file

func (*Config) Validate

func (c *Config) Validate(configKey string) error

Validate ensures the most common fields inside the mgo.DialInfo portion of a Config are set correctly as well as other fields inside the Config itself.

type DialInfo

type DialInfo struct {
	// Addrs holds the addresses for the seed servers.
	Addrs []string

	// Direct informs whether to establish connections only with the
	// specified seed servers, or to obtain information for the whole
	// cluster and establish connections with further servers too.
	Direct bool

	// Timeout is the amount of time to wait for a server to respond when
	// first connecting and on follow up operations in the session. If
	// timeout is zero, the call may block forever waiting for a connection
	// to be established.
	Timeout time.Duration

	// FailFast will cause connection and query attempts to fail faster when
	// the server is unavailable, instead of retrying until the configured
	// timeout period. Note that an unavailable server may silently drop
	// packets instead of rejecting them, in which case it's impossible to
	// distinguish it from a slow server, so the timeout stays relevant.
	FailFast bool

	// Database is the default database name used when the Session.DB method
	// is called with an empty name, and is also used during the intial
	// authenticatoin if Source is unset.
	Database string

	// Source is the database used to establish credentials and privileges
	// with a MongoDB server. Defaults to the value of Database, if that is
	// set, or "admin" otherwise.
	Source string

	// Service defines the service name to use when authenticating with the GSSAPI
	// mechanism. Defaults to "mongodb".
	Service string

	// Mechanism defines the protocol for credential negotiation.
	// Defaults to "MONGODB-CR".
	Mechanism string

	// Username and Password inform the credentials for the initial authentication
	// done on the database defined by the Source field. See Session.Login.
	Username string
	Password string

	// DialServer optionally specifies the dial function for establishing
	// connections with the MongoDB servers.
	DialServer func(addr *ServerAddr) (net.Conn, error)

	// WARNING: This field is obsolete. See DialServer above.
	Dial func(addr net.Addr) (net.Conn, error)
}

type ServerAddr

type ServerAddr struct {
}