Docs 菜单
Docs 主页
/
MongoDB Atlas
/
Atlas Device SDKs
/
Java SDK
/
API 参考
/
io.realm.mongodb.mongo

类 MongoCollection

在此页面上

  • io.realm.mongodb.mongo
  • 方法摘要
  • 继承方法
  • 方法详细信息
  • 聚合
  • 数数
  • deleteMany
  • deleteOne
  • find
  • findOne
  • findOneAndDelete
  • findOneAndReplace
  • findOneAndUpdate
  • getCodecRegistry
  • getDocumentClass
  • getName
  • getNamespace
  • insertMany
  • insertOne
  • updateMany
  • updateOne
  • 观看
  • watchAsync
  • watchWithFilter
  • watchWithFilterAsync
  • withCodecRegistry
  • withDocumentClass

io.realm.mongodb.mongo

java.lang.Object
io.realm.mongodb.mongo.MongoCollection

MongoCollection 接口提供对文档的读写访问权限。使用MongoDatabase.getCollection获取collection实例。

在进行任何访问之前，必须有一个活跃的登录用户。

提示

另请参阅：

  • MongoDatabase

方法摘要

修饰符和类型
方法和说明
aggregate <ResultT >(
java.util.List<? extends Bson> pipeline,
java.lang.Class<ResultT> resultClass
)

根据指定输出类的指定聚合管道聚合文档。

aggregate (
java.util.List<? extends Bson> pipeline
)

根据指定的聚合管道聚合文档。

count (
Bson filter,
CountOptions options
)

根据给定选项计算collection中的文档数量。

count (
Bson filter
)

根据给定选项计算collection中的文档数量。

count ()

计算collection中的文档数量。

deleteMany (
Bson filter
)

从集合中删除与给定查询筛选器匹配的所有文档。

deleteOne (
Bson filter
)

从集合中最多删除一个与给定筛选器匹配的文档。

find <ResultT >(
Bson filter,
java.lang.Class<ResultT> resultClass,
FindOptions options
)

查找collection中与指定输出类的给定筛选器匹配并使用FindOptions构建查询的所有文档。

find <ResultT >(
Bson filter,
java.lang.Class<ResultT> resultClass
)

查找collection中与指定输出类的给定筛选器匹配的所有文档。

find (
Bson filter,
FindOptions options
)

使用FindOptions构建查询，查找collection中与给定筛选器匹配的所有文档。

find (
Bson filter
)

查找collection中与给定筛选器匹配的所有文档。

find <ResultT >(
java.lang.Class<ResultT> resultClass,
FindOptions options
)

查找collection中指定输出类并使用FindOptions构建查询的所有文档。

find <ResultT >(
java.lang.Class<ResultT> resultClass
)

查找指定输出类的集合中的所有文档。

find (
FindOptions options
)

使用FindOptions构建查询来查找collection中的所有文档。

find ()

查找collection中的所有文档。

