db

Documentation

Index

• Constants
• type BaseModel
  • func (model *BaseModel) Aggregate(pipeline interface{}, opts ...*options.AggregateOptions) ([]BaseModel, error)
  • func (model *BaseModel) AggregateStream(pipeline interface{}, resultChan ..., opts ...*options.AggregateOptions)
  • func (model *BaseModel) BulkWrite(models []mongo.WriteModel, opts ...*options.BulkWriteOptions) (*mongo.BulkWriteResult, error)
  • func (model *BaseModel) DeleteMany(filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)
  • func (model *BaseModel) DeleteManyTxn(sc mongo.SessionContext, filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)
  • func (model *BaseModel) DeleteOne(filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)
  • func (model *BaseModel) DeleteOneTxn(sc mongo.SessionContext, filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)
  • func (model *BaseModel) Distinct(fieldName string, query interface{}, opts ...*options.DistinctOptions) ([]interface{}, error)
  • func (model *BaseModel) Find(query interface{}, opts ...*options.FindOptions) ([]*BaseModel, error)
  • func (model *BaseModel) FindOne(query interface{}, opts ...*options.FindOneOptions) (*BaseModel, error)
  • func (model *BaseModel) FindOneAndUpdate(query interface{}, value interface{}, ...) (*BaseModel, error)
  • func (model *BaseModel) FindOneAndUpdateTxn(sc mongo.SessionContext, query interface{}, value interface{}, ...) (*BaseModel, error)
  • func (model *BaseModel) FindOneTxn(sc mongo.SessionContext, query interface{}, opts ...*options.FindOneOptions) (*BaseModel, error)
  • func (model *BaseModel) FindStream(query interface{}, result ..., opts ...*options.FindOptions)
  • func (model *BaseModel) GetCollectionName() string
  • func (model *BaseModel) InsertOne(value BaseModel, opts ...*options.InsertOneOptions) (primitive.ObjectID, error)
  • func (model *BaseModel) InsertOneTxn(sc mongo.SessionContext, value BaseModel, opts ...*options.InsertOneOptions) (primitive.ObjectID, error)
  • func (model *BaseModel) SetUpdatedAt()
  • func (model *BaseModel) UpdateMany(query interface{}, value interface{}, options ...*options.UpdateOptions) (*mongo.UpdateResult, error)
  • func (model *BaseModel) UpdateManyTxn(sc mongo.SessionContext, query interface{}, value interface{}, ...) (*mongo.UpdateResult, error)
  • func (model *BaseModel) UpdateOne(query interface{}, value interface{}, options ...*options.UpdateOptions) (*mongo.UpdateResult, error)
  • func (model *BaseModel) UpdateOneTxn(sc mongo.SessionContext, query interface{}, value interface{}, ...) (*mongo.UpdateResult, error)
  • func (model *BaseModel) Watch(ctx context.Context, pipeline interface{}, ...) (*mongo.ChangeStream, error)
• type DBError
  • func ParseError(err error) *DBError
  • func (e *DBError) Error() string

Constants

const (
	// OK is for all OK
	OK = 0

	// UnknownError - errors that is not classified
	UnknownError = 2

	// NoMatchingDocument - error for no documents
	NoMatchingDocument = 47

	// DuplicateKey - Duplicate key
	DuplicateKey = 11000
)

Types

type BaseModel

type BaseModel struct {

	// fields
	DeletedAt *time.Time `bson:"deleted_at,omitempty"`
	UpdatedAt *time.Time `bson:"updated_at,omitempty"`
	CreatedAt *time.Time `bson:"created_at,omitempty"`
	// contains filtered or unexported fields
}

BaseModel is the model for base table

func (*BaseModel) Aggregate

func (model *BaseModel) Aggregate(pipeline interface{}, opts ...*options.AggregateOptions) ([]BaseModel, error)

Aggregate - mongodb aggregate

func (*BaseModel) AggregateStream

func (model *BaseModel) AggregateStream(pipeline interface{}, resultChan chan<- struct {
	Val BaseModel
	Err error
}, opts ...*options.AggregateOptions)

Aggregate - mongodb aggregate

func (*BaseModel) BulkWrite

func (model *BaseModel) BulkWrite(models []mongo.WriteModel, opts ...*options.BulkWriteOptions) (*mongo.BulkWriteResult, error)

