mongodb

Documentation

Overview

Package mongodb is a module for mongodb

Index

• type MongoDBContext
  • func NewMongoDB(opts ...Option) (MongoDBContext, error)
• type MongoDBOptions
• type Option
  • func WithMongoDBDatabase(database string) Option
  • func WithMongoDBPassword(password string) Option
  • func WithMongoDBURI(uri string) Option
  • func WithMongoDBUsername(username string) Option

Types

type MongoDBContext

type MongoDBContext interface {
	// GetConn returns the mongodb connection
	GetConn() *mongo.Client

	// GetDatabase returns the mongodb database
	GetDatabase() *mongo.Database

	// Close closes the mongodb connection
	Close() error

	// Ping pings the mongodb connection
	Ping() error
}

func NewMongoDB

func NewMongoDB(opts ...Option) (MongoDBContext, error)

NewMongoDB creates a new mongodb connection

type MongoDBOptions

type MongoDBOptions struct {
	URI      string
	Database string
	Username string
	Password string
}

MongoDBOptions defines the mongo configuration

type Option

type Option func(*MongoDBOptions)

Option is the func interface to assign options

func WithMongoDBDatabase

func WithMongoDBDatabase(database string) Option

WithMongoDBDatabase defines the Mongo Connection Database

func WithMongoDBPassword

func WithMongoDBPassword(password string) Option

WithMongoDBPassword defines the Mongo Connection password

func WithMongoDBURI

func WithMongoDBURI(uri string) Option

WithMongoDBURI defines the Mongo Connection URI

func WithMongoDBUsername

func WithMongoDBUsername(username string) Option

WithMongoDBUsername defines the Mongo Connection Username