easymongo

Aug 27, 2021

Changes in this version

type Collection

+ func (c *Collection) Stats(adminName, promptName, collectionName string) (*CollectionStats, error)

+ type CollectionStats struct

+ AverageObjectSizeBytes int

+ CollectionName string

+ CompressedCollectionSizeInMB int

+ DataCollectionSizeInMB int

+ Namespace string

+ NumberOfDocuments int

+ NumberOfIndexes int

+ TotalCollectionSizeInMB int

+ TotalIndexSizeMB int

Aug 8, 2021

Changes in this version

type Collection

+ func (c *Collection) Name() string

type Connection

+ func (conn *Connection) D(dbName string) *Database

+ func (conn *Connection) EnableDebug() error

+ func (conn *Connection) SetLogger(logger Logger)

type ConnectionBuilder

+ func (c *ConnectionBuilder) WithAuth(creds *options.Credential)

+ func (cb *ConnectionBuilder) Debug() *ConnectionBuilder

+ func (cb *ConnectionBuilder) Logger(logger Logger) *ConnectionBuilder

type Database

+ func (db *Database) Run(cmd interface{}, result interface{}) error

+ type DefaultLogger struct

+ func NewDefaultLogger() *DefaultLogger

+ func (logger *DefaultLogger) Debugf(format string, args ...interface{})

+ func (logger *DefaultLogger) Errorf(format string, args ...interface{})

type FindQuery

+ func (q *FindQuery) DistinctFloat64s(fieldName string) (floatSlice []float64, err error)

+ func (q *FindQuery) DistinctInts(fieldName string) (intSlice []int, err error)

+ type Logger interface

+ Debugf func(format string, args ...interface{})

+ Errorf func(format string, args ...interface{})

Jan 19, 2021

Changes in this version

+ var ErrWrongType = NewMongoErr(errors.New("the type specified could not be decoded into"))

type FindQuery

+ func (q *FindQuery) Distinct(fieldName string) (interfaceSlice []interface{}, err error)

+ func (q *FindQuery) DistinctStrings(fieldName string) (stringSlice []string, err error)

Jan 18, 2021

Changes in this version

+ var ErrNoDocuments = NewMongoErr(mongo.ErrNoDocuments)

+ type AggregationQuery struct

+ func (p *AggregationQuery) All(result interface{}) error

+ func (p *AggregationQuery) AllowDiskUse() *AggregationQuery

+ func (p *AggregationQuery) BatchSize(n int) *AggregationQuery

+ func (p *AggregationQuery) BypassDocumentValidation() *AggregationQuery

+ func (p *AggregationQuery) Collation(c *options.Collation) *AggregationQuery

+ func (p *AggregationQuery) Comment(comment string) *AggregationQuery

+ func (p *AggregationQuery) Cursor() (*mongo.Cursor, error)

+ func (p *AggregationQuery) Hint(indexKeys ...string) *AggregationQuery

+ func (p *AggregationQuery) One(result interface{}) error

+ func (p *AggregationQuery) Timeout(d time.Duration) *AggregationQuery

+ func (p *AggregationQuery) WithContext(ctx context.Context) *AggregationQuery

type Collection

+ func (c *Collection) Aggregate(pipeline interface{}) *AggregationQuery

+ func (c *Collection) EstimatedCount() (int, error)

+ func (c *Collection) UpsertAll(filter interface{}, updateQuery interface{}) (matchedCount, updatedCount int, err error)

type FindAndQuery

+ func (q *FindAndQuery) ReturnDocumentAfterModification() *FindAndQuery

type FindQuery

+ func (q *FindQuery) All(results interface{}) error

+ func (q *FindQuery) Cursor() (*mongo.Cursor, error)

type UpdateQuery

+ func (uq *UpdateQuery) All() (matchedCount, updatedCount int, err error)

Dec 28, 2020

Changes in this version

+ const DefaultAnywhere

+ const DefaultPrimary

+ const DefaultSecondary

+ func GetTimeoutCtx(timeout *time.Duration) (ctx context.Context, cancel context.CancelFunc)

type Collection

+ func (c *Collection) Delete(filter interface{}) *DeleteQuery

+ func (c *Collection) Index(indexNames ...string) *Index

type Connection

+ func (conn *Connection) DatabaseByConnectionType(dbName string, connectFlag ConnectionFlag) *Database

