mongo

Documentation

Overview

Package mongo implements a probe client for the MongoDB database.

Index

• Constants
• type Mongo
  • func New(opt conf.Options) (*Mongo, error)
  • func (r *Mongo) Kind() string
  • func (r *Mongo) Probe() (bool, string)

Constants

const Kind string = "Mongo"

Kind is the type of driver

Types

type Mongo

type Mongo struct {
	conf.Options `yaml:",inline"`
	ConnStr      string                 `yaml:"conn_str,omitempty" json:"conn_str,omitempty"`
	ClientOpt    *options.ClientOptions `yaml:"-" json:"-"`
	Context      context.Context        `yaml:"-" json:"-"`
}

Mongo is the Mongo client

func New

func New(opt conf.Options) (*Mongo, error)

New create a Mongo client

func (*Mongo) Kind

func (r *Mongo) Kind() string

Kind return the name of client

func (*Mongo) Probe

func (r *Mongo) Probe() (bool, string)

Probe do the health check