findOne <ResultT >(
Bson filter,
FindOptions options,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档。

findOne (
Bson filter,
FindOptions options
)

在collection中查找文档。

findOne <ResultT >(
Bson filter,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档。

findOne (
Bson filter
)

在collection中查找文档。

findOne <ResultT >(
java.lang.Class<ResultT> resultClass
)

在collection中查找文档。

findOne ()

在collection中查找文档。

findOneAndDelete <ResultT >(
Bson filter,
FindOneAndModifyOptions options,
java.lang.Class<ResultT> resultClass
)

在集合中查找文档并将其删除。

findOneAndDelete (
Bson filter,
FindOneAndModifyOptions options
)

在集合中查找文档并将其删除。

findOneAndDelete <ResultT >(
Bson filter,
java.lang.Class<ResultT> resultClass
)

在集合中查找文档并将其删除。

findOneAndDelete (
Bson filter
)

在集合中查找文档并将其删除。

findOneAndReplace <ResultT >(
Bson filter,
Bson replacement,
FindOneAndModifyOptions options,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档并将其替换为给定文档。

findOneAndReplace (
Bson filter,
Bson replacement,
FindOneAndModifyOptions options
)

在collection中查找文档并将其替换为给定文档。

findOneAndReplace <ResultT >(
Bson filter,
Bson replacement,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档并将其替换为给定文档。

findOneAndReplace (
Bson filter,
Bson replacement
)

在collection中查找文档并将其替换为给定文档。

findOneAndUpdate <ResultT >(
Bson filter,
Bson update,
FindOneAndModifyOptions options,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档并执行给定更新。

findOneAndUpdate (
Bson filter,
Bson update,
FindOneAndModifyOptions options
)

在collection中查找文档并执行给定更新。

findOneAndUpdate <ResultT >(
Bson filter,
Bson update,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档并执行给定更新。

findOneAndUpdate (
Bson filter,
Bson update
)

在collection中查找文档并执行给定更新。

公共CodecRegistry
getCodecRegistry ()

获取 MongoCollection 的编解码器注册表。

公共 类
getDocumentClass ()

获取存储在此collection中的文档的类。

公共string
getName ()

获取此collection的名称

getNamespace ()

获取此collection的命名空间，即

insertMany (
java.util.List<? extends DocumentT> documents
)

插入一份或多份文档。

insertOne (
DocumentT document
)

插入提供的文档。

updateMany (
Bson filter,
Bson update,
UpdateOptions updateOptions
)

根据指定参数更新collection中的所有文档。

updateMany (
Bson filter,
Bson update
)

根据指定参数更新collection中的所有文档。

updateOne (
Bson filter,
Bson update,
UpdateOptions updateOptions
)

根据指定参数更新collection中的文档。

updateOne (
Bson filter,
Bson update
)

根据指定参数更新collection中的文档。

watch (
ObjectId[] ids
)

监视collection中的指定ID。

watch (
BsonValue[] ids
)

监视collection中的指定ID。

watch ()

监视collection。

watchAsync (
ObjectId[] ids
)

异步监视collection中的指定ID。

watchAsync (
BsonValue[] ids
)

异步监视collection中的指定ID。

watchAsync ()

异步监视collection。

watchWithFilter (
BsonDocument matchFilter
)

监视collection。

watchWithFilter (
Document matchFilter
)

监视collection。

watchWithFilterAsync (
BsonDocument matchFilter
)

异步监视collection。

watchWithFilterAsync (
Document matchFilter
)

异步监视collection。

withCodecRegistry (
CodecRegistry codecRegistry
)

使用不同的编解码器注册表创建新的 MongoCollection 实例。

withDocumentClass <NewDocumentT >(
java.lang.Class<NewDocumentT> clazz
)

创建具有不同默认类的新 MongoCollection 实例，将从数据库返回的任何文档转换为该实例。

继承方法

  • 从类 java.lang.Object 继承的方法 ：getClass ,hashCode ,equals ,clone ,toString ,notify ,notifyAll ,wait ,wait ,wait ,finalize

方法详细信息

聚合

根据指定输出类的聚合管道聚合文档。所有文档都将以AggregateIterable的形式交付，可以从中提取单个元素。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • pipeline - 聚合管道

  • resultClass - 将每个文档解码为的类

返回：

一个AggregateIterable ，可以从中提取结果

根据指定的聚合管道聚合文档。所有文档都将以AggregateIterable的形式交付，可以从中提取单个元素。

参数

  • pipeline - 聚合管道

返回：

一个AggregateIterable ，可以从中提取结果

数数

public RealmResultTask count (
Bson filter,
CountOptions options
)

根据给定选项计算collection中的文档数量。

参数

  • filter - 查询筛选器

  • options - 描述计数的选项

返回：

包含集合中文档数量的任务

public RealmResultTask count (
Bson filter
)

根据给定选项计算collection中的文档数量。

参数

  • filter - 查询筛选器

返回：

包含集合中文档数量的任务

计算collection中的文档数量。

返回：

包含集合中文档数量的任务

deleteMany

public RealmResultTask deleteMany (
Bson filter
)

从集合中删除与给定查询筛选器匹配的所有文档。 如果没有匹配的文档，则不会修改集合。

参数

  • filter — 应用删除操作的查询筛选器

返回：

包含“删除多个”操作结果的任务

deleteOne

public RealmResultTask deleteOne (
Bson filter
)

从collection中最多删除一个与给定筛选器匹配的文档。如果没有匹配的文档，则不会修改集合。

参数

  • filter — 应用删除操作的查询筛选器

返回：

包含删除一个操作结果的任务

find

public FindIterable find <ResultT >(
Bson filter,
java.lang.Class<ResultT> resultClass,
FindOptions options
)

查找collection中与指定输出类的给定筛选器匹配并使用FindOptions构建查询的所有文档。

所有文档都将以FindIterable的形式交付，可以从中提取单个元素。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • filter - 查询筛选器

  • resultClass - 将每个文档解码为的类

  • options - FindOptions结构体

返回：

包含查找操作结果的迭代

public FindIterable find <ResultT >(
Bson filter,
java.lang.Class<ResultT> resultClass
)

查找collection中与指定输出类的给定筛选器匹配的所有documents。所有documents都将以FindIterable的形式提供，可以从中提取单个元素。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • filter - 查询筛选器

  • resultClass - 将每个文档解码为的类

返回：

包含查找操作结果的迭代

public FindIterable find (
Bson filter,
FindOptions options
)

使用FindOptions构建查询，查找collection中与给定筛选器匹配的所有文档。

所有文档都将以FindIterable的形式交付，可以从中提取单个元素。

参数

返回：

包含查找操作结果的迭代

public FindIterable find (
Bson filter
)

查找collection中与给定筛选器匹配的所有文档。所有文档都将以FindIterable的形式交付，可以从中提取单个元素。

参数

  • filter - 查询筛选器

返回：

包含查找操作结果的迭代

public FindIterable find <ResultT >(
java.lang.Class<ResultT> resultClass,
FindOptions options
)

查找collection中指定输出类并使用FindOptions构建查询的所有文档。

所有文档都将以FindIterable的形式交付，可以从中提取单个元素。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • resultClass - 将每个文档解码为的类

  • options - 用于构建查询的FindOptions结构体

返回：

包含查找操作结果的迭代

public FindIterable find <ResultT >(
java.lang.Class<ResultT> resultClass
)

查找指定输出类的collection中的所有documents。所有documents都将以FindIterable的形式传递，可以从中提取单个元素。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • resultClass - 将每个文档解码为的类

返回：

包含查找操作结果的迭代

public FindIterable find (
FindOptions options
)

使用FindOptions构建查询来查找collection中的所有文档。

所有文档都将以FindIterable的形式交付，可以从中提取单个元素。

参数

返回：

包含查找操作结果的迭代

public FindIterable find ()

查找集合中的所有文档。所有文档都将以FindIterable的形式交付，可以从中提取单个元素。

返回：

包含查找操作结果的迭代

findOne

public RealmResultTask findOne <ResultT >(
Bson filter,
FindOptions options,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • filter - 查询筛选器

  • options - FindOptions结构体

  • resultClass - 将每个文档解码为的类

返回：

包含查找一个操作结果的任务

public RealmResultTask findOne (
Bson filter,
FindOptions options
)

在collection中查找文档。

参数

返回：

包含查找一个操作结果的任务

public RealmResultTask findOne <ResultT >(
Bson filter,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • filter - 查询筛选器

  • resultClass - 将每个文档解码为的类

返回：

包含查找一个操作结果的任务

public RealmResultTask findOne (
Bson filter
)

在collection中查找文档。

参数

  • filter - 查询筛选器

返回：

包含查找一个操作结果的任务

public RealmResultTask findOne <ResultT >(
java.lang.Class<ResultT> resultClass
)

在collection中查找文档。

类型参数

  • ResultT - 目标文档类型

参数

  • resultClass - 将每个文档解码为的类

返回：

包含查找一个操作结果的任务

在collection中查找文档。

返回：

包含查找一个操作结果的任务

findOneAndDelete

public RealmResultTask findOneAndDelete <ResultT >(
Bson filter,
FindOneAndModifyOptions options,
java.lang.Class<ResultT> resultClass
)

在集合中查找文档并将其删除。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

返回：

包含生成文档的任务

在集合中查找文档并将其删除。

参数

返回：

包含生成文档的任务

public RealmResultTask findOneAndDelete <ResultT >(
Bson filter,
java.lang.Class<ResultT> resultClass
)

在集合中查找文档并将其删除。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • filter - 查询筛选器

  • resultClass - 将每个文档解码为的类

返回：

包含生成文档的任务

public RealmResultTask findOneAndDelete (
Bson filter
)

在集合中查找文档并将其删除。

参数

  • filter - 查询筛选器

返回：

包含生成文档的任务

findOneAndReplace

public RealmResultTask findOneAndReplace <ResultT >(
Bson filter,
Bson replacement,
FindOneAndModifyOptions options,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档并将其替换为给定文档。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • filter - 查询筛选器

  • replacement - 用于替换匹配文档的文档

  • options - FindOneAndModifyOptions结构体

  • resultClass - 将每个文档解码为的类

返回：

包含生成文档的任务

public RealmResultTask findOneAndReplace (
Bson filter,
Bson replacement,
FindOneAndModifyOptions options
)

在collection中查找文档并将其替换为给定文档。

参数

返回：

包含生成文档的任务

public RealmResultTask findOneAndReplace <ResultT >(
Bson filter,
Bson replacement,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档并将其替换为给定文档。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • filter - 查询筛选器

  • replacement - 用于替换匹配文档的文档

  • resultClass - 将每个文档解码为的类

返回：

包含生成文档的任务

public RealmResultTask findOneAndReplace (
Bson filter,
Bson replacement
)

在collection中查找文档并将其替换为给定文档。

参数

  • filter - 查询筛选器

  • replacement - 用于替换匹配文档的文档

返回：

包含生成文档的任务

findOneAndUpdate

public RealmResultTask findOneAndUpdate <ResultT >(
Bson filter,
Bson update,
FindOneAndModifyOptions options,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档并执行给定更新。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • filter - 查询筛选器

  • update - 更新文档

  • options - FindOneAndModifyOptions结构体

  • resultClass - 将每个文档解码为的类

返回：

包含生成文档的任务

public RealmResultTask findOneAndUpdate (
Bson filter,
Bson update,
FindOneAndModifyOptions options
)

在collection中查找文档并执行给定更新。

参数

返回：

包含生成文档的任务

public RealmResultTask findOneAndUpdate <ResultT >(
Bson filter,
Bson update,
java.lang.Class<ResultT> resultClass
)

在collection中查找文档并执行给定更新。

类型参数

  • ResultT - 可迭代对象的目标文档类型。

参数

  • filter - 查询筛选器

  • update - 更新文档

  • resultClass - 将每个文档解码为的类

返回：

包含生成文档的任务

public RealmResultTask findOneAndUpdate (
Bson filter,
Bson update
)

在collection中查找文档并执行给定更新。

参数

  • filter - 查询筛选器

  • update - 更新文档

返回：

包含生成文档的任务

getCodecRegistry

public CodecRegistry getCodecRegistry ()

获取 MongoCollection 的编解码器注册表。

返回：

此collection的CodecRegistry

getDocumentClass

获取此集合中存储的文档类。如果使用简单的 MongoDatabase.getCollection(string ) 来获取此集合，则此值为 org.bson.Document 。

返回：

此collection中的文档类别

getName

public String getName ()

获取此collection的名称

返回：

名称

getNamespace

获取此集合的命名空间，即数据库和集合名称的组合。

返回：

命名空间

insertMany

插入一份或多份文档。

参数

  • documents - 要插入的文档

返回：

包含插入多个操作结果的任务

insertOne

public RealmResultTask insertOne (
DocumentT document
)

插入提供的文档。 如果文档缺少标识符，客户端应生成一个。

参数

  • document - 要插入的文档

返回：

包含插入一个操作结果的任务

updateMany

public RealmResultTask updateMany (
Bson filter,
Bson update,
UpdateOptions updateOptions
)

根据指定参数更新collection中的所有文档。

参数

  • filter - 描述查询筛选器的文档，不得为空。

  • update - 描述更新的文档，不得为空。 要应用的更新必须仅包含更新操作符。

  • updateOptions - 应用于更新操作的选项

返回：

包含更新多次操作结果的任务

public RealmResultTask updateMany (
Bson filter,
Bson update
)

根据指定参数更新collection中的所有文档。

参数

  • filter - 描述查询筛选器的文档，不得为空。

  • update - 描述更新的文档，不得为空。 要应用的更新必须仅包含更新操作符。

返回：

包含更新多次操作结果的任务

updateOne

public RealmResultTask updateOne (
Bson filter,
Bson update,
UpdateOptions updateOptions
)

根据指定参数更新collection中的文档。

参数

  • filter - 描述查询筛选器的文档，不得为空。

  • update - 描述更新的文档，不得为空。 要应用的更新必须仅包含更新操作符。

  • updateOptions - 应用于更新操作的选项

返回：

包含更新操作结果的任务

public RealmResultTask updateOne (
Bson filter,
Bson update
)

根据指定参数更新collection中的文档。

参数

  • filter - 描述查询筛选器的文档，不得为空。

  • update - 描述更新的文档，不得为空。 要应用的更新必须仅包含更新操作符。

返回：

包含更新操作结果的任务

观看

public RealmEventStreamTask watch (
ObjectId[] ids
)

监视集合中的指定 ID。 这种便捷重载通过将ObjectId的非BsonValue实例包装在用户的BsonObjectId实例中来支持这些使用案例。

参数

  • ids - 要监视的 ID 的唯一对象标识符。

返回：

提供对变更事件流的访问权限的任务。

public RealmEventStreamTask watch (
BsonValue[] ids
)

监视collection中的指定ID。

参数

  • ids - 要监视的 ID。

返回：

提供对变更事件流的访问权限的任务。

监视collection。生成的流将收到有关此集合的所有事件的通知，根据配置的 MongoDB Realm 规则，授权活动用户查看这些事件。

返回：

提供对变更事件流的访问权限的任务。

watchAsync

public RealmEventStreamAsyncTask watchAsync (
ObjectId[] ids
)

异步监视collection中的指定ID。这种便捷重载通过将ObjectId的非BsonValue实例包装在用户的BsonObjectId实例中来支持这些使用案例。

参数

  • ids - 要监视的 ID 的唯一对象标识符。

返回：

提供对变更事件流的访问权限的任务。

public RealmEventStreamAsyncTask watchAsync (
BsonValue[] ids
)

异步监视collection中的指定ID。

参数

  • ids - 要监视的 ID。

返回：

提供对变更事件流的访问权限的任务。

异步监视collection。生成的流将收到有关此集合的所有事件的通知，根据配置的 MongoDB Realm 规则，授权活动用户查看这些事件。

返回：

提供对变更事件流的访问权限的任务。

watchWithFilter

public RealmEventStreamTask watchWithFilter (
BsonDocument matchFilter
)

监视集合。 提供的 BSON 文档将用作来自流的变更事件的匹配表达式筛选器。请参阅如何定义匹配筛选器。

定义用于筛选 ChangeEvents 的匹配表达式与如何为Atlas Triggers定义匹配表达式类似

参数

  • matchFilter - 应用于传入变更事件的 $match 筛选器

返回：

提供对变更事件流的访问权限的任务。

public RealmEventStreamTask watchWithFilter (
Document matchFilter
)

监视集合。 提供的文档将用作来自流的变更事件的匹配表达式筛选器。 这种便利重载支持用户使用非BsonDocument实例。

了解如何定义匹配过滤。

定义用于筛选 ChangeEvents 的匹配表达式与如何为Atlas Triggers定义匹配表达式类似

参数

  • matchFilter - 应用于传入变更事件的 $match 筛选器

返回：

提供对变更事件流的访问权限的任务。

watchWithFilterAsync

public RealmEventStreamAsyncTask watchWithFilterAsync (
BsonDocument matchFilter
)

异步监视集合。 所提供的BSON文档将用作来自流的变更事件的匹配表达式过滤。请参阅如何定义匹配过滤。

定义用于筛选 ChangeEvents 的匹配表达式与如何为Atlas Triggers定义匹配表达式类似

参数

  • matchFilter - 应用于传入变更事件的 $match 筛选器

返回：

提供对变更事件流的访问权限的任务。

public RealmEventStreamAsyncTask watchWithFilterAsync (
Document matchFilter
)

异步监视collection。提供的文档将用作来自流的变更事件的匹配表达式筛选器。 这种便利重载支持用户使用非BsonDocument实例。

了解如何定义匹配过滤。

定义用于筛选 ChangeEvents 的匹配表达式与如何为Atlas Triggers定义匹配表达式类似

参数

  • matchFilter - 应用于传入变更事件的 $match 筛选器

返回：

提供对变更事件流的访问权限的任务。

withCodecRegistry

public MongoCollection withCodecRegistry (
CodecRegistry codecRegistry
)

使用不同的编解码器注册表创建新的 MongoCollection 实例。

参数

  • codecRegistry - collection的新CodecRegistry 。

返回：

具有不同编解码器注册表的新 MongoCollection 实例

withDocumentClass

创建具有不同默认类的新 MongoCollection 实例，将从数据库返回的任何文档转换为该实例。

类型参数

  • NewDocumentT - 新集合将文档编码和解码到的类型。

参数

  • clazz - 从数据库返回的任何文档都将转换为的默认类。

返回：

具有不同默认类的新 MongoCollection 实例

后退

MongoClient

来年

MongoDatabase