+ type ConnectionBuilder struct

+ func ConnectWith(mongoURI string) *ConnectionBuilder

+ func (cb *ConnectionBuilder) Connect() (*Connection, error)

+ func (cb *ConnectionBuilder) ConnectTimeout(timeout time.Duration) *ConnectionBuilder

+ func (cb *ConnectionBuilder) DefaultOperationTimeout(timeout time.Duration) *ConnectionBuilder

+ func (cb *ConnectionBuilder) DefaultQueryTimeout(timeout time.Duration) *ConnectionBuilder

+ func (cb *ConnectionBuilder) Flags(flags ConnectionFlag) *ConnectionBuilder

+ func (cb *ConnectionBuilder) FromMongoDriverClient(client *mongo.Client) *Connection

+ type ConnectionFlag uint8

+ const ReadConcernAvailable

+ const ReadConcernLinearizable

+ const ReadConcernLocal

+ const ReadConcernMajority

+ const ReadConcernSnapshot

+ const ReadPreferenceNearest

+ const ReadPreferencePrimary

+ const ReadPreferencePrimaryPreferred

+ const ReadPreferenceSecondary

+ const ReadPreferenceSecondaryPreferred

+ const ReadPreferenceWriteConcern

+ const WriteConcernJournal

+ const WriteConcernMajority

+ const WriteConcernW1

+ const WriteConcernW2

+ const WriteConcernW3

+ type DeleteQuery struct

+ func (dq *DeleteQuery) Collation(c *options.Collation) *DeleteQuery

+ func (dq *DeleteQuery) Hint(indexKeys ...string) *DeleteQuery

+ func (dq *DeleteQuery) Many() (numDeleted int, err error)

+ func (dq *DeleteQuery) One() (err error)

type FindAndQuery

+ func (q *FindAndQuery) Limit(limit int) *FindAndQuery

+ func (q *FindAndQuery) Skip(skip int) *FindAndQuery

+ func (q *FindAndQuery) Timeout(d time.Duration) *FindAndQuery

type FindQuery

+ func (q *FindQuery) Collation(c *options.Collation) *FindQuery

+ func (q *FindQuery) Comment(comment string) *FindQuery

+ func (q *FindQuery) Hint(indexKeys ...string) *FindQuery

+ func (q *FindQuery) Sort(fields ...string) *FindQuery

+ func (q *FindQuery) Timeout(d time.Duration) *FindQuery

type Index

+ func (i *Index) Collection() *Collection

+ func (i *Index) Drop() (err error)

+ func (i *Index) Ensure() (indexName string, err error)

+ func (i *Index) Load() (err error)

type ReplaceQuery

+ func (rq *ReplaceQuery) One() error

Dec 1, 2020

Changes in this version

type FindAndQuery

+ func (q *FindAndQuery) ArrayFilters(o *options.ArrayFilters) *FindAndQuery

+ func (q *FindAndQuery) BypassDocumentValidation() *FindAndQuery

+ func (q *FindAndQuery) Projection(projectionQuery interface{}) *FindAndQuery

+ func (q *FindAndQuery) Upsert() *FindAndQuery

Dec 1, 2020

Changes in this version

type Collection

+ func (c *Collection) Drop() (err error)

+ func (c *Collection) MongoDriverCollection() *mongo.Collection

+ func (c *Collection) Update(filter interface{}, update interface{}) *UpdateQuery

+ func (c *Collection) Upsert(filter interface{}, updateQuery interface{}) *UpdateQuery

type Connection

+ func (conn *Connection) Database(dbName string) *Database

type UpdateQuery

+ func (uq *UpdateQuery) ArrayFilters(o *options.ArrayFilters) *UpdateQuery

+ func (uq *UpdateQuery) BypassDocumentValidation() *UpdateQuery

+ func (uq *UpdateQuery) Many() (matchedCount, updatedCount int, err error)

+ func (uq *UpdateQuery) One() (err error)

+ func (uq *UpdateQuery) Upsert() *UpdateQuery

Nov 22, 2020

Changes in this version

+ var ErrNotImplemented = errors.New("this feature has not yet been implemented")

+ var ErrPointerRequired = NewMongoErr(...)

+ var ErrTimeoutOccurred = NewMongoErr(errors.New("timeout during database transaction"))

