mongodb

Documentation

Overview

Package mongodb contains the domain concept definitions needed to support Magistrala Mongo database functionality.

It provides the abstraction of the Mongo database service, which is used to configure, setup and connect to the Mongo database.

Index

• func Connect(cfg Config) (*mongo.Database, error)
• func Setup(envPrefix string) (*mongo.Database, error)
• type Config

Functions

func Connect

func Connect(cfg Config) (*mongo.Database, error)

Connect creates a connection to the MongoDB instance.

func Setup

func Setup(envPrefix string) (*mongo.Database, error)

Setup load configuration from environment, create new MongoDB client and connect to MongoDB server.

Types

type Config

type Config struct {
	Host string `env:"HOST" envDefault:"localhost"`
	Port string `env:"PORT" envDefault:"27017"`
	Name string `env:"NAME" envDefault:"messages"`
}

Config defines the options that are used when connecting to a MongoDB instance.