mongodb

Documentation

Index

• func Disconnect(connection *Connection)
• type Collection
  • func NewCollection(name string, singleFieldIndexes *[]*SingleFieldIndex, ...) *Collection
  • func (c *Collection) CreateCollection(database *mongo.Database) (collection *mongo.Collection, err error)
• type CompoundFieldIndex
  • func NewCompoundFieldIndex(fieldIndexes []*FieldIndex, unique bool) *CompoundFieldIndex
• type Config
• type Connection
  • func Connect(config *Config) (connection *Connection, err error)
• type FieldIndex
  • func NewFieldIndex(name string, order Order) *FieldIndex
• type Order
  • func (o Order) OrderInt() int
• type SingleFieldIndex
  • func NewSingleFieldIndex(fieldIndex FieldIndex, unique bool) *SingleFieldIndex

Functions

func Disconnect

func Disconnect(connection *Connection)

Disconnect closes the MongoDB client connection

Types

type Collection

type Collection struct {
	Name               string
	SingleFieldIndexes *[]*SingleFieldIndex
	CompoundIndexes    *[]*CompoundFieldIndex
}

Collection represents a MongoDB collection

func NewCollection

func NewCollection(name string, singleFieldIndexes *[]*SingleFieldIndex, compoundIndexes *[]*CompoundFieldIndex) *Collection

NewCollection creates a new MongoDB collection

func (*Collection) CreateCollection

func (c *Collection) CreateCollection(database *mongo.Database) (collection *mongo.Collection, err error)

CreateCollection creates the collection

type CompoundFieldIndex

type CompoundFieldIndex struct {
	Model *mongo.IndexModel
}

CompoundFieldIndex represents a compound field index

func NewCompoundFieldIndex

func NewCompoundFieldIndex(fieldIndexes []*FieldIndex, unique bool) *CompoundFieldIndex

NewCompoundFieldIndex creates a new compound field index

type Config

type Config struct {
	Uri     string
	Timeout time.Duration
}

type Connection

type Connection struct {
	Config *Config
	Client *mongo.Client
	Ctx    context.Context
	Cancel context.CancelFunc
}

func Connect

func Connect(config *Config) (connection *Connection, err error)

Connect returns a new MongoDB client

type FieldIndex

type FieldIndex struct {
	Name  string
	Order Order
}

func NewFieldIndex

func NewFieldIndex(name string, order Order) *FieldIndex

NewFieldIndex creates a new field index

type Order

type Order int

const (
	// Ascending order
	Ascending Order = 1

	// Descending order
	Descending Order = -1
)

func (Order) OrderInt

func (o Order) OrderInt() int

OrderInt converts the Order type to an integer

type SingleFieldIndex

type SingleFieldIndex struct {
	Model *mongo.IndexModel
}

func NewSingleFieldIndex

func NewSingleFieldIndex(fieldIndex FieldIndex, unique bool) *SingleFieldIndex

NewSingleFieldIndex creates a new single field index