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]) RegisterAfterHooks(hooks ...afterHookFn[T]) *Finder[T]
  • func (f *Finder[T]) RegisterBeforeHooks(hooks ...beforeHookFn) *Finder[T]
• type OpContext
  • func NewOpContext(col *mongo.Collection, filter any, opts ...OpContextOption) *OpContext
• type OpContextOption

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]) 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]

type OpContext

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

func NewOpContext

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

type OpContextOption

type OpContextOption func(*OpContext)