mongo

Documentation

Overview

Package mongo

Package mongo

Package mongo

Package mongo

Package mongo

Index

• Constants
• func ModuleName() string
• type A
• type Collection
• type D
• type E
• type M
• type MetaModel
• type Model
• type Mongo
  • func (m *Mongo) Coll(mod Model) *Collection
  • func (m *Mongo) Delete(mod Model, data Model) error
  • func (m *Mongo) Get(mod Model, filter interface{}) *SingleResult
  • func (m *Mongo) GetAll(mod Model, r interface{}, filter interface{}) error
  • func (m *Mongo) GetFilter(mod Model, filter interface{}) *SingleResult
  • func (m *Mongo) Init() error
  • func (m *Mongo) Insert(mod Model, data Model) error
  • func (m *Mongo) Persist(mod Model) error
  • func (m *Mongo) Update(mod Model, data Model) error
• type Raw
• type SingleResult

Constants

const (
	DefaultTimeout = 5
)

const (
	ErrCheckError = "config check error"
)

Functions

func ModuleName

func ModuleName() string

ModuleName 模块名称

Types

type A

type A bson.A

A bson数组类型

type Collection

type Collection struct {
	*mgm.Collection
}

type D

type D bson.D

D bson有序字典

type E

type E bson.E

E bson element

type M

type M bson.M

M bson字典类型

type MetaModel

type MetaModel mgm.DefaultModel

MetaModel 不使用bson: inline时 无法正确获取到id 查询返回的结果 不能使用Model decode

type Model

type Model mgm.Model

Model 自定义表名 增加结构体函数 CollectionName()

type Mongo

type Mongo struct {
	ContextTimeout int    // 超时时间 单位:s
	DBName         string // 连接的库名称
	URL            string // 数据库连接URI 例如mongodb://localhost:27017
}

Mongo 全局唯一的单例客户端 只能初始化一次使用

func (*Mongo) Coll

func (m *Mongo) Coll(mod Model) *Collection

Coll 取得当前集合

func (*Mongo) Delete

func (m *Mongo) Delete(mod Model, data Model) error

func (*Mongo) Get

func (m *Mongo) Get(mod Model, filter interface{}) *SingleResult

Get 语法糖 Coll(model).FindOne(context.Background(), bson.M{filter: key})

func (*Mongo) GetAll

func (m *Mongo) GetAll(mod Model, r interface{}, filter interface{}) error

GetAll r应该为指针

func (*Mongo) GetFilter

func (m *Mongo) GetFilter(mod Model, filter interface{}) *SingleResult

GetFilter 通过filter获取 filter 可以为M D E A Raw

func (*Mongo) Init

func (m *Mongo) Init() error

Init 初始化连接 调用后客户端连接即建立可以进行操作 对于无法连接时 不会显式的返回错误 只有在第一次执行时报错

func (*Mongo) Insert

func (m *Mongo) Insert(mod Model, data Model) error

Insert 插入一条数据 返回错误 data 应该为指针类型 用于更新时间

func (*Mongo) Persist

func (m *Mongo) Persist(mod Model) error

Persist 持久化 保存文件为bson数据 默认保存在当前目录下的tableName.bson

func (*Mongo) Update

func (m *Mongo) Update(mod Model, data Model) error

Update 更新 data 需要传递指针

type Raw

type Raw bson.Raw

Raw bson raw data

type SingleResult

type SingleResult mongo.SingleResult

SingleResult mongo 单条查询的别名