mongoex

Documentation

Overview

Package mongoex contains a variety of tools for working safely with MongoDB.

There are tools for: - observability (both for queries and connection info) - health checks

Index

• func Load(ctx context.Context, appName string, cfg Config, sys *system.System) (*mongo.Client, error)
• func New(ctx context.Context, appName string, cfg Config) (client *mongo.Client, err error)
• func Span(ctx context.Context, entity, queryName string) (context.Context, o11y.Span)
• type Config

Functions

func Load

func Load(ctx context.Context, appName string, cfg Config, sys *system.System) (*mongo.Client, error)

Load connects to mongo. The context passed in is expected to carry an o11y provider and is only used for reporting (not for cancellation),

func New

func New(ctx context.Context, appName string, cfg Config) (client *mongo.Client, err error)

New connects to mongo. The context passed in is expected to carry an o11y provider and is only used for reporting (not for cancellation),

func Span

func Span(ctx context.Context, entity, queryName string) (context.Context, o11y.Span)

Span provides a o11y span to ensure our database queries are reported consistently.

Types

type Config

type Config struct {
	URI    string
	UseTLS bool

	Options *options.ClientOptions
}