クラス MongoClient.Collection=TDocument><TDocument>
リモート MongoDB コレクションを表すオブジェクト。
名前空間: Realm 。同期
組み立て: Realm.dll
構文
public class MongoClient.Collection<TDocument> where TDocument : class
型パラメータ
名前 | 説明 |
---|---|
TDocument | コレクション内のドキュメントの形状に一致する管理対象タイプ。 |
プロパティ
| このページを編集 ソースを表示Database
このコレクションが属するデータベースを取得します。
宣言
public MongoClient.Database? Database { get; }
プロパティ値
タイプ | 説明 |
---|---|
MongoClient .データベース | コレクションの データベース または null (データベースが MongoClient.Collection=TDocument><TDocument> で自動的に推論された場合)。 |
名前
コレクションの名前を取得します。
宣言
public string Name { get; }
プロパティ値
タイプ | 説明 |
---|---|
string | コレクション名。 |
メソッド
| このページを編集 ソースを表示AggregateAsync(Parameters object[])
コレクションに対して 集計パイプライン を実行し、その結果をMongoDB.Bson.BsonDocument配列として返します。
宣言
public Task<BsonDocument[]> AggregateAsync(params object[] pipeline)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト[] | パイプライン | パイプライン式を使用してさまざまなパイプライン ステージを説明するドキュメント。 |
戻り値
タイプ | 説明 |
---|---|
Task < BsonDocument []> | リモート集計操作を表す待機可能なタスク。 タスクの結果は、集計 |
その他の参照
| このページを編集 ソースを表示AggregateAsync<TProjection>(Parameters object[])
コレクションに対して集計パイプラインを実行し、その結果をTProjection
配列として返します。
宣言
public Task<TProjection[]> AggregateAsync<TProjection>(params object[] pipeline)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト[] | パイプライン | パイプライン式を使用してさまざまなパイプライン ステージを説明するドキュメント。 |
戻り値
タイプ | 説明 |
---|---|
タスク<TProjection[]> | リモート集計操作を表す待機可能なタスク。 タスクの結果は、集計 |
型パラメータ
名前 | 説明 |
---|---|
Tプロジェクション | パイプラインの結果の形状に一致する管理型。 |
その他の参照
| このページを編集 ソースを表示CountAsync(object?、long?)
提供されたfilter
に一致するコレクション内のドキュメントの数をカウントします。
宣言
public Task<long> CountAsync(object? filter = null, long? limit = null)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | クエリ演算子を使用して検索条件を説明するドキュメント。 指定しない場合は、コレクション内のすべてのドキュメントがカウントされます。 |
long? | limit | カウントするドキュメントの最大数。 指定しない場合、コレクション内のすべてのドキュメントがカウントされます。 |
戻り値
タイプ | 説明 |
---|---|
Task<long> | リモート カウント操作を表す待機可能なTask 。 タスクの結果は、 |
DeleteManyAsync(object?)
コレクションから 1 つ以上のドキュメントを削除します。 filter
に一致するドキュメントがない場合、コレクションは変更されません。
宣言
public Task<MongoClient.DeleteResult> DeleteManyAsync(object? filter = null)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | クエリ演算子を使用して削除条件を説明するドキュメント。 指定しない場合、コレクション内のすべてのドキュメントが削除されます。 |
戻り値
タイプ | 説明 |
---|---|
タスク< MongoClient . DeleteResult > | リモートの 削除操作 を表す 待機可能なTask<TResult>です。 タスクの結果には、削除されたドキュメントの数が含まれます。 |
その他の参照
| このページを編集 ソースを表示DeleteOneAsync(object?)
コレクションから 1 つのドキュメントを削除します。 filter
に一致するドキュメントがない場合、コレクションは変更されません。
宣言
public Task<MongoClient.DeleteResult> DeleteOneAsync(object? filter = null)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | クエリ演算子を使用して削除条件を説明するドキュメント。 指定しない場合、コレクション内の最初のドキュメントが削除されます。 |
戻り値
タイプ | 説明 |
---|---|
タスク< MongoClient . DeleteResult > | リモート 削除 1 操作を表す待機可能なTask<TResult> 。 タスクの結果には、削除されたドキュメントの数が含まれます。 |
その他の参照
| このページを編集 ソースを表示FindAsync(object?, object?, object?, long?)
コレクション内のすべてのドキュメントをlimit
まで検索します。
宣言
public Task<TDocument[]> FindAsync(object? filter = null, object? sort = null, object? projection = null, long? limit = null)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | クエリ演算子を使用して検索条件を説明するドキュメント。 指定しない場合、コレクション内のすべてのドキュメントが返されます。 |
オブジェクト | sort | ソート基準を説明するドキュメント。 指定しない場合、返されるドキュメントの順序は保証されません。 |
オブジェクト | プロジェクション | 一致するすべてのドキュメントに対して返すフィールドを説明するドキュメント。 指定しない場合、すべてのフィールドが返されます。 |
long? | limit | 返されるドキュメントの最大数。 指定しない場合、コレクション内のすべてのドキュメントが返されます。 |
戻り値
タイプ | 説明 |
---|---|
タスク<TDocument[]> | リモート検索操作を表す待機可能なタスク。 タスクの結果は、検索条件に一致するドキュメントを含む配列です。 |
その他の参照
| このページを編集 ソースを表示FindOneAndDeleteAsync(object?, object?, object?)
クエリ条件を満たすコレクション内の最初のドキュメントを検索します。
宣言
public Task<TDocument?> FindOneAndDeleteAsync(object? filter = null, object? sort = null, object? projection = null)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | クエリ演算子を使用して検索条件を説明するドキュメント。 指定しない場合は、コレクション内のすべてのドキュメントがリクエストと一致します。 |
オブジェクト | sort | ソート基準を説明するドキュメント。 指定しない場合、返されるドキュメントの順序は保証されません。 |
オブジェクト | プロジェクション | 一致するすべてのドキュメントに対して返すフィールドを説明するドキュメント。 指定しない場合、すべてのフィールドが返されます。 |
戻り値
タイプ | 説明 |
---|---|
タスク<TDocument> | リモート検索 1 回の操作を表す待機可能なTask<TResult> 。 タスクの結果は、検索条件に一致する最初のドキュメントです。 |
その他の参照
| このページを編集 ソースを表示FindOneAndReplaceAsync(object?, TDocument, object?, object?, ブール, ブール)
クエリ条件を満たすコレクション内の最初のドキュメントを検索します。
宣言
public Task<TDocument> FindOneAndReplaceAsync(object? filter, TDocument replacementDoc, object? sort = null, object? projection = null, bool upsert = false, bool returnNewDocument = false)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | クエリ演算子を使用して検索条件を説明するドキュメント。 指定しない場合は、コレクション内のすべてのドキュメントがリクエストと一致します。 |
TDocument | replacementDoc | 置換ドキュメントです。 更新演算子式 を含めることはできません。 |
オブジェクト | sort | ソート基準を説明するドキュメント。 指定しない場合、返されるドキュメントの順序は保証されません。 |
オブジェクト | プロジェクション | 一致するすべてのドキュメントに対して返すフィールドを説明するドキュメント。 指定しない場合、すべてのフィールドが返されます。 |
ブール | upsert |
|
ブール | returnNewDocument | 置換ドキュメントを返すかどうかを制御するブール値。 に設定すると、アップデートが返される前に元のドキュメントを |
戻り値
タイプ | 説明 |
---|---|
タスク<TDocument> | リモート検索 1 回の操作を表す待機可能なTask<TResult> 。 タスクの結果は、検索条件に一致する最初のドキュメントです。 |
その他の参照
| このページを編集 ソースを表示FindOneAndUpdateAsync(object?, object, object?, object?, ブール, ブール)
クエリ条件を満たすコレクション内の最初のドキュメントを検索します。
宣言
public Task<TDocument> FindOneAndUpdateAsync(object? filter, object updateDocument, object? sort = null, object? projection = null, bool upsert = false, bool returnNewDocument = false)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | クエリ演算子を使用して検索条件を説明するドキュメント。 指定しない場合は、コレクション内のすべてのドキュメントがリクエストと一致します。 |
オブジェクト | updateDocument | 更新を説明するドキュメント。 更新演算子式のみを含めることができます。 |
オブジェクト | sort | ソート基準を説明するドキュメント。 指定しない場合、返されるドキュメントの順序は保証されません。 |
オブジェクト | プロジェクション | 一致するすべてのドキュメントに対して返すフィールドを説明するドキュメント。 指定しない場合、すべてのフィールドが返されます。 |
ブール | upsert |
|
ブール | returnNewDocument | 新しいアップデートされたドキュメントを返すかどうかを制御するブール値。 に設定すると、アップデートが返される前に元のドキュメントを |
戻り値
タイプ | 説明 |
---|---|
タスク<TDocument> | リモート検索 1 回の操作を表す待機可能なTask<TResult> 。 タスクの結果は、検索条件に一致する最初のドキュメントです。 |
その他の参照
| このページを編集 ソースを表示FindOneAsync(object?, object?, object?)
クエリ条件を満たすコレクション内の最初のドキュメントを検索します。
宣言
public Task<TDocument?> FindOneAsync(object? filter = null, object? sort = null, object? projection = null)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | クエリ演算子を使用して検索条件を説明するドキュメント。 指定しない場合は、コレクション内のすべてのドキュメントがリクエストと一致します。 |
オブジェクト | sort | ソート基準を説明するドキュメント。 指定しない場合、返されるドキュメントの順序は保証されません。 |
オブジェクト | プロジェクション | 一致するすべてのドキュメントに対して返すフィールドを説明するドキュメント。 指定しない場合、すべてのフィールドが返されます。 |
戻り値
タイプ | 説明 |
---|---|
タスク<TDocument> | リモート検索 1 回の操作を表す待機可能なTask<TResult> 。 タスクの結果は、検索条件に一致する最初のドキュメントです。 |
その他の参照
| このページを編集 ソースを表示InsertManyAsync(IEnumerable<TDocument>)
コレクションに 1 つ以上のドキュメントを挿入します。
宣言
public Task<MongoClient.InsertManyResult> InsertManyAsync(IEnumerable<TDocument> docs)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
IEnumerable<TDocument> | docs | 挿入するドキュメント。 |
戻り値
タイプ | 説明 |
---|---|
Task<MongoClient.InsertManyResult> | リモート挿入の多くの操作を表す 待機可能なTask<TResult> 。 タスクの結果には、挿入されたドキュメントの |
その他の参照
| このページを編集 ソースを表示InsertOneAsync(TDocument)
指定されたドキュメントを コレクションに挿入します。
宣言
public Task<MongoClient.InsertResult> InsertOneAsync(TDocument doc)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
TDocument | doc | 挿入するドキュメント。 |
戻り値
タイプ | 説明 |
---|---|
タスク< MongoClient . InsertResult > | リモート挿入操作を表す待機可能なTask<TResult> 。 タスクの結果には、挿入されたドキュメントの |
その他の参照
| このページを編集 ソースを表示UpdateManyAsync(object?, object, ブール値)
指定された引数に従ってコレクション内の 1 つ以上のドキュメントを更新します。
宣言
public Task<MongoClient.UpdateResult> UpdateManyAsync(object? filter, object updateDocument, bool upsert = false)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | 更新の選択基準を説明するドキュメント。 指定しない場合、コレクション内のすべてのドキュメントが更新されます。 クエリ セレクター式のみを含めることができます。 |
オブジェクト | updateDocument | 更新を説明するドキュメント。 更新演算子式のみを含めることができます。 |
ブール | upsert |
|
戻り値
タイプ | 説明 |
---|---|
タスク< MongoClient . UpdateResult > | リモート更新の多くの操作を表す 待機可能なTask<TResult> 。 タスクの結果には、一致した更新されたドキュメントの数に関する情報と、 |
その他の参照
| このページを編集 ソースを表示UpdateOneAsync(object?、オブジェクト、ブール値)
指定された引数に従ってコレクション内の単一のドキュメントを更新します。
宣言
public Task<MongoClient.UpdateResult> UpdateOneAsync(object? filter, object updateDocument, bool upsert = false)
パラメーター
タイプ | 名前 | 説明 |
---|---|---|
オブジェクト | フィルター | 更新の選択基準を説明するドキュメント。 指定しない場合、コレクション内の最初のドキュメントが更新されます。 クエリ セレクター式のみを含めることができます。 |
オブジェクト | updateDocument | 更新を説明するドキュメント。 更新演算子式のみを含めることができます。 |
ブール | upsert |
|
戻り値
タイプ | 説明 |
---|---|
タスク< MongoClient . UpdateResult > | リモート更新の 1 つの操作を表す待機可能なTask<TResult> 。 タスクの結果には、一致した更新されたドキュメントの数に関する情報と、 |