Documentation
¶
Index ¶
- Constants
- Variables
- func CreateSession(client *mongo.Client) (mongo.Session, error)
- func CreateTransaction(ctx context.Context, client *mongo.Client, ...) error
- func CreateTransactionOptions() *options.TransactionOptions
- func GetObjectIDFromString(id string) (*primitive.ObjectID, error)
- func NewCompoundFieldIndex(fieldIndexes []*FieldIndex, unique bool) *mongo.IndexModel
- func NewTTLIndex(fieldName string, expireAfterSeconds int32) *mongo.IndexModel
- func NewUniqueIndex(fieldIndex FieldIndex, unique bool) *mongo.IndexModel
- func PrepareFindOneAndUpdateOptions(projection any, sort any, upsert bool, returnDocument options.ReturnDocument) *options.FindOneAndUpdateOptions
- func PrepareFindOneOptions(projection any, sort any) *options.FindOneOptions
- func PrepareFindOptions(projection any, sort any, limit int64, skip int64) *options.FindOptions
- func PrepareUpdateOptions(upsert bool) *options.UpdateOptions
- type Collection
- type FieldIndex
- type Order
Constants ¶
const (
ErrFailedToCreateIndex = "failed to create index '%v': %v"
)
Variables ¶
Functions ¶
func CreateSession ¶
CreateSession creates a new session
Parameters:
*client *mongo.Client: the MongoDB client
Returns:
(mongo.Session, error): the MongoDB session and an error if any
func CreateTransaction ¶
func CreateTransaction( ctx context.Context, client *mongo.Client, queries func(sc mongo.SessionContext) error, ) error
CreateTransaction creates a new transaction
Parameters:
ctx context.Context: the context *client *mongo.Client: the MongoDB client *queries func(sc mongo.SessionContext) error: the queries to execute in the transaction
Returns:
error: an error if any
func CreateTransactionOptions ¶
func CreateTransactionOptions() *options.TransactionOptions
CreateTransactionOptions creates the transaction options
Returns:
*options.TransactionOptions: the transaction options
func GetObjectIDFromString ¶ added in v0.7.5
GetObjectIDFromString gets the object ID from the string
Parameters:
- id: the string ID to convert
Returns:
- *primitive.ObjectID: the object ID
- error: if any error occurred
func NewCompoundFieldIndex ¶
func NewCompoundFieldIndex( fieldIndexes []*FieldIndex, unique bool, ) *mongo.IndexModel
NewCompoundFieldIndex creates a new compound field index model
func NewTTLIndex ¶
func NewTTLIndex(fieldName string, expireAfterSeconds int32) *mongo.IndexModel
NewTTLIndex creates a new TTL index model
func NewUniqueIndex ¶
func NewUniqueIndex(fieldIndex FieldIndex, unique bool) *mongo.IndexModel
NewUniqueIndex creates a new unique field index model
func PrepareFindOneAndUpdateOptions ¶ added in v0.2.0
func PrepareFindOneAndUpdateOptions( projection any, sort any, upsert bool, returnDocument options.ReturnDocument, ) *options.FindOneAndUpdateOptions
PrepareFindOneAndUpdateOptions prepares the find one and update options
Parameters:
- projection: The projection to apply to the query
- sort: The sort to apply to the query
- upsert: Whether to upsert the document if it doesn't exist
- returnDocument: The return document option
Returns:
- *options.FindOneAndUpdateOptions: The prepared find one and update options
func PrepareFindOneOptions ¶
func PrepareFindOneOptions( projection any, sort any, ) *options.FindOneOptions
PrepareFindOneOptions prepares the find one options
Parameters:
- projection: The projection to apply to the query
- sort: The sort to apply to the query
Returns:
- *options.FindOneOptions: The prepared find one options
func PrepareFindOptions ¶
PrepareFindOptions prepares the find options
Parameters:
- projection: The projection to apply to the query
- sort: The sort to apply to the query
- limit: The limit to apply to the query
- skip: The skip to apply to the query
Returns:
- *options.FindOptions: The prepared find options
func PrepareUpdateOptions ¶
func PrepareUpdateOptions(upsert bool) *options.UpdateOptions
PrepareUpdateOptions prepares the update options
Parameters:
- upsert: Whether to upsert the document if it doesn't exist
Returns:
- *options.UpdateOptions: The prepared update options
Types ¶
type Collection ¶
type Collection struct {
Indexes []*mongo.IndexModel
// contains filtered or unexported fields
}
Collection represents a MongoDB collection
func NewCollection ¶
func NewCollection( name string, indexes []*mongo.IndexModel, ) *Collection
NewCollection creates a new MongoDB collection
Parameters:
- name: the name of the collection
- indexes: the indexes to create for the collection
Returns:
- *Collection: the new collection
func (Collection) CreateCollection ¶
func (c Collection) CreateCollection(database *mongo.Database) ( collection *mongo.Collection, err error, )
CreateCollection creates the collection
Parameters:
- database: the MongoDB database
type FieldIndex ¶
type FieldIndex struct {
// contains filtered or unexported fields
}
FieldIndex represents a field index
func NewFieldIndex ¶
func NewFieldIndex(name string, order Order) *FieldIndex
NewFieldIndex creates a new field index
Source Files