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
@preconcurrency 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
@preconcurrency 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
@preconcurrency public func find(filter: Document, options: FindOptions = 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
-
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
@preconcurrency public func findOneDocument(filter: Document, options: FindOptions = 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
-
Executa um pipeline de estrutura de agregação em relação a esta collection.
Declaração
Swift
@preconcurrency 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
@preconcurrency public func count(filter: Document, limit: Int? = nil, _ 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.
-
Exclui um único documento correspondente da collection.
Declaração
Swift
@preconcurrency 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
@preconcurrency 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
@preconcurrency public func updateOneDocument(filter: Document, update: Document, upsert: Bool = false, _ 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
@preconcurrency public func updateManyDocuments(filter: Document, update: Document, upsert: Bool = false, _ 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 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
@preconcurrency public func findOneAndUpdate(filter: Document, update: Document, options: FindOneAndModifyOptions = .init(), _ 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.
-
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
@preconcurrency public func findOneAndReplace(filter: Document, replacement: Document, options: FindOneAndModifyOptions = .init(), _ 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.
-
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
@preconcurrency public func findOneAndDelete(filter: Document, options: FindOneAndModifyOptions = .init(), _ 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.
-
insertOne(_:
Assíncrono) Codifica o valor fornecido para BSON e o insere. Se o valor não tiver um identificador, um será gerado para ele.
Parâmetros
document
Um valor
Document
para inserir.Valor de retorno
A ID do objeto do documento inserido.
-
insertMany(_:
Assíncrono) Codifica os valores fornecidos para BSON e os insere. Se algum valor estiver sem identificadores, ele será gerado.
Parâmetros
documents
Os valores
Document
em uma array BSON para inserir.Valor de retorno
As ID de objeto do documento inseridos.
-
Localiza os documento nesta collection que correspondem ao filtro fornecido.
-
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.
-
find(filter:
Assíncronooptions: _isolation: ) Localiza os documento nesta collection que correspondem ao filtro fornecido.
Declaração
Swift
public func find(filter: Document, options: FindOptions = .init(), _isolation: isolated (any Actor)? = #isolation) async throws -> [Document]
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.options
FindOptions
a ser usado ao executar o comando.Valor de retorno
Array de
Document
filtrada. -
findOneDocument(filter:
Assíncronooptions: _isolation: ) 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 = .init(), _isolation: isolated (any Actor)? = #isolation) async throws -> Document?
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.options
FindOptions
a ser usado ao executar o comando.Valor de retorno
Document
filtrado. -
aggregate(pipeline:
Assíncrono) Executa um pipeline de estrutura de agregação em relação a esta collection.
Parâmetros
pipeline
Uma array BSON composta por
Documents
contendo o pipeline de operações de aggregation a serem executadas.Valor de retorno
Uma array de
Document
resultado da operação de aggregation. -
count(filter:
Assíncronolimit: ) Conta o número de documentos nesta collection que correspondem ao filtro fornecido.
Declaração
Swift
public func count(filter: Document, limit: Int? = nil) async throws -> Int
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.limit
A quantidade máxima de documentos para contar
Valor de retorno
Contagem dos documentos que corresponderam ao filtro.
-
deleteOneDocument(filter:
Assíncrono) -
deleteManyDocuments(filter:
Assíncrono) Exclui vários documentos
Declaração
Swift
public func deleteManyDocuments(filter: Document) async throws -> Int
Parâmetros
filter
documento que representa os critérios de correspondência
Valor de retorno
Int
Contagem de documentos excluídos. -
updateOneDocument(filter:
Assíncronoupdate: upsert: ) Atualiza um único documento que corresponde ao filtro fornecido nesta collection.
Declaração
Swift
public func updateOneDocument(filter: Document, update: Document, upsert: Bool? = nil) async throws -> UpdateResult
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.
Valor de retorno
UpdateResult
resultado da operaçãoupdateOne
. -
updateManyDocuments(filter:
Assíncronoupdate: upsert: ) Atualiza vários documento que correspondem ao filtro fornecido nesta collection.
Declaração
Swift
public func updateManyDocuments(filter: Document, update: Document, upsert: Bool? = nil) async throws -> UpdateResult
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.
Valor de retorno
UpdateResult
resultado da operaçãoupdateMany
. -
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. -
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. -
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. -
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 = .init(), _isolation: isolated (any Actor)? = #isolation) async throws -> Document?
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.Valor de retorno
Document
resultado da tentativa de atualizar um documento ounil
se o documento não foi encontrado. -
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 = .init(), _isolation: isolated (any Actor)? = #isolation) async throws -> Document?
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.Valor de retorno
Document
resultado da tentativa de reagrupar um documento ounil
se o documento não foi encontrado. -
findOneAndDelete(filter:
Assíncronooptions: _isolation: ) 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 = .init(), _isolation: isolated (any Actor)? = #isolation) async throws -> Document?
Parâmetros
filter
Um
Document
que deve corresponder à query.options
FindOneAndModifyOptions
a ser usado ao executar o comando.Valor de retorno
Document
resultado da tentativa de excluir um documento ounil
se o documento não foi encontrado. -
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.
-
Uma sequência assíncrona de valores AnyBSON contendo informações sobre cada alteração na MongoDB collection
Declaração
Swift
public var changeEvents: AsyncThrowingPublisher<Publishers.WatchPublisher> { get }
-
Uma sequência assíncrona de valores AnyBSON contendo informações sobre cada alteração na MongoDB collection
Declaração
Swift
public func changeEvents(onOpen: @Sendable @escaping () -> Void) -> AsyncThrowingPublisher<Publishers.WatchPublisher>
Parâmetros
onOpen
Uma chamada de resposta que é invocada quando o fluxo de observação é inicializado no servidor. As alterações no servidor acionadas antes dessa chamada de resposta podem não produzir eventos de alteração.
-
Uma sequência assíncrona de valores AnyBSON contendo informações sobre cada alteração em objeto com ID contidos em
filterIds
dentro da collection MongoDB.Declaração
Swift
public func changeEvents(filterIds: [ObjectId], onOpen: (@Sendable () -> Void)? = nil) -> AsyncThrowingPublisher<Publishers.WatchPublisher>
Parâmetros
filterIds
ID de documento que devem produzir evento de mudança
onOpen
Uma chamada de resposta opcional que é invocada quando o fluxo de observação é inicializado no servidor. As alterações no servidor acionadas antes dessa chamada de resposta podem não produzir eventos de alteração.
-
Uma sequência assíncrona de valores AnyBSON contendo informações sobre cada alteração em objeto dentro da collection MongoDB que correspondem ao filtro $match fornecido.
Declaração
Swift
public func changeEvents(matchFilter: Document, onOpen: (@Sendable () -> Void)? = nil) -> AsyncThrowingPublisher<Publishers.WatchPublisher>
Parâmetros
matchFilter
filtro $match para filtrar os documentos que produzem eventos de alteração.
onOpen
Uma chamada de resposta opcional que é invocada quando o fluxo de observação é inicializado no servidor. As alterações no servidor acionadas antes dessa chamada de resposta podem não produzir eventos de alteração.
-
Codifica o valor fornecido para BSON e o insere. Se o valor não tiver um identificador, um será gerado para ele.
Parâmetros
document
Um valor
Document
para inserir.Valor de retorno
Um editor que eventualmente retornará o ID de objeto do documento inserido ou
Error
. -
Codifica os valores fornecidos para BSON e os insere. Se algum valor estiver sem identificadores, ele será gerado.
Parâmetros
documents
Os valores
Document
em uma array BSON para inserir.Valor de retorno
Um editor que eventualmente retorna as ID de objeto de documento inseridos ou
Error
. -
Localiza os documento nesta collection que correspondem ao filtro fornecido.
Declaração
Swift
func find(filter: Document, options: FindOptions) -> Future<[Document], Error>
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.options
FindOptions
a ser usado ao executar o comando.Valor de retorno
Um editor que eventualmente retornará
[ObjectId]
documentos ouError
. -
Localiza os documento nesta collection que correspondem ao filtro fornecido.
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.Valor de retorno
Um editor que eventualmente retornará
[ObjectId]
documentos ouError
. -
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
func findOneDocument(filter: Document, options: FindOptions) -> Future<Document?, Error>
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.options
FindOptions
a ser usado ao executar o comando.Valor de retorno
Um editor que eventualmente retornará
Document
ouError
. -
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.
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.Valor de retorno
Um editor que eventualmente retornará
Document
ounil
se o documento não for encontrado ouError
. -
Executa um pipeline de estrutura de agregação em relação a esta collection.
Parâmetros
pipeline
Uma array BSON composta por
Documents
contendo o pipeline de operações de aggregation a serem executadas.Valor de retorno
Um editor que eventualmente retornará
Document
ouError
. -
Conta o número de documentos nesta collection que correspondem ao filtro fornecido.
Declaração
Swift
func count(filter: Document, limit: Int) -> Future<Int, Error>
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.limit
A quantidade máxima de documentos para contar
Valor de retorno
Um editor que eventualmente retornará
Int
contagem de documentos ouError
. -
Conta o número de documentos nesta collection que correspondem ao filtro fornecido.
Declaração
Swift
func count(filter: Document) -> Future<Int, Error>
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.Valor de retorno
Um editor que eventualmente retornará
Int
contagem de documentos ouError
. -
Exclui um único documento correspondente da collection.
Declaração
Swift
func deleteOneDocument(filter: Document) -> Future<Int, Error>
Parâmetros
filter
Um
Document
como BSON que deve corresponder à query.Valor de retorno
Um editor que eventualmente retorna
Int
contagem de documentos excluídos ouError
. -
Exclui vários documentos
Declaração
Swift
func deleteManyDocuments(filter: Document) -> Future<Int, Error>
Parâmetros
filter
documento que representa os critérios de correspondência
Valor de retorno
Um editor que eventualmente retorna
Int
contagem de documentos excluídos ouError
. -
Atualiza um único documento que corresponde ao filtro fornecido nesta collection.
Declaração
Swift
func updateOneDocument(filter: Document, update: Document, upsert: Bool) -> Future<UpdateResult, Error>
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.
Valor de retorno
Um editor que eventualmente retornará
UpdateResult
ouError
. -
Atualiza um único documento que corresponde ao filtro fornecido nesta collection.
Declaração
Swift
func updateOneDocument(filter: Document, update: Document) -> Future<UpdateResult, Error>
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.Valor de retorno
Um editor que eventualmente retornará
UpdateResult
ouError
. -
Atualiza vários documento que correspondem ao filtro fornecido nesta collection.
Declaração
Swift
func updateManyDocuments(filter: Document, update: Document, upsert: Bool) -> Future<UpdateResult, Error>
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.
Valor de retorno
Um editor que eventualmente retornará
UpdateResult
ouError
. -
Atualiza vários documento que correspondem ao filtro fornecido nesta collection.
Declaração
Swift
func updateManyDocuments(filter: Document, update: Document) -> Future<UpdateResult, Error>
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.Valor de retorno
Um editor que eventualmente retornará
UpdateResult
ouError
. -
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
func findOneAndUpdate(filter: Document, update: Document, options: FindOneAndModifyOptions) -> Future<Document?, Error>
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.Valor de retorno
Um editor que eventualmente retornará
Document
ounil
se o documento não for encontrado ouError
. -
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
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.Valor de retorno
Um editor que eventualmente retornará
Document
ounil
se o documento não for encontrado ouError
. -
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
func findOneAndReplace(filter: Document, replacement: Document, options: FindOneAndModifyOptions) -> Future<Document?, Error>
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.Valor de retorno
Um editor que eventualmente retornará
Document
ounil
se o documento não for encontrado ouError
. -
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
Parâmetros
filter
Um
Document
que deve corresponder à query.replacement
Um
Document
descrevendo a substituição.Valor de retorno
Um editor que eventualmente retornará
Document
ounil
se o documento não for encontrado ouError
. -
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
func findOneAndDelete(filter: Document, options: FindOneAndModifyOptions) -> Future<Document?, Error>
Parâmetros
filter
Um
Document
que deve corresponder à query.options
FindOneAndModifyOptions
a ser usado ao executar o comando.Valor de retorno
Um editor que eventualmente retornará
Document
ounil
se o documento não for encontrado ouError
. -
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.Parâmetros
filter
Um
Document
que deve corresponder à query.Valor de retorno
Um editor que eventualmente retornará
Document
ounil
se o documento não for encontrado ouError
.