基本 CURD

概述

本章节介绍 mon 包的 CURD 相对复杂的方法介绍。

准备条件

  1. 完成 mon 的链接创建。
  2. 基本 CURD 学习。

新增

  1. InsertMany
  1. 函数签名: 
  2.     InsertMany func(ctx context.Context, documents []interface{}, opts ...*mopt.InsertManyOptions) (
  3.             *mongo.InsertManyResult, error) 
  4. 说明: 
  5.     1. 新增多个文档记录。
  6. 入参:
  7.     1. ctx: context
  8.     2. documents: 记录信息
  9.     3. opts: 操作选项
  10. 返回值:
  11.     1. *mongo.InsertManyResult: 新增结果，包含新增记录的 _id 列表
  12.     2. error: 执行结果
  14. 示例:
  15. type User struct {
  16.     ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  17.     // TODO: Fill your own fields
  18.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  19.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  20. }
  22. func (m *defaultUserModel) InsertMany(ctx context.Context, data []*User) error {
  23.     var docs = make([]interface{}, 0, len(data))
  24.     for _, d := range data {
  25.         if d.ID.IsZero() {
  26.             d.ID = primitive.NewObjectID()
  27.             d.CreateAt = time.Now()
  28.             d.UpdateAt = time.Now()
  29.         }
  30.         docs = append(docs, d)
  31.     }
  33.     _, err := m.conn.InsertMany(ctx, docs)
  34.     return err
  35. }
  1. BulkInserter
  1. 函数签名: 
  2.     NewBulkInserter(coll Collection, interval ...time.Duration) (*BulkInserter, error) 
  3. 说明: 
  4.     1. 如果存在大批量新增数据时，可以使用。
  5.     2. 插入过程会按 bulk(1000) 或 周期时间分组插入。
  6. 入参:
  7.     1. coll: mongo 连接对象
  8.     2. interval: 批量插入周期, intervals[0] 是有效值
  9. 返回值:
  10.     1. *BulkInserter: bulk 模块对象
  11.     2. error: 创建结果
  13. 示例:
  14. type User struct {
  15.     ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  16.     // TODO: Fill your own fields
  17.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  18.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  19. }
  21. // NewUserModel returns a model for the mongo.
  22. func NewUserModel(url, db, collection string) UserModel {
  23.     conn := mon.MustNewModel(url, db, collection)
  24.     blk, err := mon.NewBatchInserter(conn.Collection, time.Second)
  25.     if err != nil {
  26.         log.Fatal(err)
  27.     }
  29.     return &customUserModel{
  30.         defaultUserModel: newDefaultUserModel(conn),
  31.         blk:              blk,
  32.     }
  33. }
  35. func (m *customUserModel) BatchInsert(ctx context.Context, data []*User) error {
  36.     m.blk.SetResultHandler(func(result *mongo.InsertManyResult, err error) {
  37.         if err != nil {
  38.             log.Println(err)
  39.         }
  40.     })
  42.     for _, d := range data {
  43.         if d.ID.IsZero() {
  44.             d.ID = primitive.NewObjectID()
  45.             d.CreateAt = time.Now()
  46.             d.UpdateAt = time.Now()
  47.         }
  48.         m.blk.Insert(d)
  49.     }
  50.     m.blk.Flush()
  51.     return nil
  52. }

更新

  1. UpdateOne
  1. 函数签名: 
  2.     UpdateOne (ctx context.Context, filter, update interface{},
  3.             opts ...*mopt.UpdateOptions) (*mongo.UpdateResult, error)
  4. 说明: 
  5.     1. 更新单个文档记录。
  6. 入参:
  7.     1. ctx: context
  8.     2. filter: 过滤条件
  9.     3. update: 更新记录
  10.     4. opts: 操作选项
  11. 返回值:
  12.     1. *mongo.UpdateResult: 更新结果，包含更新的 _id, 匹配的数量等信息
  13.     2. error: 执行结果
  15. 示例:
  16. type User struct {
  17.     ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  18.     // TODO: Fill your own fields
  19.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  20.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  21. }
  23. func (m *defaultUserModel) Update(ctx context.Context, data *User) error {
  24.     data.UpdateAt = time.Now()
  26.     _, err := m.conn.UpdateOne(ctx, bson.M{"_id": data.ID}, data)
  27.     return err
  28. }
  1. UpdateByID
  1. 函数签名: 
  2.     UpdateByID (ctx context.Context, id, update interface{},
  3.             opts ...*mopt.UpdateOptions) (*mongo.UpdateResult, error)
  4. 说明: 
  5.     1. 通过 _id 更新单个文档记录。
  6. 入参:
  7.     1. ctx: context
  8.     2. id: _id
  9.     3. update: 更新记录
  10.     4. opts: 操作选项
  11. 返回值:
  12.     1. *mongo.UpdateResult: 更新结果，包含更新的 _id, 匹配的数量等信息
  13.     2. error: 执行结果
  15. 示例:
  16. type User struct {
  17.     ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  18.     // TODO: Fill your own fields
  19.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  20.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  21. }
  23. func (m *defaultUserModel) Update(ctx context.Context, data *User) error {
  24.     data.UpdateAt = time.Now()
  26.     _, err := m.conn.UpdateByID(ctx, data.ID, data)
  27.     return err
  28. }
  1. UpdateMany
  1. 函数签名: 
  2.     UpdateMany (ctx context.Context, filter, update interface{},
  3.             opts ...*mopt.UpdateOptions) (*mongo.UpdateResult, error)
  4. 说明: 
  5.     1. 更新多个文档记录。
  6. 入参:
  7.     1. ctx: context
  8.     2. filter: 过滤条件
  9.     3. update: 更新记录
  10.     4. opts: 操作选项
  11. 返回值:
  12.     1. *mongo.UpdateResult: 更新结果，包含更新的 _id 列表, 匹配的数量等信息
  13.     2. error: 执行结果
  15. 示例:
  16. type User struct {
  17.     ID   primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  18.     Name string             `bson:"name,omitempty" json:"name,omitempty"`
  19.     Age  int                `bson:"age,omitempty" json:"age,omitempty"`
  20.     // TODO: Fill your own fields
  21.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  22.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  23. }
  25. func (m *customUserModel) UpdateAge(ctx context.Context, name string, age int) error {
  26.     _, err := m.conn.UpdateMany(ctx, bson.M{"name": name}, bson.M{"$set": bson.M{"age": age}})
  27.     return err
  28. }

查询

  1. FindOne
  1. 函数签名: 
  2.     FindOne func(ctx context.Context, v, filter interface{}, opts ...*mopt.FindOneOptions) error 
  3. 说明: 
  4.     1. 查询单个文档记录。
  5. 入参:
  6.     1. ctx: context
  7.     2. v: 查询结果
  8.     2. filter: 过滤条件
  9.     3. opts: 操作选项
  10. 返回值:
  11.     1. error: 执行结果
  13. 示例:
  14. type User struct {
  15.     ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  16.     // TODO: Fill your own fields
  17.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  18.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  19. }
  21. func (m *defaultUserModel) FindOne(ctx context.Context, id string) (*User, error) {
  22.     oid, err := primitive.ObjectIDFromHex(id)
  23.     if err != nil {
  24.         return nil, ErrInvalidObjectId
  25.     }
  27.     var data User
  29.     err = m.conn.FindOne(ctx, &data, bson.M{"_id": oid})
  30.     switch err {
  31.     case nil:
  32.         return &data, nil
  33.     case mon.ErrNotFound:
  34.         return nil, ErrNotFound
  35.     default:
  36.         return nil, err
  37.     }
  38. }
  1. Find
  1. 函数签名: 
  2.     Find func(ctx context.Context, v, filter interface{}, opts ...*mopt.FindOptions) error 
  3. 说明: 
  4.     1. 查询单个文档记录。
  5. 入参:
  6.     1. ctx: context
  7.     2. v: 查询结果(数组指针)
  8.     2. filter: 过滤条件
  9.     3. opts: 操作选项
  10. 返回值:
  11.     1. error: 执行结果
  13. 示例:
  14. type User struct {
  15.     ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  16.     // TODO: Fill your own fields
  17.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  18.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  19. }
  21. func (m *defaultUserModel) Find(ctx context.Context, id string) ([]*User, error) {
  22.     oid, err := primitive.ObjectIDFromHex(id)
  23.     if err != nil {
  24.         return nil, ErrInvalidObjectId
  25.     }
  27.     var data []*User
  29.     err = m.conn.Find(ctx, &data, bson.M{"_id": oid})
  30.     return data, nil
  31. }

删除

  1. DeleteOne
  1. 函数签名: 
  2.     DeleteOne func(ctx context.Context, filter interface{}, opts ...*mopt.DeleteOptions) (int64, error)
  3. 说明: 
  4.     1. 新增单个文档记录。
  5. 入参:
  6.     1. ctx: context
  7.     2. filter: 过滤条件
  8.     3. opts: 操作选项
  9. 返回值:
  10.     1. int64: 删除数量
  11.     2. error: 执行结果
  13. 示例:
  14. type User struct {
  15.     ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  16.     // TODO: Fill your own fields
  17.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  18.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  19. }
  21. func (m *defaultUserModel) Delete(ctx context.Context, id string) error {
  22.     oid, err := primitive.ObjectIDFromHex(id)
  23.     if err != nil {
  24.         return ErrInvalidObjectId
  25.     }
  27.     _, err = m.conn.DeleteOne(ctx, bson.M{"_id": oid})
  28.     return err
  29. }
  1. DeleteMany
  1. 函数签名: 
  2.     DeleteMany func(ctx context.Context, filter interface{}, opts ...*mopt.DeleteOptions) (
  3.             *mongo.DeleteResult, error)
  4. 说明: 
  5.     1. 新增单个文档记录。
  6. 入参:
  7.     1. ctx: context
  8.     2. filter: 过滤条件
  9.     3. opts: 操作选项
  10. 返回值:
  11.     1. *mongo.DeleteResult: 删除结果
  12.     2. error: 执行结果
  14. 示例:
  15. type User struct {
  16.     ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  17.     // TODO: Fill your own fields
  18.     UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  19.     CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  20. }
  22. func (m *defaultUserModel) Delete(ctx context.Context, id string) error {
  23.     oid, err := primitive.ObjectIDFromHex(id)
  24.     if err != nil {
  25.         return ErrInvalidObjectId
  26.     }
  28.     _, err = m.conn.DeleteMany(ctx, bson.M{"_id": oid})
  29.     return err
  30. }