mongodb

Documentation

Index

• func Aggregate(ctx context.Context, col string, query []bson.M, value interface{}) error
• func Count(ctx context.Context, col string) (int64, error)
• func CountWithFilter(ctx context.Context, col string, filter interface{}) (int64, error)
• func CountWithQuery(ctx context.Context, col string, query any) (int, error)
• func DeleteOne(ctx context.Context, col string, query bson.M) (mongo.DeleteResult, error)
• func FindOne(ctx context.Context, col string, query bson.M, value interface{}) error
• func GetMongoClient() *mongo.Client
• func GetMongoDb() *mongo.Database
• func Init(cp DatabaseCredentialHelper, host string, port string, database string)
• func InsertOne(ctx context.Context, col string, input interface{}) (mongo.InsertOneResult, error)
• func Ping() bool
• func UpdateOne(ctx context.Context, col string, filter bson.M, update bson.M) (mongo.UpdateResult, error)
• type DatabaseCredentialHelper
• type MongodbCon
  • func GetMongodbConnection() *MongodbCon
  • func (rc MongodbCon) Aggregate(ctx context.Context, col string, query []bson.M, value interface{}) error
  • func (rc MongodbCon) CheckHealth() []health.Check
  • func (rc MongodbCon) Count(ctx context.Context, col string) (int64, error)
  • func (rc MongodbCon) CountWithFilter(ctx context.Context, col string, filter interface{}) (int64, error)
  • func (rc MongodbCon) CountWithQuery(ctx context.Context, col string, query any) (int, error)
  • func (rc MongodbCon) DeleteOne(ctx context.Context, col string, query bson.M) (mongo.DeleteResult, error)
  • func (rc MongodbCon) FindOne(ctx context.Context, col string, query bson.M, value interface{}) error
  • func (rc MongodbCon) GenerateAggregateQuery(rorResourceQuery *rorresources.ResourceQuery) []bson.M
  • func (rc MongodbCon) GetMongoDb() *mongo.Database
  • func (rc MongodbCon) InsertOne(ctx context.Context, col string, input interface{}) (mongo.InsertOneResult, error)
  • func (rc MongodbCon) UpdateOne(ctx context.Context, col string, filter bson.M, update bson.M) (mongo.UpdateResult, error)
  • func (rc MongodbCon) UpsertOne(ctx context.Context, col string, filter bson.M, update interface{}) (mongo.UpdateResult, error)
• type MongodbQuery
  • func NewMongodbQuery(input []bson.M) MongodbQuery
  • func (m MongodbQuery) MongoshPrint(collection string)
  • func (m MongodbQuery) PrettyPrint()

Functions

func Aggregate

func Aggregate(ctx context.Context, col string, query []bson.M, value interface{}) error

func Count

func Count(ctx context.Context, col string) (int64, error)

func CountWithFilter

func CountWithFilter(ctx context.Context, col string, filter interface{}) (int64, error)

func CountWithQuery

func CountWithQuery(ctx context.Context, col string, query any) (int, error)

func DeleteOne

func DeleteOne(ctx context.Context, col string, query bson.M) (mongo.DeleteResult, error)

func FindOne

func FindOne(ctx context.Context, col string, query bson.M, value interface{}) error

func GetMongoClient

func GetMongoClient() *mongo.Client

func GetMongoDb

func GetMongoDb() *mongo.Database

GetMongoDb function returns a pointer to the `mongo.Database` instance used to communicate with MongoDB server. The function simply returns the MongoDB client instance stored in a `mongodb` singleton object. This function is used to obtain the MongoDB client connection in other parts of the application.

func Init

func Init(cp DatabaseCredentialHelper, host string, port string, database string)

Initializes the mongodb client

func InsertOne

func InsertOne(ctx context.Context, col string, input interface{}) (mongo.InsertOneResult, error)

func Ping

func Ping() bool

Ping the mongodb database and returns the result as a bool

func UpdateOne

func UpdateOne(ctx context.Context, col string, filter bson.M, update bson.M) (mongo.UpdateResult, error)

Types

type DatabaseCredentialHelper

type DatabaseCredentialHelper interface {
	GetCredentials() (string, string)
	CheckAndRenew() bool
}

type MongodbCon

type MongodbCon struct {
	Client      *mongo.Client
	Context     context.Context
	Credentials DatabaseCredentialHelper
	Host        string
	Port        string
	Database    string
}

This type implements the mongodb connection in ror

func GetMongodbConnection

func GetMongodbConnection() *MongodbCon

func (MongodbCon) Aggregate

func (rc MongodbCon) Aggregate(ctx context.Context, col string, query []bson.M, value interface{}) error

func (MongodbCon) CheckHealth

func (rc MongodbCon) CheckHealth() []health.Check

CheckHealth checks the health of the redis connection and returns a health check

func (MongodbCon) Count

func (rc MongodbCon) Count(ctx context.Context, col string) (int64, error)

func (MongodbCon) CountWithFilter

func (rc MongodbCon) CountWithFilter(ctx context.Context, col string, filter interface{}) (int64, error)

func (MongodbCon) CountWithQuery

func (rc MongodbCon) CountWithQuery(ctx context.Context, col string, query any) (int, error)

func (MongodbCon) DeleteOne

func (rc MongodbCon) DeleteOne(ctx context.Context, col string, query bson.M) (mongo.DeleteResult, error)

func (MongodbCon) FindOne

func (rc MongodbCon) FindOne(ctx context.Context, col string, query bson.M, value interface{}) error

func (MongodbCon) GenerateAggregateQuery

func (rc MongodbCon) GenerateAggregateQuery(rorResourceQuery *rorresources.ResourceQuery) []bson.M

func (MongodbCon) GetMongoDb

func (rc MongodbCon) GetMongoDb() *mongo.Database

func (MongodbCon) InsertOne

func (rc MongodbCon) InsertOne(ctx context.Context, col string, input interface{}) (mongo.InsertOneResult, error)

func (MongodbCon) UpdateOne

func (rc MongodbCon) UpdateOne(ctx context.Context, col string, filter bson.M, update bson.M) (mongo.UpdateResult, error)

func (MongodbCon) UpsertOne

func (rc MongodbCon) UpsertOne(ctx context.Context, col string, filter bson.M, update interface{}) (mongo.UpdateResult, error)

type MongodbQuery

type MongodbQuery []bson.M

func NewMongodbQuery

func NewMongodbQuery(input []bson.M) MongodbQuery

func (MongodbQuery) MongoshPrint

func (m MongodbQuery) MongoshPrint(collection string)

func (MongodbQuery) PrettyPrint

func (m MongodbQuery) PrettyPrint()