mongoコレクション

インターフェース MongoCollection<t>

mongo コレクションでは、特定の型の直列化でデータベースの コレクションからデータを検索および更新するためのアクセスが提供されます。

この API は、Atlas App Service 「MongoDB API」 に対応しています。 メソッドと引数の詳細については、 MongoDB API リファレンスを参照してください。

App Service リクエストへの入力引数と応答は、HTTP の直列化フレームワーク を使用して から 型 T Kotlinに直列化され、さまざまな MongoClient MongoDatabase 、 MongoCollectionEJSON ファクトリーに渡される ライザー をカスタマイズすることでカスタマイズできます。使用して複数のドキュメントを挿入できます。シリアル化の構成の詳細については、 MongoClientを参照してください。

MongoCollectionに対するすべての操作は以下をスローします。

  • 基礎となる App Service HTTP リクエストが失敗した場合の ServiceException

  • 入力引数を有効なEJSONドキュメントにシリアル化できない場合、または App Service 応答を戻り値の型に逆シリアル化できなかった場合は、 SerializationException 。

パラメーター

t

コレクションのリモート エンティティが から直列化されるデフォルトのタイプ。

プロパティ

クリップボードにコピーされたリンク
抽象 価値 name: 文字列

リモート コレクションの名前。

関数

クリップボードにコピーされたリンク
インライン中断 fun <t> MongoCollection<*>.集計(パイプライン: List < BsonDocument >): リスト<t>

リモート コレクションで 集計パイプライン を実行します。

クリップボードにコピーされたリンク
paused fun MongoCollection<*>.count(フィルター : BsonDocument ? = null limit : Long = null): Long

コレクション内のドキュメントの数を返します。

クリップボードにコピーされたリンク
paused fun MongoCollection<*>.deleteMany(フィルター: BsonDocument): Long

リモート コレクションから複数のオブジェクトを削除します。

クリップボードにコピーされたリンク
paused fun MongoCollection<*>.deleteOne(フィルター: BsonDocument): ブール値

リモート コレクションから 1 つのオブジェクトを削除します。

クリップボードにコピーされたリンク
インライン中断 fun <t> MongoCollection<t>.find(フィルター : BsonDocument ? = null プロジェクション : BsonDocument か。 = null 、 sort : BsonDocument ? = null limit : Long = null): リスト<t>

リモート コレクションから複数のオブジェクトを取得します。

クリップボードにコピーされたリンク
インライン中断 fun <t> MongoCollection<t>.findOne(フィルター: BsonDocument ? = null プロジェクション: BsonDocumentか。 = null sort : BsonDocument ? = null): t?

リモート コレクションから 1 つのオブジェクトを取得します。

クリップボードにコピーされたリンク
インライン中断 fun <t> MongoCollection<t>.findOneAndDelete(フィルター: BsonDocument プロジェクション: BsonDocumentか。 = null sort : BsonDocument ? = null): t?

リモート コレクション内の 1 つのオブジェクトを検索して削除します。

クリップボードにコピーされたリンク
インライン中断 fun <t> MongoCollection<t>.findOneAndReplace(フィルター: BsonDocument ドキュメント: BsonDocument プロジェクション: BsonDocumentか。 = null sort : BsonDocument ? = null upsert :ブール= false returnNewDoc :ブール値= false): t?

リモート コレクション内の 1 つの新しいオブジェクトを検索して置換または挿入します。

クリップボードにコピーされたリンク
インライン中断 fun <t> MongoCollection<t>.findOneAndUpdate(filter : BsonDocument update : BsonDocument プロジェクション: BsonDocumentか。 = null sort : BsonDocument ? = null upsert :ブール= false returnNewDoc :ブール値= false): t?

リモート コレクション内の 1 つの新しいオブジェクトを検索して更新または挿入します。

クリップボードにコピーされたリンク
@JvmName(name = "insertManyTyped")
インライン中断 fun <t : Any> MongoCollection<*>.insertMany(ドキュメント:コレクション< T >): リスト<Any>

オブジェクトのリストをリモート コレクションに挿入します。

クリップボードにコピーされたリンク
インライン中断 fun <t : Any> MongoCollection<t>.insertOne(ドキュメント: T): Any

リモート コレクションに単一のオブジェクトを挿入します。

クリップボードにコピーされたリンク
インライン中断 fun MongoCollection<*>.updateMany(filter : BsonDocument update : BsonDocument upsert :ブール値= false): UpdateManyResult

リモート コレクションに複数のオブジェクトを更新したり、単一の新しいオブジェクトを挿入したりします。

クリップボードにコピーされたリンク
インライン中断 fun MongoCollection<*>.updateOne(filter : BsonDocument update : BsonDocument upsert :ブール値= false): UpdateOneResult

リモート コレクション内の 1 つのオブジェクトを更新または挿入します。

クリップボードにコピーされたリンク
@試験用KBsonSerializerApi
抽象 fun <t> withDocumentClass(eJson: EJson? = null): MongoCollection<t>

デフォルト型の直列化の別のセットを持つ同じコレクションのインスタンスを取得します。