mongoutil

Documentation

Index

• func Aggregate[T any](ctx context.Context, coll *mongo.Collection, pipeline any, ...) ([]T, error)
• func Check(ctx context.Context, config *Config) error
• func Count(ctx context.Context, coll *mongo.Collection, filter any, ...) (int64, error)
• func DecodeOne[T any](decoder func(v any) error) (res T, err error)
• func Decodes[T any](ctx context.Context, cur *mongo.Cursor) ([]T, error)
• func DeleteMany(ctx context.Context, coll *mongo.Collection, filter any, ...) error
• func DeleteManyResult(ctx context.Context, coll *mongo.Collection, filter any, ...) (*mongo.DeleteResult, error)
• func DeleteOne(ctx context.Context, coll *mongo.Collection, filter any, ...) error
• func DeleteOneResult(ctx context.Context, coll *mongo.Collection, filter any, ...) (*mongo.DeleteResult, error)
• func Exist(ctx context.Context, coll *mongo.Collection, filter any, ...) (bool, error)
• func Find[T any](ctx context.Context, coll *mongo.Collection, filter any, ...) ([]T, error)
• func FindOne[T any](ctx context.Context, coll *mongo.Collection, filter any, ...) (res T, err error)
• func FindOneAndUpdate[T any](ctx context.Context, coll *mongo.Collection, filter any, update any, ...) (res T, err error)
• func FindPage[T any](ctx context.Context, coll *mongo.Collection, filter any, ...) (int64, []T, error)
• func FindPageOnly[T any](ctx context.Context, coll *mongo.Collection, filter any, ...) ([]T, error)
• func Ignore[T any](_ T, err error) error
• func IgnoreWarp[T any](_ T, err error) error
• func IncrVersion(dbs ...func() error) error
• func InsertMany[T any](ctx context.Context, coll *mongo.Collection, val []T, ...) error
• func NewMongo(client *mongo.Client) tx.Tx
• func NewMongoTx(ctx context.Context, client *mongo.Client) (tx.Tx, error)
• func UpdateMany(ctx context.Context, coll *mongo.Collection, filter any, update any, ...) (*mongo.UpdateResult, error)
• func UpdateOne(ctx context.Context, coll *mongo.Collection, filter any, update any, ...) error
• func UpdateOneResult(ctx context.Context, coll *mongo.Collection, filter any, update any, ...) (*mongo.UpdateResult, error)
• type Client
  • func NewMongoDB(ctx context.Context, config *Config) (*Client, error)
  • func (c *Client) GetDB() *mongo.Database
  • func (c *Client) GetTx() tx.Tx
• type Config
  • func (c *Config) ValidateAndSetDefaults() error

Functions

func Aggregate

func Aggregate[T any](ctx context.Context, coll *mongo.Collection, pipeline any, opts ...*options.AggregateOptions) ([]T, error)

func Check

func Check(ctx context.Context, config *Config) error

CheckMongo tests the MongoDB connection without retries.

func Count

func Count(ctx context.Context, coll *mongo.Collection, filter any, opts ...*options.CountOptions) (int64, error)

func DecodeOne

func DecodeOne[T any](decoder func(v any) error) (res T, err error)

func Decodes

func Decodes[T any](ctx context.Context, cur *mongo.Cursor) ([]T, error)

func DeleteMany

func DeleteMany(ctx context.Context, coll *mongo.Collection, filter any, opts ...*options.DeleteOptions) error

func DeleteManyResult

func DeleteManyResult(ctx context.Context, coll *mongo.Collection, filter any, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)

func DeleteOne

func DeleteOne(ctx context.Context, coll *mongo.Collection, filter any, opts ...*options.DeleteOptions) error

func DeleteOneResult

func DeleteOneResult(ctx context.Context, coll *mongo.Collection, filter any, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)

func Exist

func Exist(ctx context.Context, coll *mongo.Collection, filter any, opts ...*options.CountOptions) (bool, error)

func Find

func Find[T any](ctx context.Context, coll *mongo.Collection, filter any, opts ...*options.FindOptions) ([]T, error)

func FindOne

func FindOne[T any](ctx context.Context, coll *mongo.Collection, filter any, opts ...*options.FindOneOptions) (res T, err error)

func FindOneAndUpdate

func FindOneAndUpdate[T any](ctx context.Context, coll *mongo.Collection, filter any, update any, opts ...*options.FindOneAndUpdateOptions) (res T, err error)

func FindPage

func FindPage[T any](ctx context.Context, coll *mongo.Collection, filter any, pagination pagination.Pagination, opts ...*options.FindOptions) (int64, []T, error)

func FindPageOnly

func FindPageOnly[T any](ctx context.Context, coll *mongo.Collection, filter any, pagination pagination.Pagination, opts ...*options.FindOptions) ([]T, error)

func Ignore

func Ignore[T any](_ T, err error) error

func IgnoreWarp

func IgnoreWarp[T any](_ T, err error) error

func IncrVersion

func IncrVersion(dbs ...func() error) error

func InsertMany

func InsertMany[T any](ctx context.Context, coll *mongo.Collection, val []T, opts ...*options.InsertManyOptions) error

func NewMongo

func NewMongo(client *mongo.Client) tx.Tx

func NewMongoTx

func NewMongoTx(ctx context.Context, client *mongo.Client) (tx.Tx, error)

func UpdateMany

func UpdateMany(ctx context.Context, coll *mongo.Collection, filter any, update any, opts ...*options.UpdateOptions) (*mongo.UpdateResult, error)

func UpdateOne

func UpdateOne(ctx context.Context, coll *mongo.Collection, filter any, update any, notMatchedErr bool, opts ...*options.UpdateOptions) error

func UpdateOneResult

func UpdateOneResult(ctx context.Context, coll *mongo.Collection, filter any, update any, opts ...*options.UpdateOptions) (*mongo.UpdateResult, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewMongoDB

func NewMongoDB(ctx context.Context, config *Config) (*Client, error)

NewMongoDB initializes a new MongoDB connection.

func (*Client) GetDB

func (c *Client) GetDB() *mongo.Database

func (*Client) GetTx

func (c *Client) GetTx() tx.Tx

type Config

type Config struct {
	Uri         string
	Address     []string
	Database    string
	Username    string
	Password    string
	AuthSource  string
	MaxPoolSize int
	MaxRetry    int
}

Config represents the MongoDB configuration.

func (*Config) ValidateAndSetDefaults

func (c *Config) ValidateAndSetDefaults() error

ValidateAndSetDefaults validates the configuration and sets default values.