mongokit

Documentation

Index

• type Conn
  • func New(addr string, options ...Option) (*Conn, error)
  • func (c *Conn) Close() error
  • func (c *Conn) Health(ctx context.Context) error
• type Option
  • func WithAppName(name string) Option

Types

type Conn

type Conn struct{ *mongo.Client }

Conn wraps the connection to the MongoDB.

func New

func New(addr string, options ...Option) (*Conn, error)

New returns a pointer to a new instance of Conn struct. Receives variadic Option to configure the MongoDB connection settings.

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) Health

func (c *Conn) Health(ctx context.Context) error

Health implements the health.Checker interface for MongoDB connection.

type Option

type Option func(*mongooptions.ClientOptions)

Option configures the mongo options.ClientOptions.

func WithAppName

func WithAppName(name string) Option

WithAppName sets app name to the connection properties.