+ type Aggregation struct

+ func (p *Aggregation) All(result interface{}) error

+ func (p *Aggregation) AllowDiskUse() *Aggregation

+ func (p *Aggregation) Batch(n int) *Aggregation

+ func (p *Aggregation) Explain(result interface{}) error

+ func (p *Aggregation) Iter() *Iter

+ func (p *Aggregation) One(result interface{}) error

+ type Collection struct

+ func GetCollection(dbName, collectionName string) *Collection

+ func (c *Collection) Connection() *Connection

+ func (c *Collection) Count() (int, error)

+ func (c *Collection) DefaultCtx() (context.Context, context.CancelFunc)

+ func (c *Collection) DeleteByID(id interface{})

+ func (c *Collection) DeleteMany()

+ func (c *Collection) DeleteOne()

+ func (c *Collection) Find(filter interface{}) (q *FindQuery)

+ func (c *Collection) FindByDate(after *time.Time, before *time.Time, additionalFilters bson.M) *FindQuery

+ func (c *Collection) FindByID(id interface{}, result interface{}) (err error)

+ func (c *Collection) GetDatabase() *Database

+ func (c *Collection) Insert() *InsertQuery

+ func (c *Collection) Query(filter interface{}) *Query

+ func (c *Collection) Replace(filter interface{}, obj interface{}) *ReplaceQuery

+ func (c *Collection) ReplaceByID(id interface{}, obj interface{}) (err error)

+ func (c *Collection) UpdateByID(id interface{}, update interface{}) (err error)

+ func (c *Collection) UpdateMany(filter interface{}, update interface{}) *UpdateQuery

+ func (c *Collection) UpdateOne(filter interface{}, update interface{}) *UpdateQuery

+ func (c *Collection) UpsertByID(id interface{}, updateQuery interface{}) (err error)

+ func (c *Collection) UpsertMany(filter interface{}, updateQuery interface{}) *UpdateQuery

+ func (c *Collection) UpsertOne(filter interface{}, updateQuery interface{}) *UpdateQuery

+ type Connection struct

+ func Connect(mongoURI string) *Connection

+ func ConnectUsingMongoClient(client *mongo.Client, mongoURI string) *Connection

+ func ConnectWithOptions(mongoURI string, mongoOpts *MongoConnectOptions) (*Connection, error)

+ func GetCurrentConnection() *Connection

+ func (conn *Connection) DatabaseNames() []string

+ func (conn *Connection) GetDatabase(dbName string) *Database

+ func (conn *Connection) GetDefaultTimeoutCtx() (ctx context.Context, cancelFunc context.CancelFunc)

+ func (conn *Connection) ListDatabases() (dbList []*Database)

+ func (conn *Connection) MongoDriverClient() *mongo.Client

+ func (conn *Connection) MongoURI() string

+ func (conn *Connection) Ping() (err error)

+ type Database struct

+ func GetDatabase(dbName string) *Database

+ func (db *Database) C(name string) *Collection

+ func (db *Database) Collection(name string) *Collection

+ func (db *Database) CollectionNames() (collectionNames []string, err error)

+ func (db *Database) DefaultCtx() (context.Context, context.CancelFunc)

+ func (db *Database) Drop() error

+ func (db *Database) ListCollections() ([]*Collection, error)

+ func (db *Database) Name() string

+ type ExplainResult struct

+ QueryPlanner QueryPlanner

+ type FindAndQuery struct

+ func (q *FindAndQuery) Delete() (err error)

+ func (q *FindAndQuery) Replace(replacementObject interface{}) (err error)

+ func (q *FindAndQuery) Update(updateQuery interface{}) (err error)

+ type FindQuery struct

+ func (q *FindQuery) AllowDiskUse() *FindQuery

+ func (q *FindQuery) AllowPartialResults() *FindQuery

+ func (q *FindQuery) BatchSize(batchSize int) *FindQuery

+ func (q *FindQuery) Count() (int, error)

+ func (q *FindQuery) CountOptions() *options.CountOptions

+ func (q *FindQuery) FindOneOptions() *options.FindOneOptions

+ func (q *FindQuery) FindOptions() *options.FindOptions

+ func (q *FindQuery) Iter() (iter *Iter, err error)

+ func (q *FindQuery) Limit(limit int) *FindQuery

+ func (q *FindQuery) Many(results interface{}) error

