mgorm

README

mgorm

Documentation

Index

• func NewContext() context.Context
• func SetErrorWrapper(fn func(err error) error)
• func WithTimeout(d time.Duration) context.Context
• func WithWrap(ctx context.Context) context.Context
• type AggregateBuilder
  • func (c *AggregateBuilder) All(results interface{}) error
  • func (c *AggregateBuilder) Group(key interface{}, m bson.M) *AggregateBuilder
  • func (c *AggregateBuilder) Limit(limit int64) *AggregateBuilder
  • func (c *AggregateBuilder) Match(match interface{}) *AggregateBuilder
  • func (c *AggregateBuilder) Project(project interface{}) *AggregateBuilder
  • func (c *AggregateBuilder) Skip(skip int64) *AggregateBuilder
  • func (c *AggregateBuilder) Sort(sort interface{}) *AggregateBuilder
• type DeleteBuilder
  • func (c *DeleteBuilder) All() (*mongo.DeleteResult, error)
  • func (c *DeleteBuilder) One() (*mongo.DeleteResult, error)
• type FindBuilder
  • func (c *FindBuilder) All(v interface{}) error
  • func (c *FindBuilder) Limit(num int64) *FindBuilder
  • func (c *FindBuilder) One(v interface{}) error
  • func (c *FindBuilder) Select(keys ...string) *FindBuilder
  • func (c *FindBuilder) Skip(num int64) *FindBuilder
  • func (c *FindBuilder) Sort(sort interface{}) *FindBuilder
• type InsertBuilder
  • func (c *InsertBuilder) All(documents []interface{}) ([]interface{}, error)
  • func (c *InsertBuilder) One(document interface{}) (interface{}, error)
• type Model
  • func (c *Model) Aggregate(ctx context.Context) *AggregateBuilder
  • func (c *Model) Collection() *mongo.Collection
  • func (c *Model) Context() context.Context
  • func (c *Model) Count(ctx context.Context, filter interface{}) (int64, error)
  • func (c *Model) CreateIndex(keys []string, name string, unique bool) error
  • func (c *Model) Delete(ctx context.Context, filter interface{}) *DeleteBuilder
  • func (c *Model) DeleteById(ctx context.Context, id string) (*mongo.DeleteResult, error)
  • func (c *Model) Exists(ctx context.Context, filter interface{}) bool
  • func (c *Model) Find(ctx context.Context, filter interface{}) *FindBuilder
  • func (c *Model) FindById(ctx context.Context, id string, result interface{}) error
  • func (c *Model) Insert(ctx context.Context) *InsertBuilder
  • func (c *Model) ReplaceOne(ctx context.Context, filter bson.M, set bson.M, setOnInsert bson.M) (*mongo.UpdateResult, error)
  • func (c *Model) Update(ctx context.Context, filter interface{}, update interface{}) *UpdateBuilder
  • func (c *Model) UpdateById(ctx context.Context, id string, update interface{}) (*mongo.UpdateResult, error)
• type ORM
  • func NewORM(db *mongo.Database) *ORM
  • func (c *ORM) NewModel(collection string) *Model
  • func (c *ORM) NewTransaction(ctx context.Context, ...) (interface{}, error)
• type UpdateBuilder
  • func (c *UpdateBuilder) All() (*mongo.UpdateResult, error)
  • func (c *UpdateBuilder) One() (*mongo.UpdateResult, error)
  • func (c *UpdateBuilder) SetAll() (*mongo.UpdateResult, error)
  • func (c *UpdateBuilder) SetOne() (*mongo.UpdateResult, error)
  • func (c *UpdateBuilder) SetUpsert(f bool) *UpdateBuilder

Functions

func NewContext

func NewContext() context.Context

default context

func SetErrorWrapper

func SetErrorWrapper(fn func(err error) error)

func WithTimeout

func WithTimeout(d time.Duration) context.Context

func WithWrap

func WithWrap(ctx context.Context) context.Context

Types

type AggregateBuilder

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

func (*AggregateBuilder) All

func (c *AggregateBuilder) All(results interface{}) error

func (*AggregateBuilder) Group

func (c *AggregateBuilder) Group(key interface{}, m bson.M) *AggregateBuilder

func (*AggregateBuilder) Limit

