パッケージ io.realm.mongodb.mongo

クラス MongoCollection=DocumentT><DocumentT>

  • 型パラメータ:
    DocumentT - このコレクションがドキュメントをエンコードし、ドキュメントをデコードするタイプ。
    public class MongoCollection<DocumentT>
extends Object
    MongoCollection インターフェースは、ドキュメントへの読み取りアクセスおよび書込みアクセスを提供します。

    コレクション インスタンスを取得するには、 MongoDatabase.getCollection(java.lang.String)を使用します。

    アクセスを可能にする前に、アクティブでログインしたユーザーが必要です。

    以下も参照してください。
    MongoDatabase

    • メソッドの詳細

      • getNamespace

        public MongoNamespace getNamespace()
        このコレクションの名前空間、つまりデータベース名とコレクション名をまとめて取得します。
        次の値を返します。
        名前空間

      • getName

        public string getName()
        このコレクションの名前を取得します
        次の値を返します。
        名称

      • getDocumentClass

        public Class<DocumentT> getDocumentClass()
        このコレクションに保存されているドキュメントのクラスを取得します。

        このコレクションを取得するために単純なMongoDatabase.getCollection(String)を使用した場合、これはDocumentです。

        次の値を返します。
        このコレクション内のドキュメントの クラス

      • getCodecRegistry

        public CodecRegistry getCodecRegistry()
        MongoCollection のコーデック レジストリを取得します。
        次の値を返します。
        このコレクションのCodecRegistry

      • withDocumentClass

        public <NewDocumentT> MongoCollection<NewDocumentT> withDocumentClass​(Class<NewDocumentT> clazz)
        データベースから返されたドキュメントをキャストする別のデフォルト クラスを持つ新しい MongoCollection インスタンスを作成します。
        型パラメータ:
        NewDocumentT - 新しいコレクションがドキュメントをエンコードし、ドキュメントをデコードするタイプ。
        パラメーター:
        clazz - データベースから返されたドキュメントがキャストされるデフォルトのクラス。
        次の値を返します。
        別のデフォルト クラスを持つ新しい MongoCollection インスタンス

      • withCodecRegistry

        public MongoCollection<DocumentT> withCodecRegistry​(CodecRegistry codecRegistry)
        別のコーデック レジストリを持つ新しい MongoCollection インスタンスを作成します。
        パラメーター:
        codecRegistry - コレクションの新しいCodecRegistry 。
        次の値を返します。
        異なるコーデック レジストリを持つ新しい MongoCollection インスタンス

      • count

        public RealmResultTask<Long> count()
        コレクション内のドキュメントの数をカウントします。
        次の値を返します。
        コレクション内のドキュメントの数を含むタスク

      • count

        public RealmResultTask<Long> count​(Bson filter)
        指定されたオプションに従ってコレクション内のドキュメントの数をカウントします。
        パラメーター:
        filter - クエリフィルター
        次の値を返します。
        コレクション内のドキュメントの数を含むタスク

      • count

        public RealmResultTask<Long> count​(Bson filter,
                                   CountOptions options)
        指定されたオプションに従ってコレクション内のドキュメントの数をカウントします。
        パラメーター:
        filter - クエリフィルター
        options - カウントを説明するオプション
        次の値を返します。
        コレクション内のドキュメントの数を含むタスク

      • findOne

        public RealmResultTask<DocumentT> findOne()
        コレクション内のドキュメントを検索します。
        次の値を返します。
        1 つの検索操作の結果を含むタスク

      • findOne

        public <ResultT> RealmResultTask<ResultT> findOne​(Class<ResultT> resultClass)
        コレクション内のドキュメントを検索します。
        型パラメータ:
        ResultT - ターゲットのドキュメントの種類
        パラメーター:
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        1 つの検索操作の結果を含むタスク

      • findOne

        public RealmResultTask<DocumentT> findOne​(Bson filter)
        コレクション内のドキュメントを検索します。
        パラメーター:
        filter - クエリフィルター
        次の値を返します。
        1 つの検索操作の結果を含むタスク

      • findOne

        public <ResultT> RealmResultTask<ResultT> findOne​(Bson filter,
                                                  Class<ResultT> resultClass)
        コレクション内のドキュメントを検索します。
        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        1 つの検索操作の結果を含むタスク

      • findOne

        public RealmResultTask<DocumentT> findOne​(Bson filter,
                                          FindOptions options)
        コレクション内のドキュメントを検索します。
        パラメーター:
        filter - クエリフィルター
        options - FindOptions構造体
        次の値を返します。
        1 つの検索操作の結果を含むタスク

      • findOne

        public <ResultT> RealmResultTask<ResultT> findOne​(Bson filter,
                                                  FindOptions options,
                                                  Class<ResultT> resultClass)
        コレクション内のドキュメントを検索します。
        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        options - FindOptions構造体
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        1 つの検索操作の結果を含むタスク

      • find

        public FindIterable<DocumentT> find()
        コレクション内のすべてのドキュメントを検索します。

        すべてのドキュメントはFindIterableの形式で配信され、個々の要素を抽出できます。

        次の値を返します。
        検索操作の結果を含む イテラブル

      • find

        public FindIterable<DocumentT> find​(FindOptions options)
        FindOptionsを使用してクエリを構築し、 コレクション内のすべてのドキュメントを検索します。

        すべてのドキュメントはFindIterableの形式で配信され、個々の要素を抽出できます。

        パラメーター:
        options - クエリを構築するためのFindOptions構造体
        次の値を返します。
        検索操作の結果を含む イテラブル

      • find

        public <ResultT> FindIterable<ResultT> find​(Class<ResultT> resultClass)
        出力クラスを指定する コレクション内のすべてのドキュメントを検索します。

        すべてのドキュメントはFindIterableの形式で配信され、個々の要素を抽出できます。

        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        検索操作の結果を含む イテラブル

      • find

        public <ResultT> FindIterable<ResultT> find​(Class<ResultT> resultClass,
                                            FindOptions options)
        出力クラスを指定し、 FindOptionsを使用してクエリを構築するコレクション内のすべてのドキュメントを検索します。

        すべてのドキュメントはFindIterableの形式で配信され、個々の要素を抽出できます。

        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        resultClass - 各ドキュメントをデコードするクラス
        options - クエリを構築するためのFindOptions構造体
        次の値を返します。
        検索操作の結果を含む イテラブル

      • find

        public FindIterable<DocumentT> find​(Bson filter)
        指定されたフィルターに一致するコレクション内のすべてのドキュメントを検索します。

        すべてのドキュメントはFindIterableの形式で配信され、個々の要素を抽出できます。

        パラメーター:
        filter - クエリフィルター
        次の値を返します。
        検索操作の結果を含む イテラブル

      • find

        public FindIterable<DocumentT> find​(Bson filter,
                                    FindOptions options)
        FindOptionsを使用してクエリを構築し、指定されたフィルターに一致するコレクション内のすべてのドキュメントを検索します。

        すべてのドキュメントはFindIterableの形式で配信され、個々の要素を抽出できます。

        パラメーター:
        filter - クエリフィルター
        options - FindOptions構造体
        次の値を返します。
        検索操作の結果を含む イテラブル

      • find

        public <ResultT> FindIterable<ResultT> find​(Bson filter,
                                            Class<ResultT> resultClass)
        出力クラスを指定する指定フィルターに一致するコレクション内のすべてのドキュメントを検索します。

        すべてのドキュメントはFindIterableの形式で配信され、個々の要素を抽出できます。

        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        検索操作の結果を含む イテラブル

      • find

        public <ResultT> FindIterable<ResultT> find​(Bson filter,
                                            Class<ResultT> resultClass,
                                            FindOptions options)
        出力クラスを指定し、 FindOptionsを使用してクエリを構築し、指定されたフィルターに一致するコレクション内のすべてのドキュメントを検索します。

        すべてのドキュメントはFindIterableの形式で配信され、個々の要素を抽出できます。

        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        resultClass - 各ドキュメントをデコードするクラス
        options - FindOptions構造体
        次の値を返します。
        検索操作の結果を含む イテラブル

      • 集計

        public AggregateIterable<DocumentT> aggregate​(List<? extends Bson> pipeline)
        指定された 集計パイプライン に従ってドキュメントを集計します。

        すべてのドキュメントはAggregateIterableの形式で配信され、個々の要素を抽出できます。

        パラメーター:
        pipeline - 集計パイプライン
        次の値を返します。
        結果を抽出できるAggregateIterable

      • 集計

        public <ResultT> AggregateIterable<ResultT> aggregate​(List<? extends Bson> pipeline,
                                                      Class<ResultT> resultClass)
        出力クラスを指定する、指定された 集計パイプライン に従ってドキュメントを集計します。

        すべてのドキュメントはAggregateIterableの形式で配信され、個々の要素を抽出できます。

        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        pipeline - 集計パイプライン
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        結果を抽出できるAggregateIterable

      • insertOne

        public RealmResultTask<InsertOneResult> insertOne​(DocumentT document)
        指定されたドキュメントを挿入します。 ドキュメントに識別子がない場合、クライアントは識別子を生成する必要があります。
        パラメーター:
        document - 挿入するドキュメント
        次の値を返します。
        挿入 1 操作の結果を含むタスク

      • insertMany

        public RealmResultTask<InsertManyResult> insertMany​(List<? extends DocumentT> documents)
        1 つ以上のドキュメントを挿入します。
        パラメーター:
        documents - 挿入するドキュメント
        次の値を返します。
        多数の挿入操作の結果を含むタスク

      • deleteOne

        public RealmResultTask<DeleteResult> deleteOne​(Bson filter)
        指定されたフィルターに一致するドキュメントをコレクションから最大 1 つ削除します。 一致するドキュメントがない場合、コレクションは変更されません。
        パラメーター:
        filter - 削除操作を適用するためのクエリフィルター
        次の値を返します。
        1 回の削除操作の結果を含むタスク

      • deleteMany

        public RealmResultTask<DeleteResult> deleteMany​(Bson filter)
        指定されたクエリフィルターに一致するすべてのドキュメントをコレクションから削除します。 一致するドキュメントがない場合、コレクションは変更されません。
        パラメーター:
        filter - 削除操作を適用するためのクエリフィルター
        次の値を返します。
        多数の削除操作の結果を含むタスク

      • updateOne

        public RealmResultTask<UpdateResult> updateOne​(Bson filter,
                                               Bson update)
        指定された引数に従ってコレクション内の単一のドキュメントを更新します。
        パラメーター:
        filter - クエリフィルターを説明するドキュメント。null でない場合があります。
        update - アップデートを説明するドキュメント。nullでない場合もあります。 適用する更新には、 更新演算子 のみを含める必要があります。
        次の値を返します。
        1 回の更新操作の結果を含むタスク

      • updateOne

        public RealmResultTask<UpdateResult> updateOne​(Bson filter,
                                               Bson update,
                                               UpdateOptions updateOptions)
        指定された引数に従ってコレクション内の単一のドキュメントを更新します。
        パラメーター:
        filter - クエリフィルターを説明するドキュメント。null でない場合があります。
        update - アップデートを説明するドキュメント。nullでない場合もあります。 適用する更新には、 更新演算子 のみを含める必要があります。
        updateOptions - 更新操作に適用するオプション
        次の値を返します。
        1 回の更新操作の結果を含むタスク

      • updateMany

        public RealmResultTask<UpdateResult> updateMany​(Bson filter,
                                                Bson update)
        指定された引数に従ってコレクション内のすべてのドキュメントを更新します。
        パラメーター:
        filter - クエリフィルターを説明するドキュメント。null でない場合があります。
        update - アップデートを説明するドキュメント。nullでない場合もあります。 適用する更新には、 更新演算子 のみを含める必要があります。
        次の値を返します。
        多数の更新操作の結果を含むタスク

      • updateMany

        public RealmResultTask<UpdateResult> updateMany​(Bson filter,
                                                Bson update,
                                                UpdateOptions updateOptions)
        指定された引数に従ってコレクション内のすべてのドキュメントを更新します。
        パラメーター:
        filter - クエリフィルターを説明するドキュメント。null でない場合があります。
        update - アップデートを説明するドキュメント。nullでない場合もあります。 適用する更新には、 更新演算子 のみを含める必要があります。
        updateOptions - 更新操作に適用するオプション
        次の値を返します。
        多数の更新操作の結果を含むタスク

      • findOneAndUpdate

        public RealmResultTask<DocumentT> findOneAndUpdate​(Bson filter,
                                                   Bson update)
        コレクション内のドキュメントを検索し、指定された更新を実行します。
        パラメーター:
        filter - クエリフィルター
        update - 更新ドキュメント
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndUpdate

        public <ResultT> RealmResultTask<ResultT> findOneAndUpdate​(Bson filter,
                                                           Bson update,
                                                           Class<ResultT> resultClass)
        コレクション内のドキュメントを検索し、指定された更新を実行します。
        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        update - 更新ドキュメント
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndUpdate

        public RealmResultTask<DocumentT> findOneAndUpdate​(Bson filter,
                                                   Bson update,
                                                   FindOneAndModifyOptions options)
        コレクション内のドキュメントを検索し、指定された更新を実行します。
        パラメーター:
        filter - クエリフィルター
        update - 更新ドキュメント
        options - FindOneAndModifyOptions構造体
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndUpdate

        public <ResultT> RealmResultTask<ResultT> findOneAndUpdate​(Bson filter,
                                                           Bson update,
                                                           FindOneAndModifyOptions options,
                                                           Class<ResultT> resultClass)
        コレクション内のドキュメントを検索し、指定された更新を実行します。
        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        update - 更新ドキュメント
        options - FindOneAndModifyOptions構造体
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndReplace

        public RealmResultTask<DocumentT> findOneAndReplace​(Bson filter,
                                                    Bson replacement)
        コレクション内のドキュメントを検索し、指定されたドキュメントに置き換えます。
        パラメーター:
        filter - クエリフィルター
        replacement - 一致したドキュメントを置き換えるドキュメント
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndReplace

        public <ResultT> RealmResultTask<ResultT> findOneAndReplace​(Bson filter,
                                                            Bson replacement,
                                                            Class<ResultT> resultClass)
        コレクション内のドキュメントを検索し、指定されたドキュメントに置き換えます。
        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        replacement - 一致したドキュメントを置き換えるドキュメント
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndReplace

        public RealmResultTask<DocumentT> findOneAndReplace​(Bson filter,
                                                    Bson replacement,
                                                    FindOneAndModifyOptions options)
        コレクション内のドキュメントを検索し、指定されたドキュメントに置き換えます。
        パラメーター:
        filter - クエリフィルター
        replacement - 一致したドキュメントを置き換えるドキュメント
        options - FindOneAndModifyOptions構造体
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndReplace

        public <ResultT> RealmResultTask<ResultT> findOneAndReplace​(Bson filter,
                                                            Bson replacement,
                                                            FindOneAndModifyOptions options,
                                                            Class<ResultT> resultClass)
        コレクション内のドキュメントを検索し、指定されたドキュメントに置き換えます。
        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        replacement - 一致したドキュメントを置き換えるドキュメント
        options - FindOneAndModifyOptions構造体
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndDelete

        public RealmResultTask<DocumentT> findOneAndDelete​(Bson filter)
        コレクション内のドキュメントを検索して削除します。
        パラメーター:
        filter - クエリフィルター
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndDelete

        public <ResultT> RealmResultTask<ResultT> findOneAndDelete​(Bson filter,
                                                           Class<ResultT> resultClass)
        コレクション内のドキュメントを検索して削除します。
        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        結果ドキュメントを含むタスク

      • findOneAndDelete

        public <ResultT> RealmResultTask<ResultT> findOneAndDelete​(Bson filter,
                                                           FindOneAndModifyOptions options,
                                                           Class<ResultT> resultClass)
        コレクション内のドキュメントを検索して削除します。
        型パラメータ:
        ResultT - イテラブルのターゲット ドキュメントの種類。
        パラメーター:
        filter - クエリフィルター
        options - FindOneAndModifyOptions構造体
        resultClass - 各ドキュメントをデコードするクラス
        次の値を返します。
        結果ドキュメントを含むタスク

      • 監視

        public RealmEventStreamTask<DocumentT> watch()
        コレクションを監視します。 結果のストリームには、構成された MongoDB Realm ルールに基づいて参照する権限を持つこのコレクションのすべてのイベントが通知されます。
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。

      • 監視

        public RealmEventStreamTask<DocumentT> watch​(BsonValue... ids)
        コレクション内の指定された ID を監視します。
        パラメーター:
        ids - 監視する ID。
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。

      • 監視

        public RealmEventStreamTask<DocumentT> watch​(ObjectId... ids)
        コレクション内の指定された ID を監視します。 この便利なオーバーロードは、ユーザーの インスタンスでラップすることで、BsonValue のObjectId BsonObjectId以外のインスタンスのユースケースをサポートします。
        パラメーター:
        ids - 監視する ID の一意のオブジェクト識別子。
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。

      • watchWithFilter

        public RealmEventStreamTask<DocumentT> watchWithFilter​(Document matchFilter)
        コレクションを監視します。 指定されたドキュメントは、ストリームから取得される変更イベントのマッチ式フィルターとして使用されます。 この便利なオーバーロードは、ユーザーのBsonDocument以外の インスタンスの使用をサポートします。

        一致フィルターの定義方法 を参照してください。

        ChangeEvents をフィルタリングするためにマッチ式を定義する方法は、 triggerのマッチ式を定義する方法と同様です。

        パラメーター:
        matchFilter - 受信変更イベントに適用する $match フィルター
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。

      • watchWithFilter

        public RealmEventStreamTask<DocumentT> watchWithFilter​(BsonDocument matchFilter)
        コレクションを監視します。 提供された BSON ドキュメントは、ストリームから取得される変更イベントのマッチ式フィルターとして使用されます。

        一致フィルターの定義方法 を参照してください。

        ChangeEvents をフィルタリングするためにマッチ式を定義する方法は、 triggerのマッチ式を定義する方法と同様です。

        パラメーター:
        matchFilter - 受信変更イベントに適用する $match フィルター
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。

      • watchAsync

        public RealmEventStreamAsyncTask<DocumentT> watchAsync()
        コレクションを非同期に監視します。 結果のストリームには、構成された MongoDB Realm ルールに基づいて参照する権限を持つこのコレクションのすべてのイベントが通知されます。
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。

      • watchAsync

        public RealmEventStreamAsyncTask<DocumentT> watchAsync​(BsonValue... ids)
        コレクション内の指定された ID を非同期に監視します。
        パラメーター:
        ids - 監視する ID。
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。

      • watchAsync

        public RealmEventStreamAsyncTask<DocumentT> watchAsync​(ObjectId... ids)
        コレクション内の指定された ID を非同期に監視します。 この便利なオーバーロードは、ユーザーの インスタンスでラップすることで、BsonValue のObjectId BsonObjectId以外のインスタンスのユースケースをサポートします。
        パラメーター:
        ids - 監視する ID の一意のオブジェクト識別子。
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。

      • watchWithFilterAsync

        public RealmEventStreamAsyncTask<DocumentT> watchWithFilterAsync​(Document matchFilter)
        コレクションを非同期に監視します。 指定されたドキュメントは、ストリームから取得される変更イベントのマッチ式フィルターとして使用されます。 この便利なオーバーロードは、ユーザーのBsonDocument以外の インスタンスの使用をサポートします。

        一致フィルターの定義方法 を参照してください。

        ChangeEvents をフィルタリングするためにマッチ式を定義する方法は、 triggerのマッチ式を定義する方法と同様です。

        パラメーター:
        matchFilter - 受信変更イベントに適用する $match フィルター
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。

      • watchWithFilterAsync

        public RealmEventStreamAsyncTask<DocumentT> watchWithFilterAsync​(BsonDocument matchFilter)
        コレクションを非同期に監視します。 提供された BSON ドキュメントは、ストリームから取得される変更イベントのマッチ式フィルターとして使用されます。

        一致フィルターの定義方法 を参照してください。

        ChangeEvents をフィルタリングするためにマッチ式を定義する方法は、 triggerのマッチ式を定義する方法と同様です。

        パラメーター:
        matchFilter - 受信変更イベントに適用する $match フィルター
        次の値を返します。
        変更イベントのストリームへのアクセスを提供するタスク。