model

Documentation

Index

• type Addr
  • func (a *Addr) String() string
• type Bson
• type BulkWriteResult
  • func FromBulkWriteResult[I bson.ID](r *mongo.BulkWriteResult) *BulkWriteResult[I]
• type Index
  • func From(model *mongo.IndexModel) *Index
  • func NewIndex(keys ...Pair[sorts.Order]) *Index
  • func (i *Index) Background() *Index
  • func (i *Index) Bits(bits int32) *Index
  • func (i *Index) BucketSize(bucketSize int32) *Index
  • func (i *Index) Collation(collation *rawopts.Collation) *Index
  • func (i *Index) DefaultLanguage(language string) *Index
  • func (i *Index) ExpireAfterSeconds(seconds int32) *Index
  • func (i *Index) Hidden() *Index
  • func (i *Index) LanguageOverride(override string) *Index
  • func (i *Index) Marshal() mongo.IndexModel
  • func (i *Index) Max(max float64) *Index
  • func (i *Index) Min(min float64) *Index
  • func (i *Index) Name(name string) *Index
  • func (i *Index) PartialFilterExpression(expression interface{}) *Index
  • func (i *Index) Sparse() *Index
  • func (i *Index) SphereVersion(version int32) *Index
  • func (i *Index) StorageEngine(engine interface{}) *Index
  • func (i *Index) TextVersion(version int32) *Index
  • func (i *Index) Unique() *Index
  • func (i *Index) Version(version int32) *Index
  • func (i *Index) Weights(weights interface{}) *Index
  • func (i *Index) WildcardProjection(wildcardProjection interface{}) *Index
• type Pair
• type UpdateResult
  • func FromUpdateResult[I bson.ID](r *mongo.UpdateResult) *UpdateResult[I]

Types

type Addr

type Addr struct {
	Host string
	Port int
}

func (*Addr) String

func (a *Addr) String() string

type Bson

type Bson interface {
	bson.M | bson.D | bson.A | bson.E
}

type BulkWriteResult

type BulkWriteResult[I bson.ID] struct {
	// The number of documents inserted.
	InsertedCount int64

	// The number of documents matched by filters in update and replace operations.
	MatchedCount int64

	// The number of documents modified by update and replace operations.
	ModifiedCount int64

	// The number of documents deleted.
	DeletedCount int64

	// The number of documents upserted by update and replace operations.
	UpsertedCount int64

	// A map of operation index to the _id of each upserted document.
	UpsertedIDs map[int64]I
}

BulkWriteResult is the result type returned by a BulkWrite operation.

func FromBulkWriteResult

func FromBulkWriteResult[I bson.ID](r *mongo.BulkWriteResult) *BulkWriteResult[I]

type Index

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

func From

func From(model *mongo.IndexModel) *Index

func NewIndex

func NewIndex(keys ...Pair[sorts.Order]) *Index

func (*Index) Background

func (i *Index) Background() *Index

Background sets value for the Background field.

Deprecated: This option has been deprecated in MongoDB version 4.2.

func (*Index) Bits

func (i *Index) Bits(bits int32) *Index

Bits sets the value for the Bits field.

func (*Index) BucketSize

func (i *Index) BucketSize(bucketSize int32) *Index

BucketSize sets the value for the BucketSize field

func (*Index) Collation

func (i *Index) Collation(collation *rawopts.Collation) *Index

Collation sets the value for the Collation field.

func (*Index) DefaultLanguage

func (i *Index) DefaultLanguage(language string) *Index

DefaultLanguage sets the value for the DefaultLanguage field.

func (*Index) ExpireAfterSeconds

func (i *Index) ExpireAfterSeconds(seconds int32) *Index

ExpireAfterSeconds sets value for the ExpireAfterSeconds field.

func (*Index) Hidden

func (i *Index) Hidden() *Index

Hidden sets the value for the Hidden field.

func (*Index) LanguageOverride

func (i *Index) LanguageOverride(override string) *Index

LanguageOverride sets the value of the LanguageOverride field.

func (*Index) Marshal

func (i *Index) Marshal() mongo.IndexModel

func (*Index) Max

func (i *Index) Max(max float64) *Index

Max sets the value for the Max field.

func (*Index) Min

func (i *Index) Min(min float64) *Index

Min sets the value for the Min field.

func (*Index) Name

func (i *Index) Name(name string) *Index

Name sets the value for the Name field.

func (*Index) PartialFilterExpression

func (i *Index) PartialFilterExpression(expression interface{}) *Index

PartialFilterExpression sets the value for the PartialFilterExpression field.

func (*Index) Sparse

func (i *Index) Sparse() *Index

Sparse sets the value of the Sparse field.

func (*Index) SphereVersion

func (i *Index) SphereVersion(version int32) *Index

SphereVersion sets the value for the SphereVersion field.

func (*Index) StorageEngine

func (i *Index) StorageEngine(engine interface{}) *Index

StorageEngine sets the value for the StorageEngine field.

func (*Index) TextVersion

func (i *Index) TextVersion(version int32) *Index

TextVersion sets the value for the TextVersion field.

func (*Index) Unique

func (i *Index) Unique() *Index

Unique sets the value for the Unique field.

func (*Index) Version

func (i *Index) Version(version int32) *Index

Version sets the value for the Version field.

func (*Index) Weights

func (i *Index) Weights(weights interface{}) *Index

Weights sets the value for the Weights field.

func (*Index) WildcardProjection

func (i *Index) WildcardProjection(wildcardProjection interface{}) *Index

WildcardProjection sets the value for the WildcardProjection field.

type Pair

type Pair[V any] struct {
	Key   string
	Value V
}

type UpdateResult

type UpdateResult[I bson.ID] struct {
	MatchedCount  int64 // The number of documents matched by the filter.
	ModifiedCount int64 // The number of documents modified by the operation.
	UpsertedCount int64 // The number of documents upserted by the operation.
	UpsertedID    I     // The _id field of the upserted document, or nil if no upsert was done.
}

func FromUpdateResult

func FromUpdateResult[I bson.ID](r *mongo.UpdateResult) *UpdateResult[I]