MongoDB - Client
Resource for MongoDB integrations.
accumulators
_mongo.accumulators() : MongoAccumulators
Description
A factory for defining aggregation accumulators.
How To Use
_mongo.aggregates().group('$customerId', _mongo.accumulators().sum('total', '$price'));
Return
The accumulator factory.
aggregates
_mongo.aggregates() : MongoAggregates
Description
A factory for defining aggregation stages.
How To Use
collection.aggregate(_mongo.aggregates().match(_mongo.filters().eq('status', 'Active')));
Return
( MongoAggregates )
The aggregation factory.
close
_mongo.close() : void
Description
Closes the MongoDB connection.
How To Use
_mongo.close();
Return
( void )
countOptions
_mongo.countOptions() : com.mongodb.client.model.CountOptions
Description
Creates options for counting documents.
Return
( com.mongodb.client.model.CountOptions )
The count options.
database
_mongo.database(name: string) : MongoDatabase
Description
Gets an instance of a MongoDB database.
How To Use
const mongo = _mongo.init('netunoapp');
cont db = mongo.database('mydb');
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| name | string | The database name. |
Return
( MongoDatabase )
The MongoDB database instance.
deleteOptions
_mongo.deleteOptions() : com.mongodb.client.model.DeleteOptions
Description
Creates options for delete operations.
Return
( com.mongodb.client.model.DeleteOptions )
The delete options.
docToVal
_mongo.docToVal(doc: org.bson.Document) : Values
Description
Converts a BSON document to a Values object.
How To Use
const values = _mongo.docToVal(doc);
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| doc | org.bson.Document | The BSON document to convert. |
Return
( Values )
The resulting Values object.
document
_mongo.document() : org.bson.Document
Description
Creates a new empty document.
How To Use
const doc = _mongo.document();
Return
( org.bson.Document )
A new empty document.
dropCollectionOptions
_mongo.dropCollectionOptions() : com.mongodb.client.model.DropCollectionOptions
Description
Creates options for dropping a collection.
Return
( com.mongodb.client.model.DropCollectionOptions )
The drop collection options.
estimatedDocumentCountOptions
_mongo.estimatedDocumentCountOptions() : com.mongodb.client.model.EstimatedDocumentCountOptions
Description
Creates options for estimated document count.
Return
( com.mongodb.client.model.EstimatedDocumentCountOptions )
The estimated document count options.
filters
_mongo.filters() : MongoFilters
Description
A factory for defining query filters.
How To Use
collection.find(_mongo.filters().eq('status', 'Active'));
Return
( MongoFilters )
The filter factory.
findOneAndDeleteOptions
_mongo.findOneAndDeleteOptions() : com.mongodb.client.model.FindOneAndDeleteOptions
Description
Creates options for finding and deleting a single document.
Return
( com.mongodb.client.model.FindOneAndDeleteOptions )
The find one and delete options.
findOneAndReplaceOptions
_mongo.findOneAndReplaceOptions() : com.mongodb.client.model.FindOneAndReplaceOptions
Description
Creates options for finding and replacing a single document.
Return
( com.mongodb.client.model.FindOneAndReplaceOptions )
The find one and replace options.
findOneAndUpdateOptions
_mongo.findOneAndUpdateOptions() : com.mongodb.client.model.FindOneAndUpdateOptions
Description
Creates options for finding and updating a single document.
Return
( com.mongodb.client.model.FindOneAndUpdateOptions )
The find one and update options.
indexes
_mongo.indexes() : MongoIndexes
Description
A factory for defining index keys.
How To Use
collection.createIndex(_mongo.indexes().ascending('quantity', 'price'));
Return
( MongoIndexes )
The index factory.
init
_mongo.init() : Mongo
Description
Inicializa a conexão com o MongoDB utilizando a configuração padrão.
Return
( Mongo )
The MongoDB client instance.
_mongo.init(configKeyOrUrl: string) : Mongo
Description
Initializes the connection to MongoDB using a configuration key or connection URL.
How To Use
const mongo = _mongo.init('mongodb://localhost:27017/mydb');
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| configKeyOrUrl | string | The configuration key or the MongoDB connection URL. |
Return
( Mongo )
The MongoDB client instance.
insertManyOptions
_mongo.insertManyOptions() : com.mongodb.client.model.InsertManyOptions
Description
Creates options for inserting multiple documents.
Return
( com.mongodb.client.model.InsertManyOptions )
The insert many options.
insertOneOptions
_mongo.insertOneOptions() : com.mongodb.client.model.InsertOneOptions
Description
Creates options for inserting a single document.
Return
( com.mongodb.client.model.InsertOneOptions )
The insert one options.
projections
_mongo.projections() : MongoProjections
Description
A factory for defining field projections.
How To Use
collection.find().projection(_mongo.projections().include('name', 'quantity')).all();
Return
( MongoProjections )
The projection factory.
replaceOptions
_mongo.replaceOptions() : com.mongodb.client.model.ReplaceOptions
Description
Creates options for replace operations.
Return
( com.mongodb.client.model.ReplaceOptions )
The replace options.
sorts
_mongo.sorts() : MongoSorts
Description
A factory for defining sorts.
How To Use
collection.find().sort(_mongo.sorts().ascending('name')).all();
Return
( MongoSorts )
The sort factory.
textSearchOptions
_mongo.textSearchOptions() : com.mongodb.client.model.TextSearchOptions
Description
Creates options for text search.
Return
( com.mongodb.client.model.TextSearchOptions )
The text search options.
updateOptions
_mongo.updateOptions() : com.mongodb.client.model.UpdateOptions
Description
Creates options for update operations.
Return
( com.mongodb.client.model.UpdateOptions )
The update options.
updates
_mongo.updates() : MongoUpdates
Description
A factory for defining data updates.
How To Use
collection.updateOne(filter, _mongo.updates().set('name', 'New Name'));
Return
( MongoUpdates )
The updates factory.
valToDoc
_mongo.valToDoc(values: Values) : org.bson.Document
Description
Converts a Values object to a BSON document.
How To Use
const doc = _mongo.valToDoc(values);
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| values | Values | The Values object to convert. |
Return
( org.bson.Document )
The resulting BSON document.