Pacote io.realm.mongodb.mongo

Class MongoCollection<DocumentT>

  • Parâmetros do tipo:
    DocumentT - O tipo para o qual essa collection codificará e decodificará documento.
    public class MongoCollection<DocumentT>
extends Object
    A interface MongoCollection oferece acesso de leitura e gravação aos documentos.

    Use MongoDatabase.getCollection(java.lang.String) para obter uma instância da collection.

    Antes que qualquer acesso seja possível, deve haver um usuário ativo e conectado.

    Veja também:
    MongoDatabase

    • Detalhes do método

      • getNamespace

        public MongoNamespace getNamespace()
        Obtém o namespace desta collection, ou seja, os nomes do reconhecimento de data center e da collection juntos.
        Retorna:
        o namespace

      • getName

        string pública getName()
        Obtém o nome desta coleção
        Retorna:
        O nome

      • getCodecRegistry

        public CodecRegistry getCodecRegistry()
        Obtém o registro de codec para o MongoCollection.
        Retorna:
        o CodecRegistry para esta collection

      • withDocumentClass

        public <NewDocumentT> MongoCollection<NewDocumentT> withDocumentClass​(Class<NewDocumentT> clazz)
        Cria uma nova instância do MongoCollection com uma classe padrão diferente na qual converter qualquer documento de reconhecimento de data center retornado.
        Parâmetros do tipo:
        NewDocumentT - O tipo para o qual a nova coleção codificará e decodificará documentos.
        Parâmetros:
        clazz - a classe padrão para a qual quaisquer documentos retornados do banco de dados serão convertidos.
        Retorna:
        uma nova instância do MongoCollection com a classe padrão diferente

      • withCodecRegistry

        public MongoCollection<DocumentT> withCodecRegistry​(CodecRegistry codecRegistry)
        Cria uma nova instância do MongoCollection com um registro de codec diferente.
        Parâmetros:
        codecRegistry - o novo CodecRegistry para a collection.
        Retorna:
        uma nova instância do MongoCollection com o registro de codec diferente

      • contar

        public RealmResultTask<Long> count()
        Conta o número de documentos na collection.
        Retorna:
        uma tarefa contendo o número de documento na collection

      • contar

        public RealmResultTask<Long> count​(Bson filter)
        Conta o número de documentos na collection de acordo com as opções fornecidas.
        Parâmetros:
        filter - o filtro de query
        Retorna:
        uma tarefa contendo o número de documento na collection

      • contar

        public RealmResultTask<Long> count​(Bson filter,
                                   CountOptions options)
        Conta o número de documentos na collection de acordo com as opções fornecidas.
        Parâmetros:
        filter - o filtro de query
        options - as opções que descrevem a contagem
        Retorna:
        uma tarefa contendo o número de documento na collection

      • findOne

        public RealmResultTask<DocumentT> findOne()
        Localiza um documento na collection.
        Retorna:
        uma tarefa contendo o resultado da operação find on

      • findOne

        public <ResultT> RealmResultTask<ResultT> findOne​(Class<ResultT> resultClass)
        Localiza um documento na collection.
        Parâmetros do tipo:
        ResultT - o tipo de documento de destino
        Parâmetros:
        resultClass - a classe para decodificar cada documento
        Retorna:
        uma tarefa contendo o resultado da operação find on

      • findOne

        public RealmResultTask<DocumentT> findOne​(Bson filter)
        Localiza um documento na collection.
        Parâmetros:
        filter - o filtro de query
        Retorna:
        uma tarefa contendo o resultado da operação find on

      • findOne

        public <ResultT> RealmResultTask<ResultT> findOne​(Bson filter,
                                                  Class<ResultT> resultClass)
        Localiza um documento na collection.
        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        resultClass - a classe para decodificar cada documento
        Retorna:
        uma tarefa contendo o resultado da operação find on

      • findOne

        public RealmResultTask<DocumentT> findOne​(Bson filter,
                                          FindOptions options)
        Localiza um documento na collection.
        Parâmetros:
        filter - o filtro de query
        options - uma estrutura FindOptions
        Retorna:
        uma tarefa contendo o resultado da operação find on

      • findOne

        public <ResultT> RealmResultTask<ResultT> findOne​(Bson filter,
                                                  FindOptions options,
                                                  Class<ResultT> resultClass)
        Localiza um documento na collection.
        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        options - uma estrutura FindOptions
        resultClass - a classe para decodificar cada documento
        Retorna:
        uma tarefa contendo o resultado da operação find on

      • find

        public FindIterable<DocumentT> find()
        Localiza todos os documentos na coleção.

        Todos os documentos serão entregues na forma de um FindIterable do qual elementos individuais poderão ser extraídos.

        Retorna:
        um iterável contendo o resultado da operação de localizar

      • find

        public FindIterable<DocumentT> find​(FindOptions options)
        Localiza todos os documentos na coleta usando FindOptions para construir a consulta.

        Todos os documentos serão entregues na forma de um FindIterable do qual elementos individuais poderão ser extraídos.

        Parâmetros:
        options - uma estrutura FindOptions para criar a query
        Retorna:
        um iterável contendo o resultado da operação de localizar

      • find

        public <ResultT> FindIterable<ResultT> find​(Class<ResultT> resultClass)
        Localiza todos os documento na collection especificando uma classe de saída.

        Todos os documentos serão entregues na forma de um FindIterable do qual elementos individuais poderão ser extraídos.

        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        resultClass - a classe para decodificar cada documento
        Retorna:
        um iterável contendo o resultado da operação de localizar

      • find

        public <ResultT> FindIterable<ResultT> find​(Class<ResultT> resultClass,
                                            FindOptions options)
        Encontra todos os documentos na collection especificando uma classe de saída e também usando FindOptions para construir a query.

        Todos os documentos serão entregues na forma de um FindIterable do qual elementos individuais poderão ser extraídos.

        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        resultClass - a classe para decodificar cada documento
        options - uma estrutura FindOptions para criar a query
        Retorna:
        um iterável contendo o resultado da operação de localizar

      • find

        public FindIterable<DocumentT> find​(Bson filter)
        Encontra todos os documentos na collection que correspondem ao filtro fornecido.

        Todos os documentos serão entregues na forma de um FindIterable do qual elementos individuais poderão ser extraídos.

        Parâmetros:
        filter - o filtro de query
        Retorna:
        um iterável contendo o resultado da operação de localizar

      • find

        public FindIterable<DocumentT> find​(Bson filter,
                                    FindOptions options)
        Localiza todos os documento na collection que correspondem ao filtro fornecido utilizando FindOptions para construir a query.

        Todos os documentos serão entregues na forma de um FindIterable do qual elementos individuais poderão ser extraídos.

        Parâmetros:
        filter - o filtro de query
        options - uma estrutura FindOptions
        Retorna:
        um iterável contendo o resultado da operação de localizar

      • find

        public <ResultT> FindIterable<ResultT> find​(Bson filter,
                                            Class<ResultT> resultClass)
        Localiza todos os documento na collection que correspondem ao filtro fornecido especificando uma classe de saída.

        Todos os documentos serão entregues na forma de um FindIterable do qual elementos individuais poderão ser extraídos.

        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        resultClass - a classe para decodificar cada documento
        Retorna:
        um iterável contendo o resultado da operação de localizar

      • find

        public <ResultT> FindIterable<ResultT> find​(Bson filter,
                                            Class<ResultT> resultClass,
                                            FindOptions options)
        Localiza todos os documento na collection que correspondem ao filtro fornecido especificando uma classe de saída e também usando FindOptions para construir a query.

        Todos os documentos serão entregues na forma de um FindIterable do qual elementos individuais poderão ser extraídos.

        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        resultClass - a classe para decodificar cada documento
        options - uma estrutura FindOptions
        Retorna:
        um iterável contendo o resultado da operação de localizar

      • Agregação

        public AggregateIterable<DocumentT> aggregate​(List<? extends Bson> pipeline)
        Agrega documentos de acordo com o aggregation pipeline especificado.

        Todos os documentos serão entregues na forma de um AggregateIterable de onde os elementos individuais poderão ser extraídos.

        Parâmetros:
        pipeline - o pipeline de agregação
        Retorna:
        um AggregateIterable do qual os resultados podem ser extraídos

      • Agregação

        public <ResultT> AggregateIterable<ResultT> aggregate​(List<? extends Bson> pipeline,
                                                      Class<ResultT> resultClass)
        Agrega documentos de acordo com o aggregation pipeline especificado, especificando uma classe de saída.

        Todos os documentos serão entregues na forma de um AggregateIterable de onde os elementos individuais poderão ser extraídos.

        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        pipeline - o pipeline de agregação
        resultClass - a classe para decodificar cada documento
        Retorna:
        um AggregateIterable do qual os resultados podem ser extraídos

      • insertOne

        public RealmResultTask<InsertOneResult> insertOne​(DocumentT document)
        Insere o documento fornecido. Se o documento não tiver um identificador, o cliente deverá gerar um.
        Parâmetros:
        document - o documento a inserir
        Retorna:
        uma tarefa contendo o resultado da operação de inserção de um

      • insertMany

        public RealmResultTask<InsertManyResult> insertMany​(List<? extends DocumentT> documents)
        Insere um ou mais documentos.
        Parâmetros:
        documents - os documentos a inserir
        Retorna:
        uma tarefa contendo o resultado da operação de inserção de muitos

      • Excluir um

        public RealmResultTask<DeleteResult> deleteOne​(Bson filter)
        Remove no máximo um documento da collection que corresponda ao filtro fornecido. Se nenhum documento corresponder, a collection não será modificada.
        Parâmetros:
        filter - o filtro de consulta para aplicar a operação de exclusão
        Retorna:
        uma tarefa contendo o resultado da remoção de uma operação

      • deleteMany

        public RealmResultTask<DeleteResult> deleteMany​(Bson filter)
        Remove todos os documentos da collection que correspondem ao filtro de query fornecido. Se nenhum documento corresponder, a coleção não será modificada.
        Parâmetros:
        filter - o filtro de consulta para aplicar a operação de exclusão
        Retorna:
        uma tarefa contendo o resultado da operação de remoção de muitos

      • updateOne

        public RealmResultTask<UpdateResult> updateOne​(Bson filter,
                                               Bson update)
        Atualize um único documento na collection de acordo com os argumentos especificados.
        Parâmetros:
        filter - um documento descrevendo o filtro de query, que não pode ser nulo.
        update - um documento descrevendo a atualização, que não pode ser nulo. A atualização a ser aplicada deve incluir apenas operadores de atualização.
        Retorna:
        uma tarefa contendo o resultado da operação de atualização de um

      • updateOne

        public RealmResultTask<UpdateResult> updateOne​(Bson filter,
                                               Bson update,
                                               UpdateOptions updateOptions)
        Atualize um único documento na collection de acordo com os argumentos especificados.
        Parâmetros:
        filter - um documento descrevendo o filtro de query, que não pode ser nulo.
        update - um documento descrevendo a atualização, que não pode ser nulo. A atualização a ser aplicada deve incluir apenas operadores de atualização.
        updateOptions - as opções a serem aplicadas à operação de atualização
        Retorna:
        uma tarefa contendo o resultado da operação de atualização de um

      • updateMany

        public RealmResultTask<UpdateResult> updateMany​(Bson filter,
                                                Bson update)
        Atualize todos os documentos na collection de acordo com os argumentos especificados.
        Parâmetros:
        filter - um documento descrevendo o filtro de query, que não pode ser nulo.
        update - um documento descrevendo a atualização, que não pode ser nulo. A atualização a ser aplicada deve incluir apenas operadores de atualização.
        Retorna:
        uma tarefa contendo o resultado da operação de atualização de muitos

      • updateMany

        public RealmResultTask<UpdateResult> updateMany​(Bson filter,
                                                Bson update,
                                                UpdateOptions updateOptions)
        Atualize todos os documentos na collection de acordo com os argumentos especificados.
        Parâmetros:
        filter - um documento descrevendo o filtro de query, que não pode ser nulo.
        update - um documento descrevendo a atualização, que não pode ser nulo. A atualização a ser aplicada deve incluir apenas operadores de atualização.
        updateOptions - as opções a serem aplicadas à operação de atualização
        Retorna:
        uma tarefa contendo o resultado da operação de atualização de muitos

      • findOneAndUpdate

        public RealmResultTask<DocumentT> findOneAndUpdate​(Bson filter,
                                                   Bson update)
        Encontra um documento na collection e executa a atualização fornecida.
        Parâmetros:
        filter - o filtro de query
        update - o documento de atualização
        Retorna:
        uma tarefa contendo o documento resultante

      • findOneAndUpdate

        public <ResultT> RealmResultTask<ResultT> findOneAndUpdate​(Bson filter,
                                                           Bson update,
                                                           Class<ResultT> resultClass)
        Encontra um documento na collection e executa a atualização fornecida.
        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        update - o documento de atualização
        resultClass - a classe para decodificar cada documento
        Retorna:
        uma tarefa contendo o documento resultante

      • findOneAndUpdate

        public <ResultT> RealmResultTask<ResultT> findOneAndUpdate​(Bson filter,
                                                           Bson update,
                                                           FindOneAndModifyOptions options,
                                                           Class<ResultT> resultClass)
        Encontra um documento na collection e executa a atualização fornecida.
        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        update - o documento de atualização
        options - uma estrutura FindOneAndModifyOptions
        resultClass - a classe para decodificar cada documento
        Retorna:
        uma tarefa contendo o documento resultante

      • encontrar um e substituir

        public RealmResultTask<DocumentT> findOneAndReplace​(Bson filter,
                                                    Bson replacement)
        Localiza um documento na collection e o substitui pelo documento fornecido.
        Parâmetros:
        filter - o filtro de query
        replacement - o documento pelo qual substituir o documento correspondente
        Retorna:
        uma tarefa contendo o documento resultante

      • encontrar um e substituir

        public <ResultT> RealmResultTask<ResultT> findOneAndReplace​(Bson filter,
                                                            Bson replacement,
                                                            Class<ResultT> resultClass)
        Localiza um documento na collection e o substitui pelo documento fornecido.
        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        replacement - o documento pelo qual substituir o documento correspondente
        resultClass - a classe para decodificar cada documento
        Retorna:
        uma tarefa contendo o documento resultante

      • encontrar um e substituir

        public RealmResultTask<DocumentT> findOneAndReplace​(Bson filter,
                                                    Bson replacement,
                                                    FindOneAndModifyOptions options)
        Localiza um documento na collection e o substitui pelo documento fornecido.
        Parâmetros:
        filter - o filtro de query
        replacement - o documento pelo qual substituir o documento correspondente
        options - uma estrutura FindOneAndModifyOptions
        Retorna:
        uma tarefa contendo o documento resultante

      • encontrar um e substituir

        public <ResultT> RealmResultTask<ResultT> findOneAndReplace​(Bson filter,
                                                            Bson replacement,
                                                            FindOneAndModifyOptions options,
                                                            Class<ResultT> resultClass)
        Localiza um documento na collection e o substitui pelo documento fornecido.
        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        replacement - o documento pelo qual substituir o documento correspondente
        options - uma estrutura FindOneAndModifyOptions
        resultClass - a classe para decodificar cada documento
        Retorna:
        uma tarefa contendo o documento resultante

      • encontrarOneAndDelete

        public RealmResultTask<DocumentT> findOneAndDelete​(Bson filter)
        Localiza um documento na coleção e o exclui.
        Parâmetros:
        filter - o filtro de query
        Retorna:
        uma tarefa contendo o documento resultante

      • encontrarOneAndDelete

        public <ResultT> RealmResultTask<ResultT> findOneAndDelete​(Bson filter,
                                                           Class<ResultT> resultClass)
        Localiza um documento na coleção e o exclui.
        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        resultClass - a classe para decodificar cada documento
        Retorna:
        uma tarefa contendo o documento resultante

      • encontrarOneAndDelete

        public <ResultT> RealmResultTask<ResultT> findOneAndDelete​(Bson filter,
                                                           FindOneAndModifyOptions options,
                                                           Class<ResultT> resultClass)
        Localiza um documento na coleção e o exclui.
        Parâmetros do tipo:
        ResultT - o tipo de documento de destino do iterável.
        Parâmetros:
        filter - o filtro de query
        options - uma estrutura FindOneAndModifyOptions
        resultClass - a classe para decodificar cada documento
        Retorna:
        uma tarefa contendo o documento resultante

      • assistir

        public RealmEventStreamTask<DocumentT> watch()
        Assista a uma collection. O stream resultante será notificado de todos os eventos nessa collection que o usuário ativo está autorizado a ver com base nas regras do MongoDB Realm configuradas.
        Retorna:
        uma tarefa que fornece acesso ao fluxo de eventos de alteração.

      • assistir

        public RealmEventStreamTask<DocumentT> watch​(BsonValue... ids)
        Observa ID especificados em uma collection.
        Parâmetros:
        ids - os ids para assistir.
        Retorna:
        uma tarefa que fornece acesso ao fluxo de eventos de alteração.

      • assistir

        public RealmEventStreamTask<DocumentT> watch​(ObjectId... ids)
        Observa IDs especificados em uma collection. Essa sobrecarga de conveniência oferece suporte ao caso de uso de instâncias nãoBsonValue de ObjectId , agrupando-as em instâncias BsonObjectId para o usuário.
        Parâmetros:
        ids - identificadores de objeto exclusivos dos ID a serem observados.
        Retorna:
        uma tarefa que fornece acesso ao fluxo de eventos de alteração.

      • watchAsync

        public RealmEventStreamAsyncTask<DocumentT> watchAsync()
        Observa uma collection de forma assíncrona. O stream resultante será notificado de todos os eventos nessa collection que o usuário ativo está autorizado a ver com base nas regras do MongoDB Realm configuradas.
        Retorna:
        uma tarefa que fornece acesso ao fluxo de eventos de alteração.

      • watchAsync

        public RealmEventStreamAsyncTask<DocumentT> watchAsync​(BsonValue... ids)
        Observa ID especificados em uma collection de forma assíncrona.
        Parâmetros:
        ids - os ids para assistir.
        Retorna:
        uma tarefa que fornece acesso ao fluxo de eventos de alteração.

      • watchAsync

        public RealmEventStreamAsyncTask<DocumentT> watchAsync​(ObjectId... ids)
        Observa ID especificados em uma collection de forma assíncrona. Essa sobrecarga de conveniência oferece suporte ao caso de uso de instâncias nãoBsonValue de ObjectId , agrupando-as em instâncias BsonObjectId para o usuário.
        Parâmetros:
        ids - identificadores de objeto exclusivos dos ID a serem observados.
        Retorna:
        uma tarefa que fornece acesso ao fluxo de eventos de alteração.