client

Documentation

Index

• func ConfigDocs() docs.FieldSpecs
• type Config
  • func NewConfig() Config
  • func (m Config) Client() (*mongo.Client, error)
• type WriteConcern

Functions

func ConfigDocs

func ConfigDocs() docs.FieldSpecs

ConfigDocs returns a documentation field spec for fields within a Config.

Types

type Config

type Config struct {
	URL        string `json:"url" yaml:"url"`
	Database   string `json:"database" yaml:"database"`
	Collection string `json:"collection" yaml:"collection"`
	Username   string `json:"username" yaml:"username"`
	Password   string `json:"password" yaml:"password"`
}

Config is a config struct for a mongo connection

func NewConfig

func NewConfig() Config

NewConfig returns a Config with default values.

func (Config) Client

func (m Config) Client() (*mongo.Client, error)

Client returns a new mongodb client based on the configuration parameters

type WriteConcern

type WriteConcern struct {
	W        string `json:"w" yaml:"w"`
	J        bool   `json:"j" yaml:"j"`
	WTimeout string `json:"w_timeout" yaml:"w_timeout"`
}

WriteConcern describes a write concern for MongoDB.