finder

Documentation

Index

• type AfterOpContext
  • func NewAfterOpContext[T any](opContext *OpContext, opts ...AfterOpContextOption[T]) *AfterOpContext[T]
• type AfterOpContextOption
  • func WithDoc[T any](doc *T) AfterOpContextOption[T]
  • func WithDocs[T any](docs []*T) AfterOpContextOption[T]
• type Finder
  • func NewFinder[T any](collection *mongo.Collection) *Finder[T]
  • func (f *Finder[T]) Count(ctx context.Context, opts ...*options.CountOptions) (int64, error)
  • func (f *Finder[T]) Distinct(ctx context.Context, fieldName string, opts ...*options.DistinctOptions) ([]any, error)
  • func (f *Finder[T]) DistinctWithParse(ctx context.Context, fieldName string, result any, ...) error
  • func (f *Finder[T]) Filter(filter any) *Finder[T]
  • func (f *Finder[T]) Find(ctx context.Context, opts ...*options.FindOptions) ([]*T, error)
  • func (f *Finder[T]) FindOne(ctx context.Context, opts ...*options.FindOneOptions) (*T, error)
  • func (f *Finder[T]) FindOneAndUpdate(ctx context.Context, opts ...*options.FindOneAndUpdateOptions) (*T, error)
  • func (f *Finder[T]) ModelHook(modelHook any) *Finder[T]
  • func (f *Finder[T]) RegisterAfterHooks(hooks ...afterHookFn[T]) *Finder[T]
  • func (f *Finder[T]) RegisterBeforeHooks(hooks ...beforeHookFn) *Finder[T]
  • func (f *Finder[T]) Updates(update any) *Finder[T]
• type IFinder
• type IllegalUser
• type OpContext
  • func NewOpContext(col *mongo.Collection, filter any, opts ...OpContextOption) *OpContext
• type OpContextOption
  • func WithModelHook(modelHook any) OpContextOption
  • func WithMongoOptions(mongoOptions any) OpContextOption
  • func WithUpdates(updates any) OpContextOption
• type TestTempUser
• type TestUser
  • func (tu *TestUser) DefaultCreatedAt()
  • func (tu *TestUser) DefaultUpdatedAt()
• type UpdatedUser
• type UserName

Types

type AfterOpContext

type AfterOpContext[T any] struct {
	*OpContext `opt:"-"`
	Doc        *T
	Docs       []*T
}

func NewAfterOpContext

func NewAfterOpContext[T any](opContext *OpContext, opts ...AfterOpContextOption[T]) *AfterOpContext[T]

type AfterOpContextOption

type AfterOpContextOption[T any] func(*AfterOpContext[T])

func WithDoc

func WithDoc[T any](doc *T) AfterOpContextOption[T]

func WithDocs

func WithDocs[T any](docs []*T) AfterOpContextOption[T]

type Finder

type Finder[T any] struct {
	// contains filtered or unexported fields
}

func NewFinder

func NewFinder[T any](collection *mongo.Collection) *Finder[T]

func (*Finder[T]) Count

func (f *Finder[T]) Count(ctx context.Context, opts ...*options.CountOptions) (int64, error)

func (*Finder[T]) Distinct

func (f *Finder[T]) Distinct(ctx context.Context, fieldName string, opts ...*options.DistinctOptions) ([]any, error)

func (*Finder[T]) DistinctWithParse

func (f *Finder[T]) DistinctWithParse(ctx context.Context, fieldName string, result any, opts ...*options.DistinctOptions) error

DistinctWithParse is used to parse the result of Distinct result must be a pointer

func (*Finder[T]) Filter

func (f *Finder[T]) Filter(filter any) *Finder[T]

Filter is used to set the filter of the query

func (*Finder[T]) Find

func (f *Finder[T]) Find(ctx context.Context, opts ...*options.FindOptions) ([]*T, error)

func (*Finder[T]) FindOne

func (f *Finder[T]) FindOne(ctx context.Context, opts ...*options.FindOneOptions) (*T, error)

func (*Finder[T]) FindOneAndUpdate

func (f *Finder[T]) FindOneAndUpdate(ctx context.Context, opts ...*options.FindOneAndUpdateOptions) (*T, error)

func (*Finder[T]) ModelHook

func (f *Finder[T]) ModelHook(modelHook any) *Finder[T]

func (*Finder[T]) RegisterAfterHooks

func (f *Finder[T]) RegisterAfterHooks(hooks ...afterHookFn[T]) *Finder[T]

RegisterAfterHooks is used to set the after hooks of the query If you register the hook for FindOne, the opContext.Docs will be nil If you register the hook for Find, the opContext.Doc will be nil

func (*Finder[T]) RegisterBeforeHooks

func (f *Finder[T]) RegisterBeforeHooks(hooks ...beforeHookFn) *Finder[T]

func (*Finder[T]) Updates

func (f *Finder[T]) Updates(update any) *Finder[T]

type IFinder

type IFinder[T any] interface {
	FindOne(ctx context.Context, opts ...*options.FindOneOptions) (*T, error)
	Find(ctx context.Context, opts ...*options.FindOptions) ([]*T, error)
	Count(ctx context.Context, opts ...*options.CountOptions) (int64, error)
	Distinct(ctx context.Context, fieldName string, opts ...*options.DistinctOptions) ([]any, error)
	DistinctWithParse(ctx context.Context, fieldName string, result any, opts ...*options.DistinctOptions) error
	FindOneAndUpdate(ctx context.Context, opts ...*options.FindOneAndUpdateOptions) (*T, error)
}

type IllegalUser

type IllegalUser struct {
	ID   primitive.ObjectID `bson:"_id,omitempty"`
	Name string             `bson:"name"`
	Age  string
}

type OpContext

type OpContext struct {
	Col          *mongo.Collection `opt:"-"`
	Filter       any               `opt:"-"`
	Updates      any
	MongoOptions any
	ModelHook    any
}

func NewOpContext

func NewOpContext(col *mongo.Collection, filter any, opts ...OpContextOption) *OpContext

type OpContextOption

type OpContextOption func(*OpContext)

func WithModelHook

func WithModelHook(modelHook any) OpContextOption

func WithMongoOptions

func WithMongoOptions(mongoOptions any) OpContextOption

func WithUpdates

func WithUpdates(updates any) OpContextOption

type TestTempUser

type TestTempUser struct {
	Id           string `bson:"_id"`
	Name         string `bson:"name"`
	Age          int64
	UnknownField string `bson:"-"`
}

type TestUser

type TestUser struct {
	ID           primitive.ObjectID `bson:"_id,omitempty"`
	Name         string             `bson:"name"`
	Age          int64
	UnknownField string    `bson:"-"`
	CreatedAt    time.Time `bson:"created_at"`
	UpdatedAt    time.Time `bson:"updated_at"`
}

func (*TestUser) DefaultCreatedAt

func (tu *TestUser) DefaultCreatedAt()

func (*TestUser) DefaultUpdatedAt

func (tu *TestUser) DefaultUpdatedAt()

type UpdatedUser

type UpdatedUser struct {
	Name string `bson:"name"`
	Age  int64
}

type UserName

type UserName struct {
	Name string `bson:"name"`
}