Realm MongoDBCollection

在MongoDB database中的远程collection集合。

名称

获取collection的名称。

聚合(管道)Promise<[object>, ...]

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

参数
  • 管道
    • 类型: [object, ...]
    • 聚合管道阶段的数组。

返回Promise<[object>, ...]结果。
数数(筛选器,选项)Promise<number>

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

参数
  • 筛选器 可选
    • 类型: object
    • 用于缩小结果范围的可选筛选器。

  • 选项 可选
    • 类型: object
    • 要应用的其他选项。

      • limit 可选
        • 类型: number
        • 要返回的最大文档数。

返回Promise<number>
deleteMany(过滤器)Promise<DeleteResult>

删除多个文档。

参数
  • 筛选器
    • 类型: object
    • 用于缩小结果范围的筛选器。

返回Promise<DeleteResult>
deleteOne(过滤器)Promise<DeleteResult>

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

参数
  • 筛选器
    • 类型: object
    • 用于缩小结果范围的筛选器。

返回Promise<DeleteResult>
find(筛选器,选项)Promise<[object>, ...]

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

参数
  • 筛选器 可选
    • 类型: object
    • 用于缩小结果范围的可选筛选器。

  • 选项 可选
    • 类型: object
    • 要应用的其他选项。

      • sort 可选
        • 类型: object
        • 返回匹配文档的顺序。

      • limit 可选
        • 类型: number
        • 要返回的最大文档数。

返回Promise<[object>, ...]文档。
findOne(筛选器,选项)Promise<object>

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

参数
  • 筛选器 可选
    • 类型: object
    • 用于缩小结果范围的可选筛选器。

  • 选项 可选
    • 类型: object
    • 要应用的其他选项。

      • sort 可选
        • 类型: object
        • 返回匹配文档的顺序。

返回Promise<object>文档;如果没有匹配的内容,则返回 null。
findOneAndDelete(filter, options )Promise<object>

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

参数
  • 筛选器
    • 类型: object
    • 用于缩小结果范围的筛选器。

  • 选项 可选
    • 类型: object
    • 要应用的其他选项。

      • sort 可选
        • 类型: object
        • 返回匹配文档的顺序。

