db

README

go-db

A simple go module for instantiating a connection to mongodb and reusing it across the go process.

Documentation

Index

• func Close()
• func GetDatabase() (*mongo.Database, error)
• func Initialize(o *ConnectOptions) (*mongo.Database, error)
• type ConnectOptions

Functions

func Close

func Close()

Close resets the state, clearing the persisted client and db objects. Initialize() must be called again.

func GetDatabase

func GetDatabase() (*mongo.Database, error)

GetDatabase returns the instantiated database or errors if Initialize() has not been called

func Initialize

func Initialize(o *ConnectOptions) (*mongo.Database, error)

Initialize a new connection to the database

Types

type ConnectOptions

type ConnectOptions struct {
	ConnectTimeout time.Duration
	DatabaseURL    string
	Database       string
}

ConnectOptions are connection options for the database connection