Realm JavaScript

Realm.MongoDBCollection

Uma collection remota de documento em um reconhecimento de data center MongoDB.

Membros

name

Obtém o nome da collection.

Métodos

Agregação(pipeline)Promise<[object>, ...]

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

Parâmetros:
  • gasoduto
    • Tipo: [object, ...]

    • Uma array de estágios do aggregation pipeline.

Retorna: Promise<[object>, ...] O resultado.
contar(filtro, opções)Promise<number>

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

Parâmetros:
  • filtro, filtro opcional
    • Tipo: object

    • Um filtro opcional aplicado para restringir os resultados.

  • opções opcional
    • Tipo: object

    • Opções adicionais a serem aplicadas.

      • limit opcional
        • Tipo: number

        • O número máximo de documentos a retornar.

Retorna: Promise<number>
deleteMany(Filtro)Promise<DeleteResult>

Exclui vários documentos.

Parâmetros:
  • filtro, filtro
    • Tipo: object

    • Um filtro aplicado para restringir o resultado.

Retorna: Promise<DeleteResult>
Excluir um(Filtro)Promise<DeleteResult>

Exclui um único documento correspondente da collection.

Parâmetros:
  • filtro, filtro
    • Tipo: object

    • Um filtro aplicado para restringir o resultado.

Retorna: Promise<DeleteResult>
find(filtro, opções)Promise<[object>, ...]

Localiza os documento que correspondem à query fornecida.

Parâmetros:
  • filtro, filtro opcional
    • Tipo: object

    • Um filtro opcional aplicado para restringir os resultados.

  • opções opcional
    • Tipo: object

    • Opções adicionais a serem aplicadas.

      • sort opcional
        • Tipo: object

        • A ordem na qual devolver os documentos correspondentes.

      • limit opcional
        • Tipo: number

        • O número máximo de documentos a retornar.

Retorna : Promise<[object>, ...] Os documentos.
findOne(filtro, opções)Promise<object>

Localiza um documento que corresponde ao filtro fornecido.

Parâmetros:
  • filtro, filtro opcional
    • Tipo: object

    • Um filtro opcional aplicado para restringir os resultados.

  • opções opcional
    • Tipo: object

    • Opções adicionais a serem aplicadas.

      • sort opcional
        • Tipo: object

        • A ordem na qual devolver os documentos correspondentes.

Retorna: Promise<object> O documento ou nulo se nada corresponder.
encontrarOneAndDelete(filtro, opções)Promise<object>

Localiza um documento que corresponde ao filtro fornecido e o exclui

Parâmetros:
  • filtro, filtro
    • Tipo: object

    • Um filtro aplicado para restringir os resultados.

  • opções opcional
    • Tipo: object

    • Opções adicionais a serem aplicadas.

      • sort opcional
        • Tipo: object

        • A ordem na qual devolver os documentos correspondentes.

Retorna: Promise<object> O documento ou nulo se nada corresponder.
encontrar um e substituir(filtro, substituição, opções)Promise<?object>

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

Parâmetros:
  • filtro, filtro
    • Tipo: object

    • Um filtro aplicado para restringir os resultados.

  • substituição
    • Tipo: object

    • Os novos valores para o documento.

  • opções opcional
    • Tipo: object

    • Opções adicionais a serem aplicadas.

      • sort opcional
        • Tipo: object

        • A ordem na qual devolver os documentos correspondentes.

      • upsert opcional
        • Tipo: boolean
        • Padrão: false

        • se verdadeiro, indica que o MongoDB deve inserir um novo documento que corresponda ao filtro de query quando a query não corresponder a nenhum documento existente na collection.

      • Devolver novo documento opcional
        • Tipo: boolean
        • Padrão: false

        • se verdadeiro, indica que a ação deve retornar o documento em seu formato atualizado em vez do formulário original de pré-atualização.

Retorna: Promise<?object> O documento (antes ou depois da modificação) ou nulo se nada corresponder.
findOneAndUpdate(filtro, atualização, opções)Promise<?object>

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

Parâmetros:
  • filtro, filtro
    • Tipo: object

    • Um filtro aplicado para restringir os resultados.

  • update
    • Tipo: object

    • Os novos valores para o documento.

  • opções opcional
    • Tipo: object

    • Opções adicionais a serem aplicadas.

      • sort opcional
        • Tipo: object

        • A ordem na qual devolver os documentos correspondentes.

      • upsert opcional
        • Tipo: boolean
        • Padrão: false

        • se verdadeiro, indica que o MongoDB deve inserir um novo documento que corresponda ao filtro de query quando a query não corresponder a nenhum documento existente na collection.

      • Devolver novo documento opcional
        • Tipo: boolean
        • Padrão: false

        • se verdadeiro, indica que a ação deve retornar o documento em seu formato atualizado em vez do formulário original de pré-atualização.

Retorna: Promise<?object> O documento (antes ou depois da modificação) ou nulo se nada corresponder.
insertMany(documentos)Promise<InsertManyResult>

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

