类 MongoClient.Collection<TDocument>

一个表示远程 MongoDB collection 的对象。

继承

对象

MongoClient.Collection<TDocument>

命名空间： Realm 。 Sync

程序集：Realm.dll

语法

public class MongoClient.Collection<TDocument> where TDocument : class

类型参数

名称	说明
TDocument	与集合中文档的形状匹配的托管类型。

属性

Database

获取此collection所属的数据库。

声明

public MongoClient.Database? Database { get; }

属性值

类型	说明
MongoClient 。数据库	集合的数据库；如果使用MongoClient.Collection<TDocument>自动推断数据库，则为 null。

名称

获取collection的名称。

声明

public string Name { get; }

属性值

类型	说明
字符串	collection名称。

方法

AggregateAsync(params 对象[])

在collection上执行MongoDB管道，并以MongoDB.BSON.BSONDocument数组的形式返回结果。

声明

public Task<BsonDocument[]> AggregateAsync(params object[] pipeline)

参数

类型	名称	说明
对象 []	管道	使用管道表达式描述不同管道阶段的文档。

返回：

类型	说明
任务< BsonDocument []>	代表远程聚合操作的可等待任务。 任务的结果是一个数组，其中包含通过执行聚合pipeline返回的文档。

另请参阅

https://mongodb.com/zh-cn/docs/manual/aggregation/

AggregateAsync<TProjection>(params 对象[])

对collection执行聚合管道，并以TProjection数组的形式返回结果。

声明

public Task<TProjection[]> AggregateAsync<TProjection>(params object[] pipeline)

参数

类型	名称	说明
对象 []	管道	使用管道表达式描述不同管道阶段的文档。

返回：

类型	说明
任务<TProjection[]>	代表远程聚合操作的可等待任务。 任务的结果是一个数组，其中包含通过执行聚合pipeline返回的文档。

类型参数

名称	说明
TProjection	与管道结果的形状匹配的托管类型。

另请参阅

https://mongodb.com/zh-cn/docs/manual/aggregation/

CountAsync(对象?, long?)

计算collection中与提供的filter匹配的文档数。

声明

public Task<long> CountAsync(object? filter = null, long? limit = null)

参数

类型	名称	说明
对象	筛选器	描述使用查询运算符查找条件的文档。 如果未指定，则将计算collection中的所有文档。
long ?	limit	要计数的最大文档数。 如果未指定，则计算collection中的所有文档。

返回：

类型	说明
任务< long >	代表远程计数操作的可等待任务。 任务的结果是匹配filter和limit条件的文档数量。

DeleteManyAsync(对象?)

从collection中删除一个或多个文档。如果没有与filter匹配的文档，则不会修改collection。

声明

public Task<MongoClient.DeleteResult> DeleteManyAsync(object? filter = null)

参数

类型	名称	说明
对象	筛选器	使用查询操作符描述删除条件的文档。如果未指定，则删除collection中的所有文档。

返回：

类型	说明
任务< MongoClient 。 DeleteResult >	表示远程删除多个操作的可等待任务<TResult> 。任务结果包含已删除文档的数量。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.deleteMany/

DeleteOneAsync(对象?)

从collection中删除单个文档。如果没有与filter匹配的文档，则不会修改collection。

声明

public Task<MongoClient.DeleteResult> DeleteOneAsync(object? filter = null)

参数

类型	名称	说明
对象	筛选器	使用查询操作符描述删除条件的文档。如果未指定，则将删除collection中的第一个文档。

返回：

类型	说明
任务< MongoClient 。 DeleteResult >	表示远程删除一个操作的可等待任务<TResult> 。任务结果包含已删除文档的数量。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.deleteOne/

FindAsync(object?, object?, object?, long?)

查找集合中limit之前的所有文档。

声明

public Task<TDocument[]> FindAsync(object? filter = null, object? sort = null, object? projection = null, long? limit = null)

参数

类型	名称	说明
对象	筛选器	描述使用查询运算符查找条件的文档。 If not specified, all documents in the collection will be returned.
对象	sort	描述排序条件的文档。 如果未指定，则不保证返回文档的顺序。
对象	投影	描述要为所有匹配文档返回的字段的文档。如果未指定，则返回所有字段。
long ?	limit	要返回的最大文档数。 如果未指定，则返回collection中的所有文档。

返回：

类型	说明
任务<TDocument[]>	代表远程查找操作的可等待任务。 任务的结果是一个数组，其中包含与查找条件匹配的文档。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.find/

FindOneAndDeleteAsync(object?, object?, object?)

查找collection中满足查询条件的第一个文档。

声明

public Task<TDocument?> FindOneAndDeleteAsync(object? filter = null, object? sort = null, object? projection = null)

参数

类型	名称	说明
对象	筛选器	描述使用查询操作符查找条件的文档。如果未指定，collection中的所有文档都将匹配请求。
对象	sort	描述排序条件的文档。 如果未指定，则不保证返回文档的顺序。
对象	投影	描述要为所有匹配文档返回的字段的文档。如果未指定，则返回所有字段。

返回：

类型	说明
任务<TDocument>	表示远程查找一个操作的可等待任务<TResult> 。任务的结果是符合查找条件的第一个文档。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.findOneAndDelete/

FindOneAndReplaceAsync(object?, TDocument, object?, object?, bool, bool)

查找collection中满足查询条件的第一个文档。

声明

public Task<TDocument> FindOneAndReplaceAsync(object? filter, TDocument replacementDoc, object? sort = null, object? projection = null, bool upsert = false, bool returnNewDocument = false)

参数