func (c *AggregateBuilder) Limit(limit int64) *AggregateBuilder

func (*AggregateBuilder) Match

func (c *AggregateBuilder) Match(match interface{}) *AggregateBuilder

func (*AggregateBuilder) Project

func (c *AggregateBuilder) Project(project interface{}) *AggregateBuilder

func (*AggregateBuilder) Skip

func (c *AggregateBuilder) Skip(skip int64) *AggregateBuilder

func (*AggregateBuilder) Sort

func (c *AggregateBuilder) Sort(sort interface{}) *AggregateBuilder

type DeleteBuilder

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

func (*DeleteBuilder) All

func (c *DeleteBuilder) All() (*mongo.DeleteResult, error)

func (*DeleteBuilder) One

func (c *DeleteBuilder) One() (*mongo.DeleteResult, error)

type FindBuilder

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

func (*FindBuilder) All

func (c *FindBuilder) All(v interface{}) error

func (*FindBuilder) Limit

func (c *FindBuilder) Limit(num int64) *FindBuilder

func (*FindBuilder) One

func (c *FindBuilder) One(v interface{}) error

func (*FindBuilder) Select

func (c *FindBuilder) Select(keys ...string) *FindBuilder

func (*FindBuilder) Skip

func (c *FindBuilder) Skip(num int64) *FindBuilder

func (*FindBuilder) Sort

func (c *FindBuilder) Sort(sort interface{}) *FindBuilder

type InsertBuilder

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

func (*InsertBuilder) All

func (c *InsertBuilder) All(documents []interface{}) ([]interface{}, error)

func (*InsertBuilder) One

func (c *InsertBuilder) One(document interface{}) (interface{}, error)

type Model

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

func (*Model) Aggregate

func (c *Model) Aggregate(ctx context.Context) *AggregateBuilder

func (*Model) Collection

func (c *Model) Collection() *mongo.Collection

func (*Model) Context

func (c *Model) Context() context.Context

func (*Model) Count

func (c *Model) Count(ctx context.Context, filter interface{}) (int64, error)

func (*Model) CreateIndex

func (c *Model) CreateIndex(keys []string, name string, unique bool) error

func (*Model) Delete

func (c *Model) Delete(ctx context.Context, filter interface{}) *DeleteBuilder

func (*Model) DeleteById

func (c *Model) DeleteById(ctx context.Context, id string) (*mongo.DeleteResult, error)

func (*Model) Exists

func (c *Model) Exists(ctx context.Context, filter interface{}) bool

func (*Model) Find

func (c *Model) Find(ctx context.Context, filter interface{}) *FindBuilder

func (*Model) FindById

func (c *Model) FindById(ctx context.Context, id string, result interface{}) error

func (*Model) Insert

func (c *Model) Insert(ctx context.Context) *InsertBuilder

func (*Model) ReplaceOne

func (c *Model) ReplaceOne(ctx context.Context, filter bson.M, set bson.M, setOnInsert bson.M) (*mongo.UpdateResult, error)

func (*Model) Update

func (c *Model) Update(ctx context.Context, filter interface{}, update interface{}) *UpdateBuilder

func (*Model) UpdateById

func (c *Model) UpdateById(ctx context.Context, id string, update interface{}) (*mongo.UpdateResult, error)

type ORM

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

func NewORM

func NewORM(db *mongo.Database) *ORM

func (*ORM) NewModel

func (c *ORM) NewModel(collection string) *Model

func (*ORM) NewTransaction

func (c *ORM) NewTransaction(ctx context.Context, callback func(tx mongo.SessionContext) (interface{}, error)) (interface{}, error)

type UpdateBuilder

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

func (*UpdateBuilder) All

func (c *UpdateBuilder) All() (*mongo.UpdateResult, error)

func (*UpdateBuilder) One

func (c *UpdateBuilder) One() (*mongo.UpdateResult, error)

func (*UpdateBuilder) SetAll

func (c *UpdateBuilder) SetAll() (*mongo.UpdateResult, error)

func (*UpdateBuilder) SetOne

func (c *UpdateBuilder) SetOne() (*mongo.UpdateResult, error)

func (*UpdateBuilder) SetUpsert

func (c *UpdateBuilder) SetUpsert(f bool) *UpdateBuilder