Classe MongoDBCollection<T>

Readonly nome do banco de dados

Readonly nome do serviço

name

• obter nome(): string

• O nome da collection.

  Retorna a string

Agregação

• Agregação(gasoduto): Promessa<desconhecido>

• Executa um pipeline de estrutura de agregação em relação a esta collection.

  Parâmetros

  • pipeline: AggregatePipelineStage[]

    Uma array de estágios do aggregation pipeline.

  Retorna a Promessa<desconhecido>

  Uma promessa que se resolve no resultado da agregação.

contar

• contar(filtro, filtro?, opções?): Promessa<number>

• Conta o número de documentos nesta collection que correspondem ao filtro fornecido.

  Observação: ao chamar isso sem um filtro, você pode receber contagens de documentos imprecisas, pois ele retorna resultados com base nos metadados da coleção, o que pode resultar em uma contagem aproximada. Em particular:

  • Em um cluster fragmentado, a contagem resultante não filtrará corretamente os documentos órfãos.
  • Após um desligamento não limpo ou uma sincronização inicial baseada em cópia de arquivo, a contagem pode estar incorreta.

  Parâmetros

  • filtro: Filtro = {}</}

    Um filtro opcional aplicado para restringir os resultados.

  • options: CountOptions = {}</}

    Opções adicionais a serem aplicadas.

  Retorna a Promessa<número>

  Uma promessa que se resolve para o número de documentos correspondentes ao filtro.

excluirmuitos

• excluirmuitos(filtro, filtro?): Promessa<DeleteResult>

• Exclui vários documentos.

  Parâmetros

  • filtro: Filtro = {}</}

    Um filtro aplicado para restringir o resultado. Se omitido, o padrão é {} , que exclui todos os documentos da collection.

  Retorna a Promessa<DeleteResult>

  Uma promessa que se resolve em um objeto contendo o número de documentos excluídos (deletedCount).

excluirum

• excluirum(filtro, filtro?): Promessa<DeleteResult>

• Exclui um único documento correspondente da collection.

  Parâmetros

  • filtro: Filtro = {}</}

    Um filtro aplicado para restringir o resultado.

  Retorna a Promessa<DeleteResult>

  Uma promessa que se resolve em um objeto contendo o número de documentos excluídos (deletedCount).

find

• find(filtro, filtro?, opções?): Promessa<T[]>

• Localiza os documento que correspondem à query fornecida.

  Parâmetros

  • filtro: Filtro = {}</}

    Um filtro opcional aplicado para restringir os resultados.

  • opções: FindOptions = {}</}

    Opções adicionais a serem aplicadas.

  Retorna a Promessa<T[]>

  Uma promessa que se resolve nos documentos encontrados.

encontrarum

• encontrarum(filtro, filtro?, opções?): Promessa<nulo | T>

• Localiza um documento que corresponde ao filtro fornecido.

  Parâmetros

  • filtro: Filtro = {}</}

    Um filtro aplicado para restringir o resultado.

  • opções: FindOneOptions = {}</}

    Opções adicionais a serem aplicadas.

  Retorna Promessa<nulo | T>

  Uma promessa que se resolve no documento encontrado.

encontreumeexclua

• encontreumeexclua(filtro, filtro?, opções?): Promessa<nulo | T>

• Localiza um documento que corresponde ao filtro fornecido e o exclui

  Parâmetros

  • filtro: Filtro = {}</}

    Um filtro aplicado para restringir o resultado.

  • opções: FindOneOptions = {}</}

    Opções adicionais a serem aplicadas.

  Retorna Promessa<nulo | T>

  Uma promessa que se resolve no documento encontrado antes da exclusão.

encontreumesubstitua

• encontreumesubstitua(filtro, substituição, opções?): Promessa<nulo | T>

• Localiza um documento que corresponde ao filtro fornecido e o substitui por um novo documento.

  Parâmetros

  • filtro: Filtro

    Um filtro aplicado para restringir o resultado.

  • substituição: desconhecido

    O novo documento substituto.

  • opções: FindOneAndModifyOptions = {}</}

    Opções adicionais a serem aplicadas.

  Retorna Promessa<nulo | T>

  Uma promessa que resolve o documento encontrado encontrado antes da substituição.

encontreumeatualize

• encontreumeatualize(filtro, atualização, opções?): Promessa<nulo | T>

