mongo

README

MongoDB module

This repository contains code to deal with MongoDB operations used by FOXDEN/CHESS services. It covers read/write/update/delete APIs.

Documentation

Index

• Constants
• func Count(dbname, collname string, spec bson.M) int
• func ErrorRecord(msg, etype string, ecode int) map[string]any
• func Get(dbname, collname string, spec bson.M, idx, limit int) []map[string]any
• func GetInt64Value(rec map[string]any, key string) (int64, error)
• func GetIntValue(rec map[string]any, key string) (int, error)
• func GetSingleStringValue(rec map[string]any, key string) (string, error)
• func GetSorted(dbname, collname string, spec bson.M, skeys []string) []map[string]any
• func GetStringValue(rec map[string]any, key string) (string, error)
• func GetValue(rec map[string]any, key string) interface{}
• func InitMongoDB(uri string)
• func Insert(dbname, collname string, records []map[string]any)
• func InsertAny(dbname, collname string, records []any)
• func InsertRecord(dbname, collname string, rec bson.M) error
• func MapKeys(rec map[string]any) []string
• func Remove(dbname, collname string, spec bson.M) error
• func Update(dbname, collname string, spec, newdata bson.M)
• func Upsert(dbname, collname, attr string, records []map[string]any) error
• func UpsertAny(dbname, collname string, records []any) error
• func UpsertRecord(dbname, collname string, spec bson.M, rec bson.M) error
• type Connection
  • func (m *Connection) Connect() *mongo.Client

Constants

const (
	ServerError
	DBError
	QueryError
	ParserError
	ValidationError
)

const (
	ServerErrorName     = "Server error"
	DBErrorName         = "MongoDB error"
	QueryErrorName      = "Server query error"
	ParserErrorName     = "Server parser error"
	ValidationErrorName = "Server validation error"
)

ServerErrorName and others provides human based definition of the error

Functions

func Count

func Count(dbname, collname string, spec bson.M) int

Count gets number records from MongoDB

func ErrorRecord

func ErrorRecord(msg, etype string, ecode int) map[string]any

ErrorRecord provides error record

func Get

func Get(dbname, collname string, spec bson.M, idx, limit int) []map[string]any

Get records from MongoDB

func GetInt64Value

func GetInt64Value(rec map[string]any, key string) (int64, error)

GetInt64Value function to get int value from record for given key

func GetIntValue

func GetIntValue(rec map[string]any, key string) (int, error)

GetIntValue function to get int value from record for given key

func GetSingleStringValue

func GetSingleStringValue(rec map[string]any, key string) (string, error)

GetSingleStringValue function to get string value from record for given key

func GetSorted

func GetSorted(dbname, collname string, spec bson.M, skeys []string) []map[string]any

GetSorted records from MongoDB sorted by given key

func GetStringValue

func GetStringValue(rec map[string]any, key string) (string, error)

GetStringValue function to get string value from record for given key

func GetValue

func GetValue(rec map[string]any, key string) interface{}

GetValue function to get int value from record for given key

func InitMongoDB

func InitMongoDB(uri string)

InitMongoDB initializes MongoDB connection object

func Insert

func Insert(dbname, collname string, records []map[string]any)

Insert records into MongoDB

func InsertAny

func InsertAny(dbname, collname string, records []any)

InsertAny insert records into MongoDB

func InsertRecord

func InsertRecord(dbname, collname string, rec bson.M) error

InsertRecord insert record with given spec to MongoDB

func MapKeys

func MapKeys(rec map[string]any) []string

MapKeys helper function to return keys from a map

func Remove

func Remove(dbname, collname string, spec bson.M) error

Remove records from MongoDB

func Update

func Update(dbname, collname string, spec, newdata bson.M)

Update inplace for given spec

func Upsert

func Upsert(dbname, collname, attr string, records []map[string]any) error

Upsert records into MongoDB

func UpsertAny

func UpsertAny(dbname, collname string, records []any) error

UpsertAny upsert records into MongoDB

func UpsertRecord

func UpsertRecord(dbname, collname string, spec bson.M, rec bson.M) error

UpsertRecord insert record with given spec to MongoDB

Types

type Connection

type Connection struct {
	Client *mongo.Client
	URI    string
}

Connection defines connection to MongoDB

var Mongo Connection

Mongo holds MongoDB connection

func (*Connection) Connect

func (m *Connection) Connect() *mongo.Client

Connect provides connection to MongoDB