MongoCollection
Permite interagir com as coleções do MongoDB.
aggregate
aggregate(pipeline: org.bson.conversions.Bson[]) : MongoAggregateIterable
Descrição
Agrega documentos de acordo com o pipeline de agregação especificado.
Como Usar
const docs = collection.aggregate(
_mongo.aggregates().match(
_mongo.filters().eq('status', 'Active')
),
_mongo.aggregates().group(
'$customerId',
_mongo.accumulators().sum('total', '$price')
),
_mongo.aggregates().project(
_mongo.projections().fields(
_mongo.projections().include('total'),
_mongo.projections().excludeId()
)
)
).all();
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| pipeline | org.bson.conversions.Bson[] | O pipeline de agregação. |
Retorno
Um iterável contendo o resultado da operação de agregação.
aggregate(pipeline: java.util.List<?>) : MongoAggregateIterable
Descrição
Agrega documentos de acordo com o pipeline de agregação especificado.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| pipeline | java.util.List | O pipeline de agregação. |
Retorno
Um iterável contendo o resultado da operação de agregação.
countDocuments
countDocuments() : long
Descrição
Conta o número de documentos na coleção.
Como Usar
collection.countDocuments();
Retorno
( long )
O número de documentos na coleção.
countDocuments(filtro: org.bson.conversions.Bson) : long
Descrição
Conta o número de documentos na coleção.
Como Usar
collection.countDocuments(_mongo.filters().eq('category', 'main'));
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | O filtro da consulta. |
Retorno
( long )
O número de documentos na coleção.
countDocuments(filtro: org.bson.conversions.Bson, opções: com.mongodb.client.model.CountOptions) : long
Descrição
Conta o número de documentos na coleção.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | O filtro da consulta. |
| opções | com.mongodb.client.model.CountOptions | As opções que descrevem a contagem. |
Retorno
( long )
O número de documentos na coleção.
createIndex
createIndex(atualizações: org.bson.conversions.Bson) : string
Descrição
Cria um índice com as chaves fornecidas.
Como Usar
collection.createIndex(_mongo.indexes().ascending('quantity', 'price'));
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| atualizações | org.bson.conversions.Bson | Um objeto que descreve a(s) chave(s) do índice, que não pode ser nulo. |
Retorno
( string )
O nome do índice.
deleteMany
deleteMany(filtro: org.bson.conversions.Bson) : void
Descrição
Exclui múltiplos documentos da coleção.
Como Usar
collection.deleteMany(_mongo.filters().eq('status', 'Inactive'));
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
Retorno
( void )
deleteMany(filtro: org.bson.conversions.Bson, opções: com.mongodb.client.model.DeleteOptions) : void
Descrição
Exclui múltiplos documentos da coleção com as opções especificadas.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| opções | com.mongodb.client.model.DeleteOptions | As opções a serem aplicadas à operação de exclusão. |
Retorno
( void )
deleteOne
deleteOne(filtro: org.bson.conversions.Bson) : void
Descrição
Exclui um único documento da coleção.
Como Usar
collection.deleteOne(_mongo.filters().eq('name', 'Product'));
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
Retorno
( void )
deleteOne(filtro: org.bson.conversions.Bson, opções: com.mongodb.client.model.DeleteOptions) : void
Descrição
Exclui um único documento da coleção com as opções especificadas.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| opções | com.mongodb.client.model.DeleteOptions | As opções a serem aplicadas à operação de exclusão. |
Retorno
( void )
drop
drop() : void
Descrição
Exclui esta coleção do banco de dados.
Retorno
( void )
drop(opções: com.mongodb.client.model.DropCollectionOptions) : void
Descrição
Exclui esta coleção do banco de dados.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| opções | com.mongodb.client.model.DropCollectionOptions | Várias opções para excluir a coleção. |
Retorno
( void )
estimatedDocumentCount
estimatedDocumentCount() : long
Descrição
Obtém uma estimativa da contagem de documentos em uma coleção utilizando os metadados da coleção.
Como Usar
collection.estimatedDocumentCount();
Retorno
( long )
O número de documentos na coleção.
estimatedDocumentCount(opções: com.mongodb.client.model.EstimatedDocumentCountOptions) : long
Descrição
Obtém uma estimativa da contagem de documentos em uma coleção utilizando os metadados da coleção.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| opções | com.mongodb.client.model.EstimatedDocumentCountOptions | As opções que descrevem a contagem. |
Retorno
( long )
O número de documentos na coleção.
find
find() : MongoFindIterable
Descrição
Localizar todos os documentos na coleção.
Retorno
A interface FindIterable.
find(filtro: org.bson.conversions.Bson) : MongoFindIterable
Descrição
Localizar todos os documentos na coleção.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | O filtro da consulta. |
Retorno
A interface FindIterable.
findOneAndDelete
findOneAndDelete(filtro: org.bson.conversions.Bson) : Values
Descrição
Encontra e exclui um documento de forma atômica.
Como Usar
const old = collection.findOneAndDelete(_mongo.filters().eq('name', 'Product'));
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
Retorno
( Values )
O documento encontrado, ou null se nenhum documento corresponder.
findOneAndDelete(filtro: org.bson.conversions.Bson, opções: com.mongodb.client.model.FindOneAndDeleteOptions) : Values
Descrição
Encontra e exclui um documento de forma atômica.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| opções | com.mongodb.client.model.FindOneAndDeleteOptions | As opções a serem aplicadas à operação de exclusão. |
Retorno
( Values )
O documento encontrado, ou null se nenhum documento corresponder.
findOneAndReplace
findOneAndReplace(filtro: org.bson.conversions.Bson, dados: Values) : Values
Descrição
Encontra e substitui um documento de forma atômica.
Como Usar
const old = collection.findOneAndReplace(
_mongo.filters().eq('name', 'Product'),
_val.map()
.set('quantity', 200)
.set('price', 12.99)
.set('category', 'food')
);
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| dados | Values | O documento de substituição, que não pode conter operadores de atualização. |
Retorno
( Values )
O documento encontrado, ou null se nenhum documento corresponder.
findOneAndReplace(filtro: org.bson.conversions.Bson, dados: Values, opções: com.mongodb.client.model.FindOneAndReplaceOptions) : Values
Descrição
Encontra e substitui um documento de forma atômica.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| dados | Values | O documento de substituição, que não pode conter operadores de atualização. |
| opções | com.mongodb.client.model.FindOneAndReplaceOptions | As opções a serem aplicadas à operação de substituição. |
Retorno
( Values )
O documento encontrado, ou null se nenhum documento corresponder.
findOneAndUpdate
findOneAndUpdate(filtro: org.bson.conversions.Bson, atualização: java.util.List<?>) : Values
Descrição
Encontra e atualiza um documento de forma atômica.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| atualização | java.util.List | Uma pipeline que descreve a atualização, que não pode ser nula. |
Retorno
( Values )
O documento que foi atualizado antes da aplicação da atualização. Se nenhum documento corresponder ao filtro da consulta, então null será retornado.
findOneAndUpdate(filtro: org.bson.conversions.Bson, atualização: java.util.List<?>, opções: com.mongodb.client.model.FindOneAndUpdateOptions) : Values
Descrição
Encontra e atualiza um documento de forma atômica.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| atualização | java.util.List | Uma pipeline que descreve a atualização, que não pode ser nula. |
| opções | com.mongodb.client.model.FindOneAndUpdateOptions | As opções a serem aplicadas à operação de atualização. |
Retorno
( Values )
O documento encontrado, ou null se nenhum documento corresponder.
findOneAndUpdate(filtro: org.bson.conversions.Bson, atualização: org.bson.conversions.Bson) : Values
Descrição
Encontra e atualiza um documento de forma atômica.
Como Usar
const setUpdate = _mongo.updates().set('quantity', 42);
const renameUpdate = _mongo.updates().rename('other', 'more');
const combinedUpdates = _mongo.updates().combine(setUpdate, renameUpdate);
collection.findOneAndUpdate(
_mongo.filters().eq('name', 'Abc'),
combinedUpdates
);
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| atualização | org.bson.conversions.Bson | Um documento que descreve a atualização, o qual não pode ser nulo. A atualização a ser aplicada deve incluir pelo menos um operador de atualização. |
Retorno
( Values )
O documento encontrado, ou null se nenhum documento corresponder.
findOneAndUpdate(filtro: org.bson.conversions.Bson, atualização: org.bson.conversions.Bson, opções: com.mongodb.client.model.FindOneAndUpdateOptions) : Values
Descrição
Encontra e atualiza um documento de forma atômica.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| atualização | org.bson.conversions.Bson | Um documento que descreve a atualização, o qual não pode ser nulo. A atualização a ser aplicada deve incluir pelo menos um operador de atualização. |
| opções | com.mongodb.client.model.FindOneAndUpdateOptions | As opções a serem aplicadas à operação de atualização. |
Retorno
( Values )
O documento encontrado, ou null se nenhum documento corresponder.
insertMany
insertMany(dados: Values) : java.util.List<string>
Descrição
Insere múltiplos documentos na coleção.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| dados | Values | Os dados dos documentos a serem inseridos. |
Retorno
( java.util.List )
A lista de IDs dos documentos inseridos.
insertMany(dados: Values, opções: com.mongodb.client.model.InsertManyOptions) : java.util.List<string>
Descrição
Insere múltiplos documentos na coleção com as opções especificadas.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| dados | Values | Os dados dos documentos a serem inseridos. |
| opções | com.mongodb.client.model.InsertManyOptions | As opções a serem aplicadas à operação de inserção. |
Retorno
( java.util.List )
A lista de IDs dos documentos inseridos.
insertOne
insertOne(dados: Values) : string
Descrição
Insere um único documento na coleção.
Como Usar
const id = collection.insertOne(
_val.map()
.set('name', 'Abc')
.set('quantity', 100)
.set('price', 9.99)
.set('category', 'main')
);
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| dados | Values | Os dados do documento a ser inserido. |
Retorno
( string )
O ID do documento inserido.
insertOne(dados: Values, opções: com.mongodb.client.model.InsertOneOptions) : string
Descrição
Insere um único documento na coleção com as opções especificadas.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| dados | Values | Os dados do documento a ser inserido. |
| opções | com.mongodb.client.model.InsertOneOptions | As opções a serem aplicadas à operação de inserção. |
Retorno
( string )
O ID do documento inserido.
renameCollection
renameCollection(nomeCompleto: string) : void
Descrição
Renomeia a coleção para o nome completo fornecido.
Como Usar
collection.renameCollection('database.newCollection');
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| nomeCompleto | string | O nome completo da nova coleção no formato 'database.collection'. |
Retorno
( void )
renameCollection(nomeBancoDados: string, nomeColecao: string) : void
Descrição
Renomeia a coleção para o banco de dados e nome da coleção fornecidos.
Como Usar
collection.renameCollection('database', 'newCollection');
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| nomeBancoDados | string | O nome do banco de dados. |
| nomeColecao | string | O novo nome da coleção. |
Retorno
( void )
replaceOne
replaceOne(filtro: org.bson.conversions.Bson, dados: Values) : long
Descrição
Substitui um único documento na coleção de acordo com o filtro especificado.
Como Usar
collection.replaceOne(
_mongo.filters().eq('name', 'Product'),
_val.map()
.set('quantity', 200)
.set('price', 12.99)
.set('category', 'food')
);
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| dados | Values | O documento de substituição, que não pode conter operadores de atualização. |
Retorno
( long )
O número de documentos modificados.
replaceOne(filtro: org.bson.conversions.Bson, dados: Values, opções: com.mongodb.client.model.ReplaceOptions) : long
Descrição
Substitui um único documento na coleção de acordo com o filtro especificado.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| dados | Values | O documento de substituição, que não pode conter operadores de atualização. |
| opções | com.mongodb.client.model.ReplaceOptions | As opções a serem aplicadas à operação de substituição. |
Retorno
( long )
O número de documentos modificados.
updateMany
updateMany(filtro: org.bson.conversions.Bson, update: java.util.List<?>) : long
Descrição
Atualiza múltiplos documentos na coleção de acordo com os argumentos especificados.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| update | java.util.List | Uma pipeline que descreve a atualização, que não pode ser nula. |
Retorno
( long )
O número de documentos modificados.
updateMany(filtro: org.bson.conversions.Bson, update: java.util.List<?>, opções: com.mongodb.client.model.UpdateOptions) : long
Descrição
Atualiza múltiplos documentos na coleção de acordo com os argumentos especificados.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| update | java.util.List | Uma pipeline que descreve a atualização, que não pode ser nula. |
| opções | com.mongodb.client.model.UpdateOptions | As opções a serem aplicadas à operação de atualização. |
Retorno
( long )
O número de documentos modificados.
updateMany(filtro: org.bson.conversions.Bson, update: org.bson.conversions.Bson) : long
Descrição
Atualiza múltiplos documentos na coleção de acordo com os argumentos especificados.
Como Usar
collection.updateMany(
_mongo.filters().eq('status', 'Active'),
_mongo.updates().set('status', 'Inactive')
);
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| update | org.bson.conversions.Bson | Um documento que descreve a atualização, o qual não pode ser nulo. A atualização a ser aplicada deve incluir pelo menos um operador de atualização. |
Retorno
( long )
O número de documentos modificados.
updateMany(filtro: org.bson.conversions.Bson, update: org.bson.conversions.Bson, opções: com.mongodb.client.model.UpdateOptions) : long
Descrição
Atualiza múltiplos documentos na coleção de acordo com os argumentos especificados.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| update | org.bson.conversions.Bson | Um documento que descreve a atualização, o qual não pode ser nulo. A atualização a ser aplicada deve incluir pelo menos um operador de atualização. |
| opções | com.mongodb.client.model.UpdateOptions | As opções a serem aplicadas à operação de atualização. |
Retorno
( long )
O número de documentos modificados.
updateOne
updateOne(filtro: org.bson.conversions.Bson, update: java.util.List<?>) : long
Descrição
Atualiza um único documento na coleção de acordo com os argumentos especificados.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| update | java.util.List | Uma pipeline que descreve a atualização, que não pode ser nula. |
Retorno
( long )
O resultado da operação de atualização de um único documento.
updateOne(filtro: org.bson.conversions.Bson, update: java.util.List<?>, opções: com.mongodb.client.model.UpdateOptions) : long
Descrição
Atualiza um único documento na coleção de acordo com os argumentos especificados.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| update | java.util.List | Uma pipeline que descreve a atualização, que não pode ser nula. |
| opções | com.mongodb.client.model.UpdateOptions | As opções a serem aplicadas à operação de atualização. |
Retorno
( long )
O resultado da operação de atualização de um único documento.
updateOne(filtro: org.bson.conversions.Bson, update: org.bson.conversions.Bson) : long
Descrição
Atualiza um único documento na coleção de acordo com os argumentos especificados.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| update | org.bson.conversions.Bson | Um documento que descreve a atualização, o qual não pode ser nulo. A atualização a ser aplicada deve incluir pelo menos um operador de atualização. |
Retorno
( long )
O resultado da operação de atualização de um único documento.
updateOne(filtro: org.bson.conversions.Bson, update: org.bson.conversions.Bson, opções: com.mongodb.client.model.UpdateOptions) : long
Descrição
Atualiza um único documento na coleção de acordo com os argumentos especificados.
Atributos
| NOME | TIPO | DESCRIÇÃO |
|---|---|---|
| filtro | org.bson.conversions.Bson | Um documento que descreve o filtro de consulta, o qual não pode ser nulo. |
| update | org.bson.conversions.Bson | Um documento que descreve a atualização, o qual não pode ser nulo. A atualização a ser aplicada deve incluir pelo menos um operador de atualização. |
| opções | com.mongodb.client.model.UpdateOptions | As opções a serem aplicadas à operação de atualização. |
Retorno
( long )
O resultado da operação de atualização de um único documento.