mongodb

README

MongoDB

Environment Variables

MONGODB_DATABASE: Database name
MONGODB_URI:      Connection URI

Documentation

Overview

Package mongodb provides a mongodb fx module.

import "github.com/lucaskatayama/fx-contrib/mongodb"

Example

This is a simple usage of mongodb.Module with fx

package main

import (
	"go.uber.org/fx"

	"github.com/lucaskatayama/fx-contrib/mongodb"
)

func main() {
	// export MONGODB_DATABASE=db
	app := fx.New(
		mongodb.Module,
	)
	app.Run()
}

Example (Example1)

Setting MONGODB_URI

package main

import (
	"go.uber.org/fx"

	"github.com/lucaskatayama/fx-contrib/mongodb"
)

func main() {
	// export MONGODB_URI=mongodb://localhost:27017
	app := fx.New(
		mongodb.Module,
	)
	app.Run()
}

Index

• Variables

Examples

• Package
• Package (Example1)

Variables

var (
	// ErrDBNameRequired is returned when MONGODB_DATABASE name is not defined on environment variables
	ErrDBNameRequired = errors.New("MONGODB_DATABASE is required")
)

var Module = fx.Options(
	fx.Provide(new),
	fx.Provide(newDatabase),
	fx.Provide(check),
	fx.Invoke(lifecycle),
)

Module defines a mongodb module for fx.