Parâmetros:
  • documentos
    • Tipo: [object, ...]

    • A array de documentos.

Retorna: Promise<InsertManyResult> As ID do documento inseridos.
insertOne(documento)Promise<InsertOneResult>

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:
  • documento
    • Tipo: object

    • O documento.

Retorna: Promise<InsertOneResult> O _id do documento inserido.
updateMany(filtro, atualização, opções)Promise<UpdateResult>

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

Parâmetros:
  • filtro, filtro
    • Tipo: object

    • Um filtro aplicado para restringir os resultados.

  • update
    • Tipo: object

    • Os novos valores para o documento.

  • opções opcional
    • Tipo: object

    • Opções adicionais a serem aplicadas.

      • upsert opcional
        • Tipo: boolean
        • Padrão: false

        • se verdadeiro, indica que o MongoDB deve inserir um novo documento que corresponda ao filtro de query quando a query não corresponder a nenhum documento existente na collection.

      • arrayFilters opcional
        • Tipo: [object, ...]
        • Padrão: false

        • se fornecido, indica os arrayFilters a serem usados para atualizar uma array incorporada.

Retorna: Promise<UpdateResult>
updateOne(filtro, atualização, opções)Promise<UpdateResult>

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

Parâmetros:
  • filtro, filtro
    • Tipo: object

    • Um filtro aplicado para restringir os resultados.

  • update
    • Tipo: object

    • Os novos valores para o documento.

  • opções opcional
    • Tipo: object

    • Opções adicionais a serem aplicadas.

      • upsert opcional
        • Tipo: boolean
        • Padrão: false

        • se verdadeiro, indica que o MongoDB deve inserir um novo documento que corresponda ao filtro de query quando a query não corresponder a nenhum documento existente na collection.

      • arrayFilters opcional
        • Tipo: [object, ...]
        • Padrão: false

        • se fornecido, indica os arrayFilters a serem usados para atualizar uma array incorporada.

Retorna: Promise<UpdateResult>
assistir(opções)ChangeEvent

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, ReadableStream e TextDecoder: 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
Parâmetros:
  • opções opcional
    • Tipo: object
    • Padrão: {}
      • filtro, filtro opcional
        • Tipo: object

        • Um filtro para saber quais eventos de alteração você está interessado.

      • ids opcional
        • Tipo: [any, ...]

        • Uma lista de ID que você está interessado em assistir

Definições de tipo

ChangeEvent

Um evento em um change stream.

Observe que quais propriedades estão presentes dependerão do campo operationType , que está sempre presente, e da versão do MongoDB Server.

Tipo:
object
propriedades:
  • _id

    • O token de currículo opaco para este evento.

  • Tipo de operação
    • Tipo: string

    • Que tipo de operação foi essa? Um dos seguintes: "insert", "delete", "replace", "update", "drop", "rename", "dropDatabase" ou "invalidate".

  • Documento completo
    • Tipo: object

    • Uma cópia completa do documento que foi tocada por essa operação. Consulte o manual de referência do MongoDB para obter detalhes sobre qual versão do documento será retornada.

  • ns
    • Tipo: object

    • namespace da collection afetado por este evento.

      • db
        • Tipo: string

        • Nome do Banco de Dados

      • coll
        • Tipo: string

        • Nome da Coleção

  • para
    • Tipo: object

    • namespace de destino para "rename" evento.

      • db
        • Tipo: string

        • Nome do Banco de Dados

      • coll
        • Tipo: string

        • Nome da Coleção

  • documentKey
    • Tipo: object

    • O _id e a chave de shard do documento modificado. _id não é duplicado se fizer parte da chave fragmentada.

  • updateDescription
    • Tipo: object
      • updatedFields
        • Tipo: object

        • Um mapeamento de objeto de nomes de campo modificados para seus novos valores.

      • removidoFields
        • Tipo: [string, ...]

        • Uma lista de nomes de campos que foram removidos.

  • clusterTime
    • Tipo: Timestamp

    • O carimbo de data/hora da entrada de registro opcional associada ao evento.

  • txnNumber
    • Tipo: Long

    • O número da transação. Presente somente se fizer parte de uma transação multidocumento.

  • lsid
    • Tipo: object

    • A ID da sessão lógica da transação. Presente somente se fizer parte de uma transação multidocumento.

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

Resultado da exclusão de documentos

Tipo:
object
propriedades:
  • deleteCount
    • Tipo: number

    • O número de documentos que foram excluídos.

InsertManyResult
propriedades:
  • insertIds
    • Tipo: Array

    • As ID do documento inseridos

InsertOneResult
propriedades:
  • insertId

    • O ID do documento inserido

UpdateResult

Resultado da atualização de documentos

Tipo:
object
propriedades:
  • matchedCount
    • Tipo: number

    • O número de documentos que correspondem ao filtro.

  • modifiedCount
    • Tipo: number

    • O número de documentos correspondentes pela query.

  • upsertedId opcional

    • O identificador do documento inserido se tiver ocorrido um upsert.