MongoDB - Cliente
Recurso para integrações com o MongoDB.
accumulators
_mongo.accumulators() : MongoAccumulators
Descrição
Cria uma factory para definir acumuladores de agregação.
Como Usar
_mongo.aggregates().group('$customerId', _mongo.accumulators().sum('total', '$price'));
Retorno
A factory de acumuladores.
aggregates
_mongo.aggregates() : MongoAggregates
Descrição
Cria uma factory para definir etapas de agregação.
Como Usar
collection.aggregate(_mongo.aggregates().match(_mongo.filters().eq('status', 'Active')));
Retorno
( MongoAggregates )
A factory de agregação.
close
_mongo.close() : void
Descrição
Fecha a conexão com o MongoDB.
Como Usar
_mongo.close();
Retorno
( void )
countOptions
_mongo.countOptions() : com.mongodb.client.model.CountOptions
Descrição
Cria opções para contagem de documentos.
Retorno
( com.mongodb.client.model.CountOptions )
As opções de contagem.
database
_mongo.database(nome: string) : MongoDatabase
Descrição
Obtém uma instância de uma base de dados MongoDB.
Como Usar
const mongo = _mongo.init('netunoapp');
cont db = mongo.database('mydb');
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| nome | string | O nome da base de dados. |
Retorno
( MongoDatabase )
A instância da base de dados MongoDB.
deleteOptions
_mongo.deleteOptions() : com.mongodb.client.model.DeleteOptions
Descrição
Cria opções para operações de remoção de documentos.
Retorno
( com.mongodb.client.model.DeleteOptions )
As opções de remoção.
docToVal
_mongo.docToVal(documento: org.bson.Document) : Values
Descrição
Converte um documento BSON para um objeto Values.
Como Usar
const values = _mongo.docToVal(doc);
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| documento | org.bson.Document | O documento BSON a ser convertido. |
Retorno
( Values )
O objeto Values resultante.
document
_mongo.document() : org.bson.Document
Descrição
Cria um novo documento vazio.
Como Usar
const doc = _mongo.document();
Retorno
( org.bson.Document )
Um novo documento vazio.
dropCollectionOptions
_mongo.dropCollectionOptions() : com.mongodb.client.model.DropCollectionOptions
Descrição
Cria opções para remoção de uma coleção.
Retorno
( com.mongodb.client.model.DropCollectionOptions )
As opções de remoção da coleção.
estimatedDocumentCountOptions
_mongo.estimatedDocumentCountOptions() : com.mongodb.client.model.EstimatedDocumentCountOptions
Descrição
Cria opções para contagem estimada de documentos.
Retorno
( com.mongodb.client.model.EstimatedDocumentCountOptions )
As opções de contagem estimada.
filters
_mongo.filters() : MongoFilters
Descrição
Cria uma factory para definir filtros de consulta.
Como Usar
collection.find(_mongo.filters().eq('status', 'Active'));
Retorno
( MongoFilters )
A factory de filtros.
findOneAndDeleteOptions
_mongo.findOneAndDeleteOptions() : com.mongodb.client.model.FindOneAndDeleteOptions
Descrição
Cria opções para encontrar e remover um único documento.
Retorno
( com.mongodb.client.model.FindOneAndDeleteOptions )
As opções de encontrar e remover.
findOneAndReplaceOptions
_mongo.findOneAndReplaceOptions() : com.mongodb.client.model.FindOneAndReplaceOptions
Descrição
Cria opções para encontrar e substituir um único documento.
Retorno
( com.mongodb.client.model.FindOneAndReplaceOptions )
As opções de encontrar e substituir.
findOneAndUpdateOptions
_mongo.findOneAndUpdateOptions() : com.mongodb.client.model.FindOneAndUpdateOptions
Descrição
Cria opções para encontrar e atualizar um único documento.
Retorno
( com.mongodb.client.model.FindOneAndUpdateOptions )
As opções de encontrar e atualizar.
indexes
_mongo.indexes() : MongoIndexes
Descrição
Uma factory para definir chaves de índice.
Como Usar
collection.createIndex(_mongo.indexes().ascending('quantity', 'price'));
Retorno
( MongoIndexes )
A factory de índices.
init
_mongo.init() : Mongo
Descrição
Inicializa a conexão com o MongoDB utilizando a configuração padrão.
Retorno
( Mongo )
A instância do cliente MongoDB.
_mongo.init(chaveOuUrl: string) : Mongo
Descrição
Inicializa a conexão com o MongoDB utilizando uma chave de configuração ou URL de conexão.
Como Usar
const mongo = _mongo.init('mongodb://localhost:27017/mydb');
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| chaveOuUrl | string | A chave de configuração ou a URL de conexão do MongoDB. |
Retorno
( Mongo )
A instância do cliente MongoDB.
insertManyOptions
_mongo.insertManyOptions() : com.mongodb.client.model.InsertManyOptions
Descrição
Cria opções para inserção de múltiplos documentos.
Retorno
( com.mongodb.client.model.InsertManyOptions )
As opções de inserção.
insertOneOptions
_mongo.insertOneOptions() : com.mongodb.client.model.InsertOneOptions
Descrição
Cria opções para inserção de um único documento.
Retorno
( com.mongodb.client.model.InsertOneOptions )
As opções de inserção.
projections
_mongo.projections() : MongoProjections
Descrição
Cria uma factory para definir projeções de campos.
Como Usar
collection.find().projection(_mongo.projections().include('name', 'quantity')).all();
Retorno
( MongoProjections )
A factory de projeções.
replaceOptions
_mongo.replaceOptions() : com.mongodb.client.model.ReplaceOptions
Descrição
Cria opções para operações de substituição.
Retorno
( com.mongodb.client.model.ReplaceOptions )
As opções de substituição.
sorts
_mongo.sorts() : MongoSorts
Descrição
Cria uma factory para definir ordenações.
Como Usar
collection.find().sort(_mongo.sorts().ascending('name')).all();
Retorno
( MongoSorts )
A factory de ordenações.
textSearchOptions
_mongo.textSearchOptions() : com.mongodb.client.model.TextSearchOptions
Descrição
Cria opções para pesquisa de texto.
Retorno
( com.mongodb.client.model.TextSearchOptions )
As opções de pesquisa de texto.
updateOptions
_mongo.updateOptions() : com.mongodb.client.model.UpdateOptions
Descrição
Cria opções para operações de atualização.
Retorno
( com.mongodb.client.model.UpdateOptions )
As opções de atualização.
updates
_mongo.updates() : MongoUpdates
Descrição
Cria uma factory para definir alterações de dados.
Como Usar
collection.updateOne(filter, _mongo.updates().set('name', 'New Name'));
Retorno
( MongoUpdates )
A factory de atualizações.
valToDoc
_mongo.valToDoc(valores: Values) : org.bson.Document
Descrição
Converte um objeto Values para um documento BSON.
Como Usar
const doc = _mongo.valToDoc(values);
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| valores | Values | O objeto Values a ser convertido. |
Retorno
( org.bson.Document )
O documento BSON resultante.