mongowrap

Documentation

Index

• func SetupDefaultWrap(client *mongo.Client, dbName string)
• func SetupDefaultWrapFromURI(uri string, dbName string) error
• func StaticObjectID(str string) (primitive.ObjectID, error)
• type WrappedMongo
  • func CreateWrap(client *mongo.Client, dbName string) WrappedMongo
  • func CreateWrapFromURL(uri string, dbName string) (WrappedMongo, error)
  • func (wm *WrappedMongo) Aggregation(objs interface{}, pipeline bson.A) (err error)
  • func (wm *WrappedMongo) Connect() error
  • func (wm *WrappedMongo) CountElements(obj interface{}, filter bson.D) (int64, error)
  • func (wm *WrappedMongo) CreateObject(obj interface{}) (*mongo.InsertOneResult, error)
  • func (wm *WrappedMongo) CreateSet(objs interface{}) (*mongo.InsertManyResult, error)
  • func (wm *WrappedMongo) DeleteObject(obj interface{}, filter bson.D) error
  • func (wm *WrappedMongo) DeleteSet(filter bson.D, obj interface{}) (err error)
  • func (wm *WrappedMongo) Disconnect() error
  • func (wm *WrappedMongo) FindObject(obj interface{}, filter bson.D) (err error)
  • func (wm *WrappedMongo) GetObject(id primitive.ObjectID, obj interface{}) error
  • func (wm *WrappedMongo) GetSet(objs interface{}, filter bson.D) error
  • func (wm *WrappedMongo) GetSetWithOffset(objs interface{}, filter bson.D, count int64, offset int64) (err error)
  • func (wm *WrappedMongo) GetSetWithPagination(objs interface{}, filter bson.D, count int64, page int64) error
  • func (wm *WrappedMongo) GetSetWithReversedOffset(objs interface{}, filter bson.D, count int64, offset int64) (err error)
  • func (wm *WrappedMongo) GetSetWithReversedPagination(objs interface{}, filter bson.D, count int64, page int64) (err error)
  • func (wm *WrappedMongo) ReplaceObject(replacementObj interface{}, filter bson.D) error
  • func (wm *WrappedMongo) UpdateObject(obj interface{}, filter bson.D, update bson.D) error
  • func (wm *WrappedMongo) UpdateSet(filter bson.D, update bson.D, obj interface{}) (err error)

Functions

func SetupDefaultWrap

func SetupDefaultWrap(client *mongo.Client, dbName string)

SetupDefaultWrap - устанавливает ваш клиент mongoDB в стандартный Wrapper и производит подключение

func SetupDefaultWrapFromURI

func SetupDefaultWrapFromURI(uri string, dbName string) error

SetupDefaultWrapFromURI - созадет клинет и оборачивает его в стандартный Wrapper

func StaticObjectID

func StaticObjectID(str string) (primitive.ObjectID, error)

Types

type WrappedMongo

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

WrappedMongo - Структура для работы с оберткой над БД

var DB WrappedMongo

DB - Встроенная обертка над БД

func CreateWrap

func CreateWrap(client *mongo.Client, dbName string) WrappedMongo

CreateWrap создание структуры с оберткой над клиентом mongoDB

func CreateWrapFromURL

func CreateWrapFromURL(uri string, dbName string) (WrappedMongo, error)

CreateWrapFromURI - создаст и вернет обертку над mongoDB

func (*WrappedMongo) Aggregation

func (wm *WrappedMongo) Aggregation(objs interface{}, pipeline bson.A) (err error)

Aggregation - выборка посредством агргации материалов

func (*WrappedMongo) Connect

func (wm *WrappedMongo) Connect() error

Connect Откроет подключение к БД

func (*WrappedMongo) CountElements

func (wm *WrappedMongo) CountElements(obj interface{}, filter bson.D) (int64, error)

CountElements - подсчитает элементы в коллекции по выбранным условиям

func (*WrappedMongo) CreateObject

func (wm *WrappedMongo) CreateObject(obj interface{}) (*mongo.InsertOneResult, error)

CreateObject - создаст объект в базе данных, название коллекции будет получено по типу даных

func (*WrappedMongo) CreateSet

func (wm *WrappedMongo) CreateSet(objs interface{}) (*mongo.InsertManyResult, error)

CreateSet - добавит объекты в БД

func (*WrappedMongo) DeleteObject

func (wm *WrappedMongo) DeleteObject(obj interface{}, filter bson.D) error

DeleteObject - удалит объект из БД по id

func (*WrappedMongo) DeleteSet

func (wm *WrappedMongo) DeleteSet(filter bson.D, obj interface{}) (err error)

DeleteSet - удалит объекты

func (*WrappedMongo) Disconnect

func (wm *WrappedMongo) Disconnect() error

Disconnect Отключение от БД при завершении проложения

func (*WrappedMongo) FindObject

func (wm *WrappedMongo) FindObject(obj interface{}, filter bson.D) (err error)

FindObject - вернет первый объект совпадающий по фильтру

func (*WrappedMongo) GetObject

func (wm *WrappedMongo) GetObject(id primitive.ObjectID, obj interface{}) error

GetObject - вернет объект по id

func (*WrappedMongo) GetSet

func (wm *WrappedMongo) GetSet(objs interface{}, filter bson.D) error

GetSet - получит объекты из БД

func (*WrappedMongo) GetSetWithOffset

func (wm *WrappedMongo) GetSetWithOffset(objs interface{}, filter bson.D, count int64, offset int64) (err error)

GetSetWithOffset - получит определенное кол-во объектов с отступом

func (*WrappedMongo) GetSetWithPagination

func (wm *WrappedMongo) GetSetWithPagination(objs interface{}, filter bson.D, count int64, page int64) error

GetSetWithPagination - постраничный вывод из БД

func (*WrappedMongo) GetSetWithReversedOffset

func (wm *WrappedMongo) GetSetWithReversedOffset(objs interface{}, filter bson.D, count int64, offset int64) (err error)

GetSetWithReversedOffset - получит массив элементов из БД таким образом, что чтение будет выполнено с конца выборки

func (*WrappedMongo) GetSetWithReversedPagination

func (wm *WrappedMongo) GetSetWithReversedPagination(objs interface{}, filter bson.D, count int64, page int64) (err error)

GetSetWithReversedPagination - постраничный вывод из БД с конца

func (*WrappedMongo) ReplaceObject

func (wm *WrappedMongo) ReplaceObject(replacementObj interface{}, filter bson.D) error

ReplaceObject - заменит объект по фильтру

func (*WrappedMongo) UpdateObject

func (wm *WrappedMongo) UpdateObject(obj interface{}, filter bson.D, update bson.D) error

UpdateObject - обновит объект по фильтру

func (*WrappedMongo) UpdateSet

func (wm *WrappedMongo) UpdateSet(filter bson.D, update bson.D, obj interface{}) (err error)

UpdateSet - обновит объекты