mongoabstraction

README

mongoabstraction

A attempt to abstract mongodb connectivity in golang

Documentation

Index

• Constants
• Variables
• type ClientHelper
  • func NewClient() (ClientHelper, error)
• type CollectionHelper
• type DatabaseHelper
• type MongoResults
• type SingleResultHelper

Constants

const (
	DatabaseName   string = "testdb"
	CollectionName string = "movies"
)

Variables

var (
	DBError error
)

Types

type ClientHelper

type ClientHelper interface {
	Database(string) DatabaseHelper
	Connect(context.Context) error
	StartSession() (mongo.Session, error)
	CheckConnection(context.Context) error
}

func NewClient

func NewClient() (ClientHelper, error)

type CollectionHelper

type CollectionHelper interface {
	FindOne(context.Context, interface{}) SingleResultHelper
	FindMany(ctx context.Context, filter interface{}) (MongoResults, error)
	InsertOne(context.Context, interface{}) (interface{}, error)
	DeleteOne(ctx context.Context, filter interface{}) (int64, error)
}

type DatabaseHelper

type DatabaseHelper interface {
	Collection(name string) CollectionHelper
	Client() ClientHelper
}

type MongoResults

type MongoResults struct {
	RS []bson.M
}

type SingleResultHelper

type SingleResultHelper interface {
	Decode(v interface{}) error
}