在MongoDB database中的远程collection集合。

类型参数

构造函数

属性

集合名称: any
数据库名称: 字符串
功能: any
服务名称: 字符串

访问器

  • get name ( ) : string
  • 集合的名称。

    返回字符串

方法

  • 针对此collection运行聚合框架管道。

    参数

    返回Promise < unknown >

    解析为聚合结果的 Promise。

  • 计算此集合中与提供的筛选器匹配的文档数量。

    注意:在不使用筛选器的情况下调用此方法时,您可能会收到不准确的文档计数,因为它会根据集合的元数据返回结果,而这可能会得出近似计数。 特别是:

    • 在分片集群上,所产生的计数将无法正确过滤孤立文档
    • 在非正常关闭或基于文件副本的初始同步后,计数可能不正确。

    参数

    • Optional filter :筛选器

      用于缩小结果范围的可选筛选器。

    • Optional options : CountOptions

      要应用的其他选项。

    返回Promise < number >

    解析为与过滤器匹配的文档数量的 Promise。

  • 删除多个文档。

    参数

    • Optional filter :筛选器

      用于缩小结果范围的筛选器。 如果省略,则默认为{} ,这会删除集合中的所有文档。

    返回Promise < DeleteResult >

    一个 Promise,解析为包含已删除文档数量的对象 ( deletedCount )。

  • 从collection中删除单个匹配文档。

    参数

    • Optional filter :筛选器

      用于缩小结果范围的筛选器。

    返回Promise < DeleteResult >

    一个 Promise,解析为包含已删除文档数量的对象 ( deletedCount )。

  • 查找与所提供的查询匹配的文档。

    参数

    • Optional filter :筛选器

      用于缩小结果范围的可选筛选器。

    • Optional options : FindOptions

      要应用的其他选项。

    返回Promise < T [] >

    解析为找到的文档的 Promise。

  • 查找与提供的筛选器匹配的文档。

    参数

    • Optional filter :筛选器

      用于缩小结果范围的筛选器。

    • Optional options : FindOneOptions

      要应用的其他选项。

    返回Promise < null | T >

    解析为找到的文档的 Promise。

  • 查找与提供的筛选器匹配的文档并将其删除

    参数

    • Optional filter :筛选器

      用于缩小结果范围的筛选器。

    • Optional options : FindOneOptions

      要应用的其他选项。

    返回Promise < null | T >

    在删除之前解析为找到的文档的 Promise。

  • 查找与提供的筛选器匹配的文档,并将其替换为新文档。

    参数

    • filter :筛选器

      用于缩小结果范围的筛选器。

    • 替换未知

      新的替换文档。

    • Optional options : FindOneAndModifyOptions

      要应用的其他选项。

    返回Promise < null | T >

    解析为替换之前找到的文档的 Promise。

  • 查找与所提供的查询匹配的文档,并对各个字段执行所需的更新。

    参数

    返回Promise < null | T >

    在应用更新之前解析找到的文档的 Promise。

  • 将文档数组插入到collection中。如果有任何值缺少标识符,则它们将由服务器生成。

    参数

    返回 Promise < InsertManyResult < T [ "_id " ] >>

    一个 Promise,解析为包含插入的 ID 数组的对象 ( insertedIds )。

  • 将单个文档插入到collection中。注意:如果文档缺少 _id,服务器将为其生成一个 _id。

    参数

    返回 Promise < InsertOneResult < T [ "_id " ] >>

    一个 Promise,用于解析包含插入对象 ID ( insertedId ) 的对象。

  • 更新与此collection中提供的筛选器匹配的多个文档。

    参数

    • filter :筛选器

      用于缩小结果范围的筛选器。

    • update更新

      文档的新值。

    • Optional options : UpdateOptions

      要应用的其他选项。

    返回 Promise < UpdateResult < T [ "_id " ] >>

    解析为包含以下内容的对象的 Promise:

    {
    matchedCount: number;
    modifiedCount: number;
    upsertedId: IdType | undefined;
    }
  • 更新与此collection中提供的筛选器匹配的单个文档。

    参数

    • filter :筛选器

      用于缩小结果范围的筛选器。

    • update更新

      文档的新值。

    • Optional options : UpdateOptions

      要应用的其他选项。

    返回 Promise < UpdateResult < T [ "_id " ] >>

    解析为包含以下内容的对象的 Promise:

    {
    matchedCount: number;
    modifiedCount: number;
    upsertedId: IdType | undefined;
    }
  • 创建异步change stream以监控此collection的更改。

    默认情况下,生成此collection的所有事件。您最多可以指定filterids选项之一。

    重要提示:要在 React Native 上使用此功能,必须安装:

    1. fetchReadableStream的 Polyfill: https ://www.npmjs.com/package/react-native-polyfill-globals
    2. 支持异步生成器语法的 Babel 插件: https ://npmjs.com/package/@babel/plugin-proposal-async-generator-functions

    返回AsyncGenerator < ChangeEvent < T > , any , unknown >

    变更事件的异步生成器。

  • 参数

    返回AsyncGenerator < ChangeEvent < T > , any , unknown >

  • 参数

    返回AsyncGenerator < ChangeEvent < T > , any , unknown >

使用TypeDoc生成