MongoCollection
extension MongoCollection
-
Abre um change stream do MongoDB em relação à collection para acompanhar as alterações. O stream resultante será notificado de todos os eventos nessa collection que o usuário ativo está autorizado a ver com base nas regras configuradas do MongoDB.
Declaração
Swift
public func watch(delegate: ChangeEventDelegate, queue: DispatchQueue = .main) -> ChangeStream
Parâmetros
delegate
O delegado que React a evento e erros do change stream resultante.
queue
Despacha eventos de streaming para uma fila opcional; se nenhuma fila for fornecida, a fila principal será usada
Valor de retorno
Um ChangeStream que managed o evento de streaming.
-
Abre um change stream do MongoDB em relação à collection para acompanhar as alterações. O documento BSON fornecido será usado como um filtro de expressão de correspondência nos eventos de alteração provenientes do fluxo.
Consulte https://mongodb.com/pt-br/docs/manual/reference/operator/aggregation / agregação/ para obter documentação sobre como definir um filtro de correspondência.
Definir a expressão de correspondência para filtrar ChangeEvents é semelhante a definir a expressão de correspondência para triggers: https://mongodb.com/pt-br/docs/realm / Realm/database-triggers/
Declaração
Swift
public func watch(matchFilter: Document, delegate: ChangeEventDelegate, queue: DispatchQueue = .main) -> ChangeStream
Parâmetros
matchFilter
O filtro $match para aplicar aos eventos de alteração recebidos
delegate
O delegado que React a evento e erros do change stream resultante.
queue
Despacha eventos de streaming para uma fila opcional; se nenhuma fila for fornecida, a fila principal será usada
Valor de retorno
Um ChangeStream que managed o evento de streaming.
-
Abre um MongoDB change stream em relação à collection para acompanhar as alterações feitas em documento específicos. Os documentos a serem observados devem ser explicitamente especificados por seu _id.
Declaração
Swift
public func watch(filterIds: [ObjectId], delegate: ChangeEventDelegate, queue: DispatchQueue = .main) -> ChangeStream
Parâmetros
filterIds
A lista de ID na collection a ser observada.
delegate
O delegado que React a evento e erros do change stream resultante.
queue
Despacha eventos de streaming para uma fila opcional; se nenhuma fila for fornecida, a fila principal será usada
Valor de retorno
Um ChangeStream que managed o evento de streaming.
-
Codifica o valor fornecido para BSON e o insere. Se o valor não tiver um identificador, um será gerado para ele.
Declaração
Swift
public func insertOne(_ document: Document, _ completion: @escaping MongoInsertBlock)
Parâmetros
document
documento Um valor
Document
para inserir.completion
O resultado da tentativa de realizar a inserção. Um ID será retornado para o objeto inserido em sucesso
-
Codifica os valores fornecidos para BSON e os insere. Se algum valor estiver sem identificadores, ele será gerado.
Declaração
Swift
public func insertMany(_ documents: [Document], _ completion: @escaping MongoInsertManyBlock)
Parâmetros
documents
Os valores
Document
em uma array BSON para inserir.completion
O resultado da inserção, retorna uma matriz de ID de documento inserido em ordem.
-
Localiza os documento nesta collection que correspondem ao filtro fornecido.
Declaração
Swift
public func find(filter: Document, options: FindOptions, _ completion: @escaping MongoFindBlock)
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.options
FindOptions
a ser usado ao executar o comando.completion
A array BSON resultante de documento ou erro, se ocorrer um
-
Localiza os documento nesta collection que correspondem ao filtro fornecido.
Declaração
Swift
public func find(filter: Document, _ completion: @escaping MongoFindBlock)
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.completion
A array BSON resultante de documento ou erro, se ocorrer um
-
Retorna um documento de uma collection ou exibição que corresponda ao filtro fornecido. Se vários documento satisfizerem a query, esse método retornará o primeiro documento de acordo com a ordem de classificação ou ordem de armazenamento da query.
Declaração
Swift
public func findOneDocument(filter: Document, options: FindOptions, _ completion: @escaping MongoFindOneBlock)
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.options
FindOptions
a ser usado ao executar o comando.completion
O BSON ou erro resultante, se ocorrer um
-
Retorna um documento de uma collection ou exibição que corresponda ao filtro fornecido. Se vários documento satisfizerem a query, esse método retornará o primeiro documento de acordo com a ordem de classificação ou ordem de armazenamento da query.
Declaração
Swift
public func findOneDocument(filter: Document, _ completion: @escaping MongoFindOneBlock)
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.completion
O BSON ou erro resultante, se ocorrer um
-
Executa um pipeline de estrutura de agregação em relação a esta collection.
Declaração
Swift
public func aggregate(pipeline: [Document], _ completion: @escaping MongoFindBlock)
Parâmetros
pipeline
Uma array BSON composta por
Documents
contendo o pipeline de operações de aggregation a serem executadas.completion
A array BSON resultante de documento ou erro, se ocorrer um
-
Conta o número de documentos nesta collection que correspondem ao filtro fornecido.
Declaração
Swift
public func count(filter: Document, limit: Int, _ completion: @escaping MongoCountBlock)
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.limit
A quantidade máxima de documentos para contar
completion
Retorna a contagem dos documentos que corresponderam ao filtro.
-
Conta o número de documentos nesta collection que correspondem ao filtro fornecido.
Declaração
Swift
public func count(filter: Document, _ completion: @escaping MongoCountBlock)
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.completion
Retorna a contagem dos documentos que corresponderam ao filtro.
-
Exclui um único documento correspondente da collection.
Declaração
Swift
public func deleteOneDocument(filter: Document, _ completion: @escaping MongoCountBlock)
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.completion
O resultado de realizar a exclusão. Retorna a contagem de objetos excluídos
-
Exclui vários documentos
Declaração
Swift
public func deleteManyDocuments(filter: Document, _ completion: @escaping MongoCountBlock)
Parâmetros
filter
documento que representa os critérios de correspondência
completion
O resultado de realizar a exclusão. Retorna a contagem da exclusão
-
Atualiza um único documento que corresponde ao filtro fornecido nesta collection.
Declaração
Swift
public func updateOneDocument(filter: Document, update: Document, upsert: Bool, _ completion: @escaping MongoUpdateBlock)
Parâmetros
filter
Um BSON
Document
representando os critérios de correspondência.update
Um bson
Document
representando a atualização a ser aplicada a um documento correspondente.upsert
Quando verdadeiro, cria um novo documento se nenhum documento corresponder à query.
completion
O resultado da tentativa de atualizar um documento.
-
Atualiza um único documento que corresponde ao filtro fornecido nesta collection.
Declaração
Swift
public func updateOneDocument(filter: Document, update: Document, _ completion: @escaping MongoUpdateBlock)
-
Atualiza vários documento que correspondem ao filtro fornecido nesta collection.
Declaração
Swift
public func updateManyDocuments(filter: Document, update: Document, upsert: Bool, _ completion: @escaping MongoUpdateBlock)
Parâmetros
filter
Um BSON
Document
representando os critérios de correspondência.update
Um bson
Document
representando a atualização a ser aplicada a um documento correspondente.upsert
Quando verdadeiro, cria um novo documento se nenhum documento corresponder à query.
completion
O resultado da tentativa de atualizar um documento.
-
Atualiza vários documento que correspondem ao filtro fornecido nesta collection.
Declaração
Swift
public func updateManyDocuments(filter: Document, update: Document, _ completion: @escaping MongoUpdateBlock)
-
Atualiza um único documento em uma collection com base em uma query e retorna o documento em seu formulário de pré-atualização ou pós-atualização. Ao contrário do
updateOneDocument
, esta ação permite encontrar, atualizar e retornar atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações de localização e atualização separadas.Declaração
Swift
public func findOneAndUpdate(filter: Document, update: Document, options: FindOneAndModifyOptions, _ completion: @escaping MongoFindOneBlock)
Parâmetros
filter
Um BSON
Document
representando os critérios de correspondência.update
Um bson
Document
representando a atualização a ser aplicada a um documento correspondente.options
RemoteFindOneAndModifyOptions
a ser usado ao executar o comando.completion
O resultado da tentativa de atualizar um documento.
-
Atualiza um único documento em uma collection com base em uma query e retorna o documento em seu formulário de pré-atualização ou pós-atualização. Ao contrário do
updateOneDocument
, esta ação permite encontrar, atualizar e retornar atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações de localização e atualização separadas.Declaração
Swift
public func findOneAndUpdate(filter: Document, update: Document, _ completion: @escaping MongoFindOneBlock)
-
Substitui um único documento em uma collection com base em um filtro de query e retorna o documento em seu formato pré-substituição ou pós-substituição. Ao contrário do
updateOneDocument
, esta ação permite localizar, substituir e retornar atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações de localização e atualização separadas.Declaração
Swift
public func findOneAndReplace(filter: Document, replacement: Document, options: FindOneAndModifyOptions, _ completion: @escaping MongoFindOneBlock)
Parâmetros
filter
Um
Document
que deve corresponder à query.replacement
Um
Document
descrevendo a substituição.options
FindOneAndModifyOptions
a ser usado ao executar o comando.completion
O resultado da tentativa de substituir um documento.
-
Substitui um único documento em uma collection com base em um filtro de query e retorna o documento em seu formato pré-substituição ou pós-substituição. Ao contrário do
updateOneDocument
, esta ação permite localizar, substituir e retornar atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações de localização e atualização separadas.Declaração
Swift
public func findOneAndReplace(filter: Document, replacement: Document, _ completion: @escaping MongoFindOneBlock)
-
Remove um único documento de uma collection com base em uma query e retorna um documento com o mesmo formulário que o documento imediatamente antes de ser excluído. Ao contrário de
deleteOneDocument
, essa ação permite localizar e excluir atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações separadas de localização e exclusão.Declaração
Swift
public func findOneAndDelete(filter: Document, options: FindOneAndModifyOptions, _ completion: @escaping MongoFindOneBlock)
Parâmetros
filter
Um
Document
que deve corresponder à query.options
FindOneAndModifyOptions
a ser usado ao executar o comando.completion
O resultado da tentativa de excluir um documento.
-
Remove um único documento de uma collection com base em uma query e retorna um documento com o mesmo formulário que o documento imediatamente antes de ser excluído. Ao contrário de
deleteOneDocument
, essa ação permite localizar e excluir atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações separadas de localização e exclusão.Declaração
Swift
public func findOneAndDelete(filter: Document, _ completion: @escaping MongoFindOneBlock)
Parâmetros
filter
Um
Document
que deve corresponder à query.completion
O resultado da tentativa de excluir um documento.
-
Cria um editor que emite um evento de alteração AnyBSON toda vez que a collection do MongoDB é alterada.
Declaração
Swift
public func watch() -> Publishers.WatchPublisher
Valor de retorno
Um editor que emite o evento de mudança AnyBSON toda vez que a coleção é alterada.
-
Cria um editor que emite um evento de alteração AnyBSON toda vez que a collection do MongoDB é alterada.
Declaração
Swift
public func watch(filterIds: [ObjectId]) -> Publishers.WatchPublisher
Parâmetros
filterIds
A lista de ID na collection a ser observada.
Valor de retorno
Um editor que emite o evento de mudança AnyBSON toda vez que a coleção é alterada.
-
Cria um editor que emite um evento de alteração AnyBSON toda vez que a collection do MongoDB é alterada.
Declaração
Swift
public func watch(matchFilter: Document) -> Publishers.WatchPublisher
Parâmetros
matchFilter
O filtro $match a ser aplicado aos eventos de alteração recebidos.
Valor de retorno
Um editor que emite o evento de mudança AnyBSON toda vez que a coleção é alterada.
-
Codifica o valor fornecido para BSON e o insere. Se o valor não tiver um identificador, um será gerado para ele. documento@param : um valor
Document
para inserir. @returns Um editor que eventualmente retorna o ID de objeto do documento inserido ouError
. -
Codifica os valores fornecidos para BSON e os insere. Se algum valor estiver sem identificador, ele será gerado. Documentos @param: Os valores de
Document
em uma array BSON para inserir. @returns Um editor que eventualmente retorna as IDs de objeto dos documentos inseridos ouError
. -
Encontra os documentos nesta coleção que correspondem ao filtro fornecido. Filtro @param: um
Document
como BSON que deve corresponder à query. Opções de @param:FindOptions
para usar ao executar o comando. @returns Um editor que eventualmente devolve[ObjectId]
documentos ouError
.Declaração
Swift
func find(filter: Document, options: FindOptions) -> Future<[Document], Error>
-
Encontra os documentos nesta coleção que correspondem ao filtro fornecido. Filtro @param: um
Document
como BSON que deve corresponder à query. @returns Um editor que eventualmente devolve[ObjectId]
documentos ouError
. -
Retorna um documento de uma coleção ou visualização que corresponde ao filtro fornecido. Se vários documentos satisfizerem a query, esse método retornará o primeiro documento de acordo com a ordem de classificação ou ordem natural da query. Filtro @param: um
Document
como BSON que deve corresponder à query. Opções de @param:FindOptions
para usar ao executar o comando. @returns Um editor que eventualmente retornaDocument
ouError
.Declaração
Swift
func findOneDocument(filter: Document, options: FindOptions) -> Future<Document?, Error>
-
Retorna um documento de uma coleção ou visualização que corresponde ao filtro fornecido. Se vários documentos satisfizerem a query, esse método retornará o primeiro documento de acordo com a ordem de classificação ou ordem natural da query. Filtro @param: um
Document
como BSON que deve corresponder à query. @returns Um editor que eventualmente retornaDocument
ounil
se o documento não for encontrado ouError
. -
Executa um pipeline de framework de agregação em relação a esta coleção. @param pipeline: uma array BSON composta por
Documents
contendo o pipeline de operações de agregação a serem executadas. @returns Um editor que eventualmente retornaDocument
ouError
. -
Conta o número de documentos nesta collection que correspondem ao filtro fornecido. Filtro @param: um
Document
como BSON que deve corresponder à query. @param limite: a quantidade máxima de documentos para contar @returns Um editor que eventualmente retornaInt
contagem de documentos ouError
.Declaração
Swift
func count(filter: Document, limit: Int) -> Future<Int, Error>
-
Conta o número de documentos nesta collection que correspondem ao filtro fornecido. Filtro @param: um
Document
como BSON que deve corresponder à query. @returns Um editor que eventualmente retornaInt
contagem de documentos ouError
.Declaração
Swift
func count(filter: Document) -> Future<Int, Error>
-
Exclui vários documentos Filtro @param: Documento que representa os critérios de correspondência @returns Um editor que eventualmente retorna
Int
contagem de documentos excluídos ouError
.Declaração
Swift
func deleteManyDocuments(filter: Document) -> Future<Int, Error>
-
Atualiza um único documento que corresponde ao filtro fornecido nesta coleção. Filtro @param: um BSON
Document
representando os critérios de correspondência. @param update: um BSONDocument
representando a atualização a ser aplicada a um documento correspondente. @param upsert: quando verdadeiro, cria um novo documento se nenhum documento corresponder à query. @returns Um editor que eventualmente retornaUpdateResult
ouError
.Declaração
Swift
func updateOneDocument(filter: Document, update: Document, upsert: Bool) -> Future<UpdateResult, Error>
-
Atualiza um único documento que corresponde ao filtro fornecido nesta coleção. Filtro @param: um BSON
Document
representando os critérios de correspondência. @param update: um BSONDocument
representando a atualização a ser aplicada a um documento correspondente. @returns Um editor que eventualmente retornaUpdateResult
ouError
.Declaração
Swift
func updateOneDocument(filter: Document, update: Document) -> Future<UpdateResult, Error>
-
Atualiza vários documentos que correspondem ao filtro fornecido nesta coleção. Filtro @param: um BSON
Document
representando os critérios de correspondência. @param update: um BSONDocument
representando a atualização a ser aplicada a um documento correspondente. @param upsert: quando verdadeiro, cria um novo documento se nenhum documento corresponder à query. @returns Um editor que eventualmente retornaUpdateResult
ouError
.Declaração
Swift
func updateManyDocuments(filter: Document, update: Document, upsert: Bool) -> Future<UpdateResult, Error>
-
Atualiza vários documentos que correspondem ao filtro fornecido nesta coleção. Filtro @param: um BSON
Document
representando os critérios de correspondência. @param update: um BSONDocument
representando a atualização a ser aplicada a um documento correspondente. @returns Um editor que eventualmente retornaUpdateResult
ouError
.Declaração
Swift
func updateManyDocuments(filter: Document, update: Document) -> Future<UpdateResult, Error>
-
Atualiza um único documento em uma coleção com base em um filtro de query e retorna o documento em seu formulário de pré-atualização ou pós-atualização. Ao contrário
updateOneDocument
, essa ação permite localizar, atualizar e retornar atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações separadas de localização e atualização. Filtro @param: um BSONDocument
representando os critérios de correspondência. @param update: um BSONDocument
representando a atualização a ser aplicada a um documento correspondente. Opções de @param:RemoteFindOneAndModifyOptions
para usar ao executar o comando. @returns Um editor que eventualmente retornaDocument
ounil
se o documento não for encontrado ouError
.Declaração
Swift
func findOneAndUpdate(filter: Document, update: Document, options: FindOneAndModifyOptions) -> Future<Document?, Error>
-
Atualiza um único documento em uma coleção com base em um filtro de query e retorna o documento em seu formulário de pré-atualização ou pós-atualização. Ao contrário
updateOneDocument
, essa ação permite localizar, atualizar e retornar atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações separadas de localização e atualização. Filtro @param: um BSONDocument
representando os critérios de correspondência. @param update: um BSONDocument
representando a atualização a ser aplicada a um documento correspondente. @returns Um editor que eventualmente retornaDocument
ounil
se o documento não for encontrado ouError
.Declaração
-
Substitui um único documento em uma collection com base em um filtro de query e retorna o documento em seu formato pré-substituição ou pós-substituição. Ao contrário
updateOneDocument
, essa ação permite localizar, substituir e retornar atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações separadas de localização e atualização. Filtro @param: umDocument
que deve corresponder à query. @param substituição: umDocument
descrevendo a substituição. Opções de @param:FindOneAndModifyOptions
para usar ao executar o comando. @returns Um editor que eventualmente retornaDocument
ounil
se o documento não for encontrado ouError
.Declaração
Swift
func findOneAndReplace(filter: Document, replacement: Document, options: FindOneAndModifyOptions) -> Future<Document?, Error>
-
Substitui um único documento em uma collection com base em um filtro de query e retorna o documento em seu formato pré-substituição ou pós-substituição. Ao contrário
updateOneDocument
, essa ação permite localizar, substituir e retornar atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações separadas de localização e atualização. Filtro @param: umDocument
que deve corresponder à query. @param substituição: umDocument
descrevendo a substituição. @returns Um editor que eventualmente retornaDocument
ounil
se o documento não for encontrado ouError
.Declaração
-
Remove um único documento de uma coleção com base em um filtro de query e retorna um documento com o mesmo formulário do documento imediatamente antes de ser excluído. Ao contrário
deleteOneDocument
, essa ação permite localizar e excluir atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações separadas de localização e exclusão. Filtro @param: umDocument
que deve corresponder à query. Opções de @param:FindOneAndModifyOptions
para usar ao executar o comando. @returns Um editor que eventualmente retornaDocument
ounil
se o documento não for encontrado ouError
.Declaração
Swift
func findOneAndDelete(filter: Document, options: FindOneAndModifyOptions) -> Future<Document?, Error>
-
Remove um único documento de uma coleção com base em um filtro de query e retorna um documento com o mesmo formulário do documento imediatamente antes de ser excluído. Ao contrário
deleteOneDocument
, essa ação permite localizar e excluir atomicamente um documento com o mesmo comando. Isso evita o risco de outras operações de atualização alterarem o documento entre operações separadas de localização e exclusão. Filtro @param: umDocument
que deve corresponder à query. @returns Um editor que eventualmente retornaDocument
ounil
se o documento não for encontrado ouError
.