RLMMongoCollection

Objective-C


@interface RLMMongoCollection : NSObject

Swift

@_nonSendable(_assumed) class RLMMongoCollection : NSObject, @unchecked Sendable

O RLMMongoCollection representa uma collection MongoDB.

Você pode obter uma instância de um RLMMongoDatabase.

Os métodos de criar, ler, atualizar e excluir estão disponíveis.

As operações no servidor Realm cloud são realizadas de forma assíncrona.

Observação

Antes de ler ou gravar dados, o usuário deve fazer login.
  • Uso: RLMMongoClient *client = [auto.app mongoClient:@"MongoDB1"]; RLMMongoDatabase *banco de dados = [banco de dados do clienteWithName:@"test_data"]; RLMMongoCollection *coleção = [database collectionWithName:@"Dog"]; [collection insertOneDocument:@{@"name": @"fido", @"breed": @"cane corso"} conclusão:...];

  • O nome desta collection do MongoDB .

    Declaração

    Objective-C

    @property (nonatomic, readonly) NSString *_Nonnull name;

    Swift

    var name: String { get }
  • Codifica o valor fornecido para BSON e o insere. Se o valor não tiver um identificador, um será gerado para ele.

    Declaração

    Objective-C

    - (void)insertOneDocument:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)document
                   completion:(nonnull RLMMongoInsertBlock)completion;

    Parâmetros

    document

    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

    Objective-C

    - (void)insertManyDocuments:
                (nonnull NSArray<NSDictionary<NSString *, id<RLMBSON>> *> *)
                    documents
                     completion:(nonnull RLMMongoInsertManyBlock)completion;

    Parâmetros

    documents

    Os valores Document em uma array BSON para inserir.

    completion

    O resultado da inserção, retorna uma matriz de IDs de documento inseridos em ordem

  • Localiza os documento nesta collection que correspondem ao filtro fornecido.

    Declaração

    Objective-C

    - (void)findWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
              options:(nonnull RLMFindOptions *)options
           completion:(nonnull RLMMongoFindBlock)completion;

    Parâmetros

    filterDocument

    Um Document como BSON que deve corresponder à query.

    options

    RLMFindOptions 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

    Objective-C

    - (void)findWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
           completion:(nonnull RLMMongoFindBlock)completion;

    Parâmetros

    filterDocument

    Um Document como BSON que deve corresponder à query.

    completion

    A array BSON resultante como uma string 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

    Objective-C

    - (void)findOneDocumentWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                         options:(nonnull RLMFindOptions *)options
                      completion:(nonnull RLMMongoFindOneBlock)completion;

    Parâmetros

    filterDocument

    Um Document como BSON que deve corresponder à query.

    options

    RLMFindOptions 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

    Objective-C

    - (void)findOneDocumentWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                      completion:(nonnull RLMMongoFindOneBlock)completion;

    Parâmetros

    filterDocument

    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

    Objective-C

    - (void)aggregateWithPipeline:
                (nonnull NSArray<NSDictionary<NSString *, id<RLMBSON>> *> *)pipeline
                       completion:(nonnull RLMMongoFindBlock)completion;

    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

    Objective-C

    - (void)countWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                 limit:(NSInteger)limit
            completion:(nonnull RLMMongoCountBlock)completion;

    Parâmetros

    filterDocument

    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

    Objective-C

    - (void)countWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
            completion:(nonnull RLMMongoCountBlock)completion;

    Parâmetros

    filterDocument

    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

    Objective-C

    - (void)deleteOneDocumentWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                        completion:(nonnull RLMMongoCountBlock)completion;

    Parâmetros

    filterDocument

    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

    Objective-C

    - (void)deleteManyDocumentsWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                          completion:(nonnull RLMMongoCountBlock)completion;

    Parâmetros

    filterDocument

    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

    Objective-C

    - (void)updateOneDocumentWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                    updateDocument:(nonnull NSDictionary<NSString *, id<RLMBSON>> *)
                                       updateDocument
                            upsert:(BOOL)upsert
                        completion:(nonnull RLMMongoUpdateBlock)completion;

    Parâmetros

    filterDocument

    Um BSON Document representando os critérios de correspondência.

    updateDocument

    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

    Objective-C

    - (void)updateOneDocumentWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                    updateDocument:(nonnull NSDictionary<NSString *, id<RLMBSON>> *)
                                       updateDocument
                        completion:(nonnull RLMMongoUpdateBlock)completion;

    Parâmetros

    filterDocument

    Um BSON Document representando os critérios de correspondência.

    updateDocument

    Um bson Document representando a atualização a ser aplicada a um documento correspondente.

    completion

    O resultado da tentativa de atualizar um documento.

  • Atualiza vários documento que correspondem ao filtro fornecido nesta collection.

    Declaração

    Objective-C

    - (void)updateManyDocumentsWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                      updateDocument:
                          (nonnull NSDictionary<NSString *, id<RLMBSON>> *)
                              updateDocument
                              upsert:(BOOL)upsert
                          completion:(nonnull RLMMongoUpdateBlock)completion;

    Parâmetros

    filterDocument

    Um BSON Document representando os critérios de correspondência.

    updateDocument

    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

    Objective-C

    - (void)updateManyDocumentsWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                      updateDocument:
                          (nonnull NSDictionary<NSString *, id<RLMBSON>> *)
                              updateDocument
                          completion:(nonnull RLMMongoUpdateBlock)completion;

    Parâmetros

    filterDocument

    Um BSON Document representando os critérios de correspondência.

    updateDocument

    Um bson Document representando a atualização a ser aplicada a um documento correspondente.

    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

    Objective-C

    - (void)findOneAndUpdateWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                   updateDocument:(nonnull NSDictionary<NSString *, id<RLMBSON>> *)
                                      updateDocument
                          options:(nonnull RLMFindOneAndModifyOptions *)options
                       completion:(nonnull RLMMongoFindOneBlock)completion;

    Parâmetros

    filterDocument

    Um BSON Document representando os critérios de correspondência.

    updateDocument

    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

    Objective-C

    - (void)findOneAndUpdateWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                   updateDocument:(nonnull NSDictionary<NSString *, id<RLMBSON>> *)
                                      updateDocument
                       completion:(nonnull RLMMongoFindOneBlock)completion;

    Parâmetros

    filterDocument

    Um BSON Document representando os critérios de correspondência.

    updateDocument

    Um bson Document representando a atualização a ser aplicada a um documento correspondente.

    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

    Objective-C

    - (void)findOneAndReplaceWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
               replacementDocument:(nonnull NSDictionary<NSString *, id<RLMBSON>> *)
                                       replacementDocument
                           options:(nonnull RLMFindOneAndModifyOptions *)options
                        completion:(nonnull RLMMongoFindOneBlock)completion;

    Parâmetros

    filterDocument

    Um Document que deve corresponder à query.

    replacementDocument

    Um Document descrevendo a substituição.

    options

    RLMFindOneAndModifyOptions 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

    Objective-C

    - (void)findOneAndReplaceWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
               replacementDocument:(nonnull NSDictionary<NSString *, id<RLMBSON>> *)
                                       replacementDocument
                        completion:(nonnull RLMMongoFindOneBlock)completion;

    Parâmetros

    filterDocument

    Um Document que deve corresponder à query.

    replacementDocument

    Um Document descrevendo a atualização.

    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

    Objective-C

    - (void)findOneAndDeleteWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                          options:(nonnull RLMFindOneAndModifyOptions *)options
                       completion:(nonnull RLMMongoDeleteBlock)completion;

    Parâmetros

    filterDocument

    Um Document que deve corresponder à query.

    options

    RLMFindOneAndModifyOptions 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

    Objective-C

    - (void)findOneAndDeleteWhere:
                (nonnull NSDictionary<NSString *, id<RLMBSON>> *)filterDocument
                       completion:(nonnull RLMMongoDeleteBlock)completion;

    Parâmetros

    filterDocument

    Um Document que deve corresponder à query.

    completion

    O resultado da tentativa de excluir um documento.

  • 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

    Objective-C

    - (nonnull RLMChangeStream *)watchWithDelegate:
                                     (nonnull id<RLMChangeEventDelegate>)delegate
                                     delegateQueue:(nullable dispatch_queue_t)queue;

    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

  • 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

    Objective-C

    - (nonnull RLMChangeStream *)
        watchWithFilterIds:(nonnull NSArray<RLMObjectId *> *)filterIds
                  delegate:(nonnull id<RLMChangeEventDelegate>)delegate
             delegateQueue:(nullable dispatch_queue_t)queue;

    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

  • 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

    Objective-C

    - (nonnull RLMChangeStream *)
        watchWithMatchFilter:
            (nonnull NSDictionary<NSString *, id<RLMBSON>> *)matchFilter
                    delegate:(nonnull id<RLMChangeEventDelegate>)delegate
               delegateQueue:(nullable dispatch_queue_t)queue;

    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