• Encontra um documento que corresponde à query fornecida e executa a atualização desejada em campos individuais.

  Parâmetros

  • filtro: Filtro

    Um filtro aplicado para restringir o resultado.

  • update: Atualização

    Os novos valores para o documento.

  • opções: FindOneAndModifyOptions = {}</}

    Opções adicionais a serem aplicadas.

  Retorna Promessa<nulo | T>

  Uma promessa que se resolve no documento encontrado antes de aplicar a atualização.

inserirmuitos

• inserirmuitos(documentos): Promessa<InsertManyResult<t["_id"]>>

• Insere uma array de documentos na collection. Se algum valor estiver sem identificadores, ele será gerado pelo servidor.

  Parâmetros

  • documentos: NewDocument<T>[]

    A matriz de documentos a inserir.

  Retorna Promessa<InsertManyResult<T["_id"]>>

  Uma promessa que se resolve em um objeto contendo uma array de ID inseridos (insertedIds).

insiraum

• insiraum(documento): Promessa<InsertOneResult<t["_id"]>>

• Insere um único documento na collection. Observação: se o documento não tiver um _id, um será gerado para ele pelo servidor.

  Parâmetros

  • document: NewDocument<T>

    O documento a inserir.

  Retorna a Promessa<InsertOneResult<T["_id"]>>

  Uma promessa que resolve um objeto que contém o ID de objeto inserido (insertedId).

atualizarmuitos

• atualizarmuitos(filtro, atualização, opções?): Promise<UpdateResult<T["_id"]>>

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

  Parâmetros

  • filtro: Filtro

    Um filtro aplicado para restringir o resultado.

  • update: Atualização

    Os novos valores para os documentos.

  • opções: UpdateOptions = {}</}

    Opções adicionais a serem aplicadas.

  Retorna Promessa<UpdateResult<T["_id"]>>

  Uma promessa que se resolve em um objeto contendo:

  {
   matchedCount: number;
   modifiedCount: number;
   upsertedId: IdType | undefined;
  }
  Copiar

atualizaçãoum

• atualizaçãoum(filtro, atualização, opções?): Promise<UpdateResult<T["_id"]>>

• Atualiza um único documento que corresponde ao filtro fornecido nesta collection.

  Parâmetros

  • filtro: Filtro

    Um filtro aplicado para restringir o resultado.

  • update: Atualização

    Os novos valores para o documento.

  • opções: UpdateOptions = {}</}

    Opções adicionais a serem aplicadas.

  Retorna Promessa<UpdateResult<T["_id"]>>

  Uma promessa que se resolve em um objeto contendo:

  {
   matchedCount: number;
   modifiedCount: number;
   upsertedId: IdType | undefined;
  }
  Copiar

assistir

• assistir(): AsyncGenerator<ChangeEvent<t>, any, desconhecido>

• Cria um change stream assíncrono para monitorar a collection em busca de alterações.

  Por padrão, produz todos os evento de alteração para esta collection. Você pode especificar no máximo uma das opções filter ou ids .

  Nota importante: para usar isso no React Native, você deve instalar:

  1. Polyfills para fetch e ReadableStream: https://www.npmjs.com/package/react-native-polyfill-globals
  2. Plugin Babel que habilita a sintaxe do gerador assíncrono: https://npmjs.com/package/@babel/plugin-proposal-async-generator-functions

  Retorna AsyncGenifier<ChangeEvent<T>, qualquer, desconhecido>

  Um gerador assíncrono de eventos de mudança.

  Veja

  https://mongodb.com/pt-br/docs/manual/reference/change-events/

• assistir(opções): AsyncGenerator<ChangeEvent<t>, any, desconhecido>

• Parâmetros

  • opções: {
        filtro?: indefinido;
        ID: T["_id"][];
    }

    • Optional filtro, filtro?: Indefinido

    • ids: t["_id"][]

  Retorna AsyncGenifier<ChangeEvent<T>, qualquer, desconhecido>

• assistir(opções): AsyncGenerator<ChangeEvent<t>, any, desconhecido>

• Parâmetros

  • opções: {
        filtro: Filtro;
        ID?: indefinido;
    }

    • filtro, filtro: Filtro

    • Optional ids?: Indefinido

  Retorna AsyncGenifier<ChangeEvent<T>, qualquer, desconhecido>