mongo

README

mongo_wrapper

go mongo wrapper

easy to use mongo, add some useful function like increment

Documentation

Index

• Constants
• type ColClient
  • func NewCollection(addr, db, col string) (*ColClient, error)
  • func (c *ColClient) Close(ctx context.Context) error
  • func (c *ColClient) CreateIndex(ctx context.Context, indexes ...Index) error
  • func (c *ColClient) DeleteOne(ctx context.Context, filter interface{}) error
  • func (c *ColClient) FindAll(ctx context.Context, filter interface{}, array interface{}) error
  • func (c *ColClient) FindOne(ctx context.Context, filter interface{}, doc interface{}) error
  • func (c *ColClient) FindOrInsert(ctx context.Context, filter interface{}, doc interface{}, ret interface{}) error
  • func (c *ColClient) InsertOne(ctx context.Context, doc interface{}) (*mongo.InsertOneResult, error)
  • func (c *ColClient) UpdateOne(ctx context.Context, filter interface{}, doc interface{}) error
• type DbClient
  • func NewDbClient(addr string, db string) (*DbClient, error)
  • func (d *DbClient) Close(ctx context.Context) error
  • func (d *DbClient) Collection(col string) *ColClient
  • func (d *DbClient) CreateCollection(ctx context.Context, col string) error
  • func (d *DbClient) Drop(ctx context.Context) error
  • func (d *DbClient) NextSeqNo(ctx context.Context, sequenceName string) (uint32, error)
  • func (d *DbClient) ServerVersion() string
• type Index

Constants

const CounterCollection = "_m_counters"

Types

type ColClient

type ColClient struct {
	DbClient
	// contains filtered or unexported fields
}

func NewCollection

func NewCollection(addr, db, col string) (*ColClient, error)

func (*ColClient) Close

func (c *ColClient) Close(ctx context.Context) error

func (*ColClient) CreateIndex

func (c *ColClient) CreateIndex(ctx context.Context, indexes ...Index) error

func (*ColClient) DeleteOne

func (c *ColClient) DeleteOne(ctx context.Context, filter interface{}) error

func (*ColClient) FindAll

func (c *ColClient) FindAll(ctx context.Context, filter interface{}, array interface{}) error

func (*ColClient) FindOne

func (c *ColClient) FindOne(ctx context.Context, filter interface{}, doc interface{}) error

func (*ColClient) FindOrInsert

func (c *ColClient) FindOrInsert(ctx context.Context, filter interface{}, doc interface{}, ret interface{}) error

FindOrInsert find one document by filter, if not found, insert doc and return the inserted document

func (*ColClient) InsertOne

func (c *ColClient) InsertOne(ctx context.Context, doc interface{}) (*mongo.InsertOneResult, error)

func (*ColClient) UpdateOne

func (c *ColClient) UpdateOne(ctx context.Context, filter interface{}, doc interface{}) error

type DbClient

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

func NewDbClient

func NewDbClient(addr string, db string) (*DbClient, error)

NewDbClient create a new mongo client, addr is the mongo server address, db is the database name

func (*DbClient) Close

func (d *DbClient) Close(ctx context.Context) error

func (*DbClient) Collection

func (d *DbClient) Collection(col string) *ColClient

func (*DbClient) CreateCollection

func (d *DbClient) CreateCollection(ctx context.Context, col string) error

func (*DbClient) Drop

func (d *DbClient) Drop(ctx context.Context) error

func (*DbClient) NextSeqNo

func (d *DbClient) NextSeqNo(ctx context.Context, sequenceName string) (uint32, error)

func (*DbClient) ServerVersion

func (d *DbClient) ServerVersion() string

ServerVersion get the version of mongoDB server, like 4.4.0

type Index

type Index struct {
	Keys   []string // index keys， like ["name", "-age"]， if the key is start with "-"， it means descending order
	Unique bool     // unique index
}

Index is a struct for creating index