类型	名称	说明
对象	筛选器	描述使用查询操作符查找条件的文档。如果未指定，collection中的所有文档都将匹配请求。
TDocument	replacementDoc	替换文档。 不能包含更新操作符表达式。
对象	sort	描述排序条件的文档。 如果未指定，则不保证返回文档的顺序。
对象	投影	描述要为所有匹配文档返回的字段的文档。如果未指定，则返回所有字段。
bool	更新插入	一个布尔值，用于控制在没有文档与filter匹配的情况下替换操作是否应插入文档。 默认为false 。 如果筛选器或替换文档中均未指定，MongoDB 会将_id字段添加到替换文档中。 如果两者都存在_id ，则这些值必须相等。
bool	returnNewDocument	控制是否返回替换文档的布尔值。 如果设置为false ，则返回更新前的原始文档。 默认为false 。

返回：

类型	说明
任务<TDocument>	表示远程查找一个操作的可等待任务<TResult> 。任务的结果是符合查找条件的第一个文档。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.findOneAndReplace/

FindOneAndUpdateAsync(object?, object, object?, object?, bool, bool)

查找collection中满足查询条件的第一个文档。

声明

public Task<TDocument> FindOneAndUpdateAsync(object? filter, object updateDocument, object? sort = null, object? projection = null, bool upsert = false, bool returnNewDocument = false)

参数

类型	名称	说明
对象	筛选器	描述使用查询操作符查找条件的文档。如果未指定，collection中的所有文档都将匹配请求。
对象	更新文档	描述更新的文档。 只能包含更新操作符表达式。
对象	sort	描述排序条件的文档。 如果未指定，则不保证返回文档的顺序。
对象	投影	描述要为所有匹配文档返回的字段的文档。如果未指定，则返回所有字段。
bool	更新插入	一个布尔值，用于控制在没有文档与filter匹配的情况下更新是否应插入文档。 默认为false 。
bool	returnNewDocument	控制是否返回新的更新文档的布尔值。 如果设置为false ，则返回更新前的原始文档。 默认为false 。

返回：

类型	说明
任务<TDocument>	表示远程查找一个操作的可等待任务<TResult> 。任务的结果是符合查找条件的第一个文档。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.findOneAndUpdate/

FindOneAsync(object?, object?, object?)

查找collection中满足查询条件的第一个文档。

声明

public Task<TDocument?> FindOneAsync(object? filter = null, object? sort = null, object? projection = null)

参数

类型	名称	说明
对象	筛选器	描述使用查询操作符查找条件的文档。如果未指定，collection中的所有文档都将匹配请求。
对象	sort	描述排序条件的文档。 如果未指定，则不保证返回文档的顺序。
对象	投影	描述要为所有匹配文档返回的字段的文档。如果未指定，则返回所有字段。

返回：

类型	说明
任务<TDocument>	表示远程查找一个操作的可等待任务<TResult> 。任务的结果是符合查找条件的第一个文档。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.findOne/

InsertManyAsync(IEnumerable<TDocument>)

在collection中插入一个或多个文档。

声明

public Task<MongoClient.InsertManyResult> InsertManyAsync(IEnumerable<TDocument> docs)

参数

类型	名称	说明
IEnumerable <TDocument>	docs	要插入的文档。

返回：

类型	说明
Task<MongoClient.InsertManyResult>	表示远程插入多个操作的可等待任务<TResult> 。任务结果包含插入文档的_id 。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.insertMany/

InsertOneAsync(TDocument)

将提供的文档插入collection中。

声明

public Task<MongoClient.InsertResult> InsertOneAsync(TDocument doc)

参数

类型	名称	说明
TDocument	doc	要插入的文档。

返回：

类型	说明
任务< MongoClient 。 InsertResult >	表示远程插入操作的可等待任务<TResult> 。任务结果包含插入文档的_id 。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.insertOne/

UpdateManyAsync(object?, object, bool)

根据指定参数更新collection中的一个或多个文档。

声明

public Task<MongoClient.UpdateResult> UpdateManyAsync(object? filter, object updateDocument, bool upsert = false)

参数

类型	名称	说明
对象	筛选器	描述更新选择标准的文档。 如果未指定，则collection中的所有文档都将被更新。只能包含查询选择器表达式。
对象	更新文档	描述更新的文档。 只能包含更新操作符表达式。
bool	更新插入	一个布尔值，用于控制在没有文档与filter匹配的情况下更新是否应插入文档。 默认为false 。

返回：

类型	说明
任务< MongoClient 。 UpdateResult >	表示远程更新操作的可等待任务<TResult> 。任务结果包含有关匹配和更新文档数量的信息，以及更新或插入文档的_id （如果upsert设置为true并且操作导致更新或插入）。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.updateMany/

UpdateOneAsync(object?, object, bool)

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

声明

public Task<MongoClient.UpdateResult> UpdateOneAsync(object? filter, object updateDocument, bool upsert = false)

参数

类型	名称	说明
对象	筛选器	描述更新选择标准的文档。 如果未指定，则将更新collection中的第一个文档。只能包含查询选择器表达式。
对象	更新文档	描述更新的文档。 只能包含更新操作符表达式。
bool	更新插入	一个布尔值，用于控制在没有文档与filter匹配的情况下更新是否应插入文档。 默认为false 。

返回：

类型	说明
任务< MongoClient 。 UpdateResult >	表示远程更新一个操作的可等待任务<TResult> 。任务结果包含有关匹配和更新文档数量的信息，以及更新或插入文档的_id （如果upsert设置为true并且操作导致更新或插入）。

另请参阅

https://mongodb.com/zh-cn/docs/manual/reference/method/db.collection.updateOne/