Documentation
¶
Overview ¶
Package db - BoltDB realization
Package db - пакет враппер для работы с базами ¶
Состав пакета:
db.go - набор общих интерфейсов для использования в коде mgo.go - реализация для драйвера globalsign/mgo mock.go - набор mock-структур для проведения тестирования
Package db - MongoDB realization for the globalsign/mgo mongo driver Driver's page: https://github.com/globalsign/mgo It's a community developing driver inspired by labix/mgo.v2
Index ¶
- type Bolt
- func (b *Bolt) All(results interface{}) error
- func (b *Bolt) Close()
- func (b *Bolt) Connect(resources ...interface{}) (err error)
- func (b *Bolt) Copy() Handler
- func (b *Bolt) CopyWithSettings(settings ...interface{}) (Handler, error)
- func (b *Bolt) Count() (num int, err error)
- func (b *Bolt) Distinct(key string, result interface{}) error
- func (b *Bolt) ExecOn(resources ...interface{}) Querier
- func (b *Bolt) Find(query interface{}) Refiner
- func (b *Bolt) Insert(docs ...interface{}) error
- func (b *Bolt) One(result interface{}) error
- func (b *Bolt) Remove(selector interface{}) error
- func (b *Bolt) RemoveAll(selector interface{}) (num int, err error)
- func (b *Bolt) Update(selector interface{}, update interface{}) error
- func (b *Bolt) UpdateAll(selector interface{}, update interface{}) (num int, err error)
- func (b *Bolt) Upsert(selector interface{}, update interface{}) (num int, err error)
- type Handler
- type Mock
- type MockCollection
- func (mc *MockCollection) Find(query interface{}) Refiner
- func (mc *MockCollection) Insert(docs ...interface{}) error
- func (mc *MockCollection) Remove(selector interface{}) error
- func (mc *MockCollection) RemoveAll(selector interface{}) (num int, err error)
- func (mc *MockCollection) Update(selector interface{}, update interface{}) error
- func (mc *MockCollection) UpdateAll(selector interface{}, update interface{}) (num int, err error)
- func (mc *MockCollection) Upsert(selector interface{}, update interface{}) (num int, err error)
- type MockQuery
- type Mongo
- type MongoCollection
- func (mc *MongoCollection) Find(query interface{}) Refiner
- func (mc *MongoCollection) Insert(docs ...interface{}) error
- func (mc *MongoCollection) Remove(selector interface{}) error
- func (mc *MongoCollection) RemoveAll(selector interface{}) (num int, err error)
- func (mc *MongoCollection) Update(selector interface{}, update interface{}) error
- func (mc *MongoCollection) UpdateAll(selector interface{}, update interface{}) (num int, err error)
- func (mc *MongoCollection) Upsert(selector interface{}, update interface{}) (num int, err error)
- type MongoQuery
- type Querier
- type Refiner
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bolt ¶
type Bolt struct {
// contains filtered or unexported fields
}
func (*Bolt) CopyWithSettings ¶
type Handler ¶
type Handler interface {
Connect(resources ...interface{}) error
Copy() Handler //Метод возвращает интерфейсный тип с копией сессии, полученной от корневой
CopyWithSettings(settings ...interface{}) (Handler, error) //Метод возвращает интерфейсный тип с копией сессии в нужном режиме
Close()
ExecOn(resources ...interface{}) Querier
}
Handler - интерфейс, содержащий набор методов для работы с корневой сессией(коннектом) Монго
type Mock ¶
Mock - структура для проверки методов db.Handler
func (*Mock) CopyWithSettings ¶
CopyWithSettings - возвращает db.Handler со структурой &Mock{Msg: "session copied w settings"}
type MockCollection ¶
MockCollection - - структура для проверки методов db.Querier
func (*MockCollection) Find ¶
func (mc *MockCollection) Find(query interface{}) Refiner
Find - возвращает db.Refiner со структурой &MockQuery{}
func (*MockCollection) Insert ¶
func (mc *MockCollection) Insert(docs ...interface{}) error
Insert - считает количество переданных документов, пишет число в поле DocsNum
func (*MockCollection) Remove ¶
func (mc *MockCollection) Remove(selector interface{}) error
Remove - пишет число 111 в поле Selector
func (*MockCollection) RemoveAll ¶
func (mc *MockCollection) RemoveAll(selector interface{}) (num int, err error)
RemoveAll - пишет число 333 в поле Selector
func (*MockCollection) Update ¶
func (mc *MockCollection) Update(selector interface{}, update interface{}) error
Update - пишет число 555 в поле Selector и 777 в поле Upd
func (*MockCollection) UpdateAll ¶
func (mc *MockCollection) UpdateAll(selector interface{}, update interface{}) (num int, err error)
UpdateAll - возвращает число 888 и nil для ошибки
func (*MockCollection) Upsert ¶
func (mc *MockCollection) Upsert(selector interface{}, update interface{}) (num int, err error)
Upsert - возвращает число 999 и nil для ошибки
type MockQuery ¶
MockQuery - структура для проверки методов db.Refiner
type Mongo ¶
Mongo struct wraps *mgo.Session struct
func (*Mongo) CopyWithSettings ¶
CopyWithSettings makes session copy with new working mode
type MongoCollection ¶
type MongoCollection struct {
*mgo.Collection
}
MongoCollection is a wrapper for *mgo.Collection
func (*MongoCollection) Find ¶
func (mc *MongoCollection) Find(query interface{}) Refiner
Find searches for the docs according to query
func (*MongoCollection) Insert ¶
func (mc *MongoCollection) Insert(docs ...interface{}) error
Insert puts documents to db
func (*MongoCollection) Remove ¶
func (mc *MongoCollection) Remove(selector interface{}) error
Remove deletes one document according to selector
func (*MongoCollection) RemoveAll ¶
func (mc *MongoCollection) RemoveAll(selector interface{}) (num int, err error)
RemoveAll deletes all documents according to selector, return number of deleted docs or an error
func (*MongoCollection) Update ¶
func (mc *MongoCollection) Update(selector interface{}, update interface{}) error
Update updates one document and return an error if nothing to update
func (*MongoCollection) UpdateAll ¶
func (mc *MongoCollection) UpdateAll(selector interface{}, update interface{}) (num int, err error)
UpdateAll updates documents and return an error if nothing to update or number of updated docs
func (*MongoCollection) Upsert ¶
func (mc *MongoCollection) Upsert(selector interface{}, update interface{}) (num int, err error)
Upsert updates document and insert a new doc if nothing to update
type MongoQuery ¶
MongoQuery wrapper for *mgo.Query
func (*MongoQuery) All ¶
func (mq *MongoQuery) All(results interface{}) error
All refines mongo query and return all records
func (*MongoQuery) Count ¶
func (mq *MongoQuery) Count() (num int, err error)
Count returns numbers of the queried records
func (*MongoQuery) Distinct ¶
func (mq *MongoQuery) Distinct(key string, result interface{}) error
Distinct selects values set for the key
func (*MongoQuery) One ¶
func (mq *MongoQuery) One(result interface{}) error
One refines mongo query and return one record
type Querier ¶
type Querier interface {
Insert(docs ...interface{}) error
Remove(selector interface{}) error
RemoveAll(selector interface{}) (num int, err error)
Update(selector interface{}, update interface{}) error
UpdateAll(selector interface{}, update interface{}) (num int, err error)
Upsert(selector interface{}, update interface{}) (num int, err error)
Find(query interface{}) Refiner //Метод позволяет уточнить и разобрать полученные данные
}
Querier - набор методов для работы с конечным сетом данных
type Refiner ¶
type Refiner interface {
One(result interface{}) error //One принимает в качестве параметра ссылку на структуру для анмаршалинга
All(results interface{}) error //All принимает в качестве параметра ссылку на слайс структур для анмаршалинга
Distinct(key string, result interface{}) error //Distinct распаковывает в result значения, полученные по ключу key
Count() (num int, err error)
}
Refiner - набор методов для уточнения запроса