func (*BaseModel) DeleteMany

func (model *BaseModel) DeleteMany(filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)

DeleteMany -

func (*BaseModel) DeleteManyTxn

func (model *BaseModel) DeleteManyTxn(sc mongo.SessionContext, filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)

DeleteOneTxn - to DeleteOne

func (*BaseModel) DeleteOne

func (model *BaseModel) DeleteOne(filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)

DeleteOne - to DeleteOne

func (*BaseModel) DeleteOneTxn

func (model *BaseModel) DeleteOneTxn(sc mongo.SessionContext, filter interface{}, opts ...*options.DeleteOptions) (*mongo.DeleteResult, error)

DeleteOneTxn - to DeleteOne

func (*BaseModel) Distinct

func (model *BaseModel) Distinct(fieldName string, query interface{}, opts ...*options.DistinctOptions) ([]interface{}, error)

func (*BaseModel) Find

func (model *BaseModel) Find(query interface{}, opts ...*options.FindOptions) ([]*BaseModel, error)

Find - to find

func (*BaseModel) FindOne

func (model *BaseModel) FindOne(query interface{}, opts ...*options.FindOneOptions) (*BaseModel, error)

FindOne - to findOne

func (*BaseModel) FindOneAndUpdate

func (model *BaseModel) FindOneAndUpdate(query interface{}, value interface{}, options ...*options.FindOneAndUpdateOptions) (*BaseModel, error)

FindOneAndUpdate -

func (*BaseModel) FindOneAndUpdateTxn

func (model *BaseModel) FindOneAndUpdateTxn(sc mongo.SessionContext, query interface{}, value interface{}, options ...*options.FindOneAndUpdateOptions) (*BaseModel, error)

FindOneAndUpdateTxn -

func (*BaseModel) FindOneTxn

func (model *BaseModel) FindOneTxn(sc mongo.SessionContext, query interface{}, opts ...*options.FindOneOptions) (*BaseModel, error)

FindOne - to findOne

func (*BaseModel) FindStream

func (model *BaseModel) FindStream(query interface{}, result chan<- struct {
	Val BaseModel
	Err error
}, opts ...*options.FindOptions)

Find - to find

func (*BaseModel) GetCollectionName

func (model *BaseModel) GetCollectionName() string

GetCollectionName - get collection name

func (*BaseModel) InsertOne

func (model *BaseModel) InsertOne(value BaseModel, opts ...*options.InsertOneOptions) (primitive.ObjectID, error)

InsertOne -

func (*BaseModel) InsertOneTxn

func (model *BaseModel) InsertOneTxn(sc mongo.SessionContext, value BaseModel, opts ...*options.InsertOneOptions) (primitive.ObjectID, error)

InsertOneTxn -

func (*BaseModel) SetUpdatedAt

func (model *BaseModel) SetUpdatedAt()

SetUpdatedAt - Set updated at

func (*BaseModel) UpdateMany

func (model *BaseModel) UpdateMany(query interface{}, value interface{}, options ...*options.UpdateOptions) (*mongo.UpdateResult, error)

UpdateMany -

func (*BaseModel) UpdateManyTxn

func (model *BaseModel) UpdateManyTxn(sc mongo.SessionContext, query interface{}, value interface{}, options ...*options.UpdateOptions) (*mongo.UpdateResult, error)

UpdateManyTxn -

func (*BaseModel) UpdateOne

func (model *BaseModel) UpdateOne(query interface{}, value interface{}, options ...*options.UpdateOptions) (*mongo.UpdateResult, error)

UpdateOne -

func (*BaseModel) UpdateOneTxn

func (model *BaseModel) UpdateOneTxn(sc mongo.SessionContext, query interface{}, value interface{}, options ...*options.UpdateOptions) (*mongo.UpdateResult, error)

UpdateOneTxn -

func (*BaseModel) Watch

func (model *BaseModel) Watch(ctx context.Context, pipeline interface{}, opts ...*options.ChangeStreamOptions) (*mongo.ChangeStream, error)

type DBError

type DBError struct {
	Msg         string
	Code        int
	WriteErrors []mongo.WriteError
}

DBError - Database errors

func ParseError

func ParseError(err error) *DBError

ParseError - Parse db error from Error message

func (*DBError) Error

func (e *DBError) Error() string