返回Promise<object>文档;如果没有匹配的内容,则返回 null。
findOneAndReplace(筛选器、替换项、选项Promise<?object>

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

参数
  • 筛选器
    • 类型: object
    • 用于缩小结果范围的筛选器。

  • 替换
    • 类型: object
    • 文档的新值。

  • 选项 可选
    • 类型: object
    • 要应用的其他选项。

      • sort 可选
        • 类型: object
        • 返回匹配文档的顺序。

      • 更新插入 可选
        • 类型: boolean
        • 默认: false
        • 如果为 true,则表示当查询与collection中的任何现有文档都不匹配时,MongoDB 应插入与查询筛选器匹配的新文档。

      • returnNewDocument 可选
        • 类型: boolean
        • 默认: false
        • 如果为 true,则表示该操作应以更新后的形式返回文档,而不是原始的更新前形式。

返回Promise<?object>文档(修改之前或之后);如果没有匹配的内容,则返回 null。
findOneAndUpdate(filter, 更新, options )Promise<?object>

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

参数
  • 筛选器
    • 类型: object
    • 用于缩小结果范围的筛选器。

  • update
    • 类型: object
    • 文档的新值。

  • 选项 可选
    • 类型: object
    • 要应用的其他选项。

      • sort 可选
        • 类型: object
        • 返回匹配文档的顺序。

      • 更新插入 可选
        • 类型: boolean
        • 默认: false
        • 如果为 true,则表示当查询与collection中的任何现有文档都不匹配时,MongoDB 应插入与查询筛选器匹配的新文档。

      • returnNewDocument 可选
        • 类型: boolean
        • 默认: false
        • 如果为 true,则表示该操作应以更新后的形式返回文档,而不是原始的更新前形式。

返回Promise<?object>文档(修改之前或之后);如果没有匹配的内容,则返回 null。
insertMany(文档)Promise<InsertManyResult>

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

参数
  • 文档
    • 类型: [object, ...]
    • 文档数组。

返回Promise<InsertManyResult>插入文档的 _id。
insertOne(文档)Promise<InsertOneResult>

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

参数
  • 文档
    • 类型: object
    • 文档。

返回Promise<InsertOneResult>插入文档的 _id。
updateMany(filter, 更新, options )Promise<UpdateResult>

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

参数
  • 筛选器
    • 类型: object
    • 用于缩小结果范围的筛选器。

  • update
    • 类型: object
    • 文档的新值。

  • 选项 可选
    • 类型: object
    • 要应用的其他选项。

      • 更新插入 可选
        • 类型: boolean
        • 默认: false
        • 如果为 true,则表示当查询与collection中的任何现有文档都不匹配时,MongoDB 应插入与查询筛选器匹配的新文档。

      • arrayFilters 可选
        • 类型: [object, ...]
        • 默认: false
        • 如果提供,则表示用于更新嵌入式数组的数组筛选器。

返回Promise<UpdateResult>
updateOne(filter, 更新, options )Promise<UpdateResult>

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

参数
  • 筛选器
    • 类型: object
    • 用于缩小结果范围的筛选器。

  • update
    • 类型: object
    • 文档的新值。

  • 选项 可选
    • 类型: object
    • 要应用的其他选项。

      • 更新插入 可选
        • 类型: boolean
        • 默认: false
        • 如果为 true,则表示当查询与collection中的任何现有文档都不匹配时,MongoDB 应插入与查询筛选器匹配的新文档。

      • arrayFilters 可选
        • 类型: [object, ...]
        • 默认: false
        • 如果提供,则表示用于更新嵌入式数组的数组筛选器。

返回Promise<UpdateResult>
观看选项ChangeEvent

创建异步change stream以监控此collection的更改。

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

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

  1. fetchReadableStreamTextDecoder的 Polyfill: https ://www.npmjs.com/package/react-native-polyfill-globals
  2. 支持异步生成器语法的 Babel 插件: https ://npmjs.com/package/@babel/plugin-proposal-async-generator-functions
参数
  • 选项 可选
    • 类型: object
    • 默认: {}
      • 筛选器 可选
        • 类型: object
        • 您感兴趣的变更事件的筛选器。

      • id 可选
        • 类型: [any, ...]
        • 您有兴趣观看的 ID 列表

ChangeEvent

change stream中的事件。

请注意,存在哪些属性取决于始终存在的operationType字段和 MongoDB Server 版本。

类型
object
属性:
  • _id
    • 此事件的不透明恢复令牌。

  • 操作类型
    • 类型: string
    • 这是什么操作? 以下值之一: "insert""delete""replace""update""drop""rename""dropDatabase""invalidate"

  • 完整文档
    • 类型: object
    • 此操作涉及的文档的完整副本。 有关将返回哪个文档版本的详细信息,请参阅 mongodb 参考手册。

  • ns
    • 类型: object
    • 受此事件影响的collection的命名空间。

      • db
        • 类型: string
        • 数据库名称

      • coll
        • 类型: string
        • 集合名称

  • to
    • 类型: object
    • "rename"事件的目标命名空间。

      • db
        • 类型: string
        • 数据库名称

      • coll
        • 类型: string
        • 集合名称

  • documentKey
    • 类型: object
    • 已修改文档的_id和分片键。 如果_id是分片键的一部分,则它不会重复。

  • updateDescription
    • 类型: object
      • updatedFields
        • 类型: object
        • 从修改后的字段名称到新值的映射对象。

      • removeFields
        • 类型: [string, ...]
        • 已删除的字段名称列表。

  • clusterTime
    • 类型: Timestamp
    • 与事件相关的 oplog 条目中的时间戳。

  • txnNumber
    • 类型: Long
    • 事务编号。仅当是多文档事务的一部分时才出现。

  • lsid
    • 类型: object
    • 事务的逻辑会话 ID。 仅当是多文档事务的一部分时才出现。

DeleteResult

删除文档的结果

类型
object
属性:
  • DeletedCount
    • 类型: number
    • 已删除的文档数量。

InsertManyResult
属性:
  • InsertedIds
    • 类型: Array
    • 插入文档的 ID

InsertOneResult
属性:
  • InsertId
    • 插入文档的 ID

UpdateResult

更新文档的结果

类型
object
属性:
  • 匹配计数
    • 类型: number
    • 与筛选器匹配的文档数量。

  • modifiedCount
    • 类型: number
    • 与查询匹配的文档数。

  • upsertedId 可选
    • 所插入文档的标识符(如果进行更新或插入)。