+ func (q *FindQuery) Max(x interface{}) *FindQuery

+ func (q *FindQuery) MaxAwaitTime(x *time.Duration) *FindQuery

+ func (q *FindQuery) Min(x interface{}) *FindQuery

+ func (q *FindQuery) NoCursorTimeout(x *bool) *FindQuery

+ func (q *FindQuery) One(result interface{}) (err error)

+ func (q *FindQuery) OneAnd(result interface{}) *FindAndQuery

+ func (q *FindQuery) OplogReplay(x *bool) *FindQuery

+ func (q *FindQuery) Projection(projectionQuery interface{}) *FindQuery

+ func (q *FindQuery) ReturnKey(x *bool) *FindQuery

+ func (q *FindQuery) ShowRecordID(x *bool) *FindQuery

+ func (q *FindQuery) Skip(skip int) *FindQuery

+ func (q *FindQuery) Snapshot(x *bool) *FindQuery

+ type Index struct

+ type InputStage struct

+ InputStages []interface{}

+ Stage string

+ type InsertQuery struct

+ func (iq *InsertQuery) Many(objsToInsert interface{}) (ids []*primitive.ObjectID, err error)

+ func (iq *InsertQuery) ManyFromInterfaceSlice(objsToInsert []interface{}) (ids []*primitive.ObjectID, err error)

+ func (iq *InsertQuery) One(objToInsert interface{}) (id *primitive.ObjectID, err error)

+ type Iter struct

+ func (iter *Iter) All(results interface{}) error

+ func (iter *Iter) Close() error

+ func (iter *Iter) Done() bool

+ func (iter *Iter) Err() (err error)

+ func (iter *Iter) Next(result interface{}) bool

+ func (iter *Iter) TimedOut() bool

+ type MongoConnectOptions struct

+ type MongoErr struct

+ Message string

+ func NewMongoErr(err error) (me MongoErr)

+ func (me MongoErr) Error() string

+ func (me MongoErr) Unwrap() error

+ type ParsedQuery struct

+ type Plan struct

+ InputStage InputStage

+ Stage string

+ type Query struct

+ func (q *Query) Collation(c *options.Collation) *Query

+ func (q *Query) Comment(comment string) *Query

+ func (q *Query) Hint(indexKey ...string) *Query

+ func (q *Query) Sort(fields ...string) *Query

+ func (q *Query) Timeout(d time.Duration) *Query

+ type QueryPlanner struct

+ IndexFilterSet bool

+ Namespace string

+ OptimizedPipeline bool

+ ParsedQuery ParsedQuery

+ PlanCacheKey string

+ PlannerVersion string

+ QueryHash string

+ RejectedPlans []Plan

+ WinningPlan Plan

+ type ReplaceQuery struct

+ func (rq *ReplaceQuery) Execute() error

+ type UpdateQuery struct

+ func (uq *UpdateQuery) Do() (matchedCount, updatedCount int, err error)

+ func (uq *UpdateQuery) UpdateOptions() *options.UpdateOptions

+ type UpdateQueryConstructor struct

+ func (qc *UpdateQueryConstructor) AddToSet(arrayFieldName string, objToAdd interface{}) *UpdateQueryConstructor

+ func (qc *UpdateQueryConstructor) Decrement(fieldName string, i int) *UpdateQueryConstructor

+ func (qc *UpdateQueryConstructor) Increment(fieldName string, i int) *UpdateQueryConstructor

+ func (qc *UpdateQueryConstructor) Match(query interface{}) *UpdateQueryConstructor

+ func (qc *UpdateQueryConstructor) PopFirst(arrayFieldName string) *UpdateQueryConstructor

+ func (qc *UpdateQueryConstructor) PopLast(arrayFieldName string) *UpdateQueryConstructor

+ func (qc *UpdateQueryConstructor) Pull(arrayFieldName string, pullCondition interface{}) *UpdateQueryConstructor

+ func (qc *UpdateQueryConstructor) PullAll(arrayFieldName string, pullCondition interface{}) *UpdateQueryConstructor

+ func (qc *UpdateQueryConstructor) Push(arrayFieldName string, objToPush interface{}) *UpdateQueryConstructor

+ func (qc *UpdateQueryConstructor) Set(fieldName string, objToSet interface{}) *UpdateQueryConstructor