基本 CURD

概述

本章节介绍 mon 包的 CURD 相关方法的介绍。

准备条件

  1. 完成 mon 的链接创建。

新增

  1. InsertOne
  1. 函数签名:
  2. InsertOne func(ctx context.Context, document interface{}, opts ...*mopt.InsertOneOptions) (
  3. *mongo.InsertOneResult, error)
  4. 说明:
  5. 1. 新增单个文档记录。
  6. 入参:
  7. 1. ctx: context
  8. 2. document: 记录信息
  9. 3. opts: 操作选项
  10. 返回值:
  11. 1. *mongo.InsertOneResult: 新增结果,包含新增记录的 _id
  12. 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. }
  20. func (m *defaultUserModel) Insert(ctx context.Context, data *User) error {
  21. if data.ID.IsZero() {
  22. data.ID = primitive.NewObjectID()
  23. data.CreateAt = time.Now()
  24. data.UpdateAt = time.Now()
  25. }
  26. _, err := m.conn.InsertOne(ctx, data)
  27. return err
  28. }

更新

  1. ReplaceOne
  1. 函数签名:
  2. ReplaceOne func(ctx context.Context, filter, replacement interface{},
  3. opts ...*mopt.ReplaceOptions) (*mongo.UpdateResult, error)
  4. 说明:
  5. 1. 更新单个文档记录。
  6. 入参:
  7. 1. ctx: context
  8. 2. filter: 过滤条件
  9. 3. replacement: 更新记录
  10. 4. opts: 操作选项
  11. 返回值:
  12. 1. *mongo.ReplaceOptions: 更新结果,包含更新的 _id, 匹配的数量等信息
  13. 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. }
  21. func (m *defaultUserModel) Update(ctx context.Context, data *User) error {
  22. data.UpdateAt = time.Now()
  23. _, err := m.conn.ReplaceOne(ctx, bson.M{"_id": data.ID}, data)
  24. return err
  25. }

查询

  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: 执行结果
  12. 示例:
  13. type User struct {
  14. ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  15. // TODO: Fill your own fields
  16. UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  17. CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  18. }
  19. func (m *defaultUserModel) FindOne(ctx context.Context, id string) (*User, error) {
  20. oid, err := primitive.ObjectIDFromHex(id)
  21. if err != nil {
  22. return nil, ErrInvalidObjectId
  23. }
  24. var data User
  25. err = m.conn.FindOne(ctx, &data, bson.M{"_id": oid})
  26. switch err {
  27. case nil:
  28. return &data, nil
  29. case mon.ErrNotFound:
  30. return nil, ErrNotFound
  31. default:
  32. return nil, err
  33. }
  34. }
  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: 执行结果
  12. 示例:
  13. type User struct {
  14. ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  15. // TODO: Fill your own fields
  16. UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  17. CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  18. }
  19. func (m *defaultUserModel) Find(ctx context.Context, id string) ([]*User, error) {
  20. oid, err := primitive.ObjectIDFromHex(id)
  21. if err != nil {
  22. return nil, ErrInvalidObjectId
  23. }
  24. var data []*User
  25. err = m.conn.Find(ctx, &data, bson.M{"_id": oid})
  26. return data, nil
  27. }

删除

  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: 执行结果
  12. 示例:
  13. type User struct {
  14. ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  15. // TODO: Fill your own fields
  16. UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  17. CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  18. }
  19. func (m *defaultUserModel) Delete(ctx context.Context, id string) error {
  20. oid, err := primitive.ObjectIDFromHex(id)
  21. if err != nil {
  22. return ErrInvalidObjectId
  23. }
  24. _, err = m.conn.DeleteOne(ctx, bson.M{"_id": oid})
  25. return err
  26. }

完整 demo 实例

  1. package main
  2. import (
  3. "time"
  4. "go.mongodb.org/mongo-driver/bson"
  5. "go.mongodb.org/mongo-driver/bson/primitive"
  6. "github.com/zeromicro/go-zero/core/stores/mon"
  7. )
  8. type User struct {
  9. ID primitive.ObjectID `bson:"_id,omitempty" json:"id,omitempty"`
  10. Username string `bson:"username,omitempty" json:"username,omitempty"`
  11. Password string `bson:"password,omitempty" json:"password,omitempty"`
  12. UpdateAt time.Time `bson:"updateAt,omitempty" json:"updateAt,omitempty"`
  13. CreateAt time.Time `bson:"createAt,omitempty" json:"createAt,omitempty"`
  14. }
  15. func main() {
  16. conn := mon.MustNewModel("mongodb://<user>:<password>@<host>:<port>", "db", "collection")
  17. ctx := context.Background()
  18. u := &User{
  19. ID: primitive.ObjectID{},
  20. Username: "username",
  21. Password: "password",
  22. UpdateAt: time.Now(),
  23. CreateAt: time.Now(),
  24. }
  25. // insert one
  26. _, err := conn.InsertOne(ctx, u)
  27. if err != nil {
  28. panic(err)
  29. }
  30. // 查询
  31. var newUser User
  32. err = conn.FindOne(ctx, &newUser, bson.M{"_id": u.ID})
  33. if err != nil {
  34. panic(err)
  35. }
  36. // 更新
  37. newUser.Username = "newUsername"
  38. _, err = conn.ReplaceOne(ctx, bson.M{"_id": newUser.ID}, newUser)
  39. if err != nil {
  40. panic(err)
  41. }
  42. // 删除
  43. _, err = conn.DeleteOne(ctx, bson.M{"_id": newUser.ID})
  44. if err != nil {
  45. panic(err)
  46. }
  47. }