Realm JavaScript

Realm 。 MongoDBCollection

MongoDB database内のドキュメントのリモート コレクション。

ノード

name

コレクションの名前を取得します。

メソッド

集計（パイプライン）Promise<[object>, ...]

このコレクションに対して 集計フレームワーク パイプライン を実行します。

パラメーター:
  • パイプライン
    • タイプ: [object, ...]

    • 集計パイプライン ステージの配列。

:Promise<[object>, ...] 結果を 返します 。
count（フィルター、オプション）Promise<number>

指定されたフィルターに一致するこのコレクション内のドキュメントの数をカウントします。

パラメーター:
  • フィルター 任意
    • タイプ: object

    • 結果を絞り込むために適用される任意のフィルター。

  • options 任意
    • タイプ: object

    • 適用する追加オプション。

      • limit 任意
        • タイプ: number

        • 返されるドキュメントの最大数。

戻り値: Promise<number>
deleteMany（フィルター）Promise<DeleteResult>

複数のドキュメントを削除します。

パラメーター:
  • フィルター
    • タイプ: object

    • 結果を絞り込むために適用されるフィルター。

戻り値: Promise<DeleteResult>
deleteOne（フィルター）Promise<DeleteResult>

コレクションから一致するドキュメントを 1 つ削除します。

パラメーター:
  • フィルター
    • タイプ: object

    • 結果を絞り込むために適用されるフィルター。

戻り値: Promise<DeleteResult>
find（フィルター、オプション）Promise<[object>, ...]

指定されたクエリに一致するドキュメントを検索します。

パラメーター:
  • フィルター 任意
    • タイプ: object

    • 結果を絞り込むために適用される任意のフィルター。

  • options 任意
    • タイプ: object

    • 適用する追加オプション。

      • sort 任意
        • タイプ: object

        • 一致するドキュメントを返す順序。

      • limit 任意
        • タイプ: number

        • 返されるドキュメントの最大数。

返します: Promise<[object>, ...]ドキュメント。
findOne（フィルター、オプション）Promise<object>

指定されたフィルターに一致するドキュメントを検索します。

パラメーター:
  • フィルター 任意
    • タイプ: object

    • 結果を絞り込むために適用される任意のフィルター。

を返します: Promise<object>ドキュメント、または一致するものがない場合は null を返します。
findOneAndDelete（フィルター、オプション）Promise<object>

指定されたフィルターに一致するドキュメントを検索し、そのドキュメントを削除します

パラメーター:
  • フィルター
    • タイプ: object

    • 結果を絞り込むために適用されるフィルター。

を返します: Promise<object>ドキュメント、または一致するものがない場合は null を返します。
findOneAndReplace（フィルター、置換、オプション）Promise<?object>

指定されたフィルターに一致するドキュメントを検索し、それを新しいドキュメントに置き換えます。

パラメーター:
  • フィルター
    • タイプ: object

    • 結果を絞り込むために適用されるフィルター。

  • replacement
    • タイプ: object

    • ドキュメントの新しい値。

  • options 任意
    • タイプ: object

    • 適用する追加オプション。

      • sort 任意
        • タイプ: object

        • 一致するドキュメントを返す順序。

      • upsert 任意
        • タイプ: boolean
        • デフォルト: false

        • true の場合、クエリがコレクション内の既存のドキュメントと一致しない場合に、MongoDB がクエリフィルターに一致する新しいドキュメントを挿入する必要があることを示します。

      • returnNewDocument 任意
        • タイプ: boolean
        • デフォルト: false

        • true の場合、アクションによってドキュメントが元の更新前の形式ではなく、更新された形式で返される必要があることを示します。

返します: Promise<?object>ドキュメント（変更前または変更後）、一致するものがない場合は null を返します。
findOneAndUpdate（フィルター、アップデート、オプション）Promise<?object>

指定されたクエリに一致するドキュメントを検索し、個々のフィールドに対して必要な更新を実行します。

パラメーター:
  • フィルター
    • タイプ: object

    • 結果を絞り込むために適用されるフィルター。

  • update
    • タイプ: object

    • ドキュメントの新しい値。

  • options 任意
    • タイプ: object

    • 適用する追加オプション。

      • sort 任意
        • タイプ: object

        • 一致するドキュメントを返す順序。

      • upsert 任意
        • タイプ: boolean
        • デフォルト: false

        • true の場合、クエリがコレクション内の既存のドキュメントと一致しない場合に、MongoDB がクエリフィルターに一致する新しいドキュメントを挿入する必要があることを示します。

      • returnNewDocument 任意
        • タイプ: boolean
        • デフォルト: false

        • true の場合、アクションによってドキュメントが元の更新前の形式ではなく、更新された形式で返される必要があることを示します。

返します: Promise<?object>ドキュメント（変更前または変更後）、一致するものがない場合は null を返します。
insertMany（ドキュメント）Promise<InsertManyResult>

ドキュメントの配列をコレクションに挿入します。 値に識別子が欠落している場合、それらはサーバーによって生成されます。

パラメーター:
  • ドキュメント
    • タイプ: [object, ...]

    • ドキュメントの配列。

返します: Promise<InsertManyResult>挿入されたドキュメントの _ids。
insertOne（ドキュメント）Promise<InsertOneResult>

コレクションに単一のドキュメントを挿入します。 注: ドキュメントに _id がない場合、サーバーによって _id が生成されます。

パラメーター:
  • ドキュメント
    • タイプ: object

    • ドキュメント。

返します: Promise<InsertOneResult>挿入されたドキュメントの _id。
updateMany（フィルター、アップデート、オプション）Promise<UpdateResult>

このコレクション内の指定されたフィルターに一致する複数のドキュメントを更新します。

パラメーター:
  • フィルター
    • タイプ: object

    • 結果を絞り込むために適用されるフィルター。

  • update
    • タイプ: object

    • ドキュメントの新しい値。

  • options 任意
    • タイプ: object

    • 適用する追加オプション。

      • upsert 任意
        • タイプ: boolean
        • デフォルト: false

        • true の場合、クエリがコレクション内の既存のドキュメントと一致しない場合に、MongoDB がクエリフィルターに一致する新しいドキュメントを挿入する必要があることを示します。

      • arrayFilters 任意
        • タイプ: [object, ...]
        • デフォルト: false

        • 提供されている場合、埋め込まれた配列を更新するために使用する arrayFilters を示します。

戻り値: Promise<UpdateResult>
updateOne（フィルター、アップデート、オプション）Promise<UpdateResult>

このコレクション内の指定されたフィルターに一致する 1 つのドキュメントを更新します。

パラメーター:
  • フィルター
    • タイプ: object

    • 結果を絞り込むために適用されるフィルター。

  • update
    • タイプ: object

    • ドキュメントの新しい値。

  • options 任意
    • タイプ: object

    • 適用する追加オプション。

      • upsert 任意
        • タイプ: boolean
        • デフォルト: false

        • true の場合、クエリがコレクション内の既存のドキュメントと一致しない場合に、MongoDB がクエリフィルターに一致する新しいドキュメントを挿入する必要があることを示します。

      • arrayFilters 任意
        • タイプ: [object, ...]
        • デフォルト: false

        • 提供されている場合、埋め込まれた配列を更新するために使用する arrayFilters を示します。

戻り値: Promise<UpdateResult>
監視（オプション）ChangeEvent

このコレクションの変更を監視するために非同期変更ストリームを作成します。

デフォルトでは、 は、このコレクションのすべての変更イベントを生成します。 filterまたはidsオプションの最大で 1 つを指定できます。

重要な注意:React Native でこれを使用するには、次のコマンドをインストールする必要があります。

  1. fetch 、 ReadableStream 、 TextDecoderのポリゴン（ https://www.npmjs.com/ Package/react-native-polyfill- globals
  2. 非同期ジェネレーターの構文を有効にするBagel プラグイン：https://npmjs.com/package/@babel/plugin-proposal-async-generator-functions
パラメーター:
  • options 任意
    • タイプ: object
    • デフォルト: {}
      • フィルター 任意
        • タイプ: object

        • どの変更イベントに関連するフィルター。

      • ids 任意
        • タイプ: [any, ...]

        • 監視対象の ID のリスト

タイプの定義

ChangeEvent

変更ストリーム内のイベント。

どのプロパティが存在するかは、常に存在するoperationTypeフィールドと MongoDB サーバーのバージョンによって異なることに注意してください。

タイプ:
object
プロパティ:
  • _id

    • このイベントのオペレーターの再開トークン。

  • 操作タイプ
    • タイプ: string

    • これはどのような操作でしたか。 次の 1 つ: "insert" 、 "delete" 、 "replace" 、 "update" 、 "drop" 、 "rename" 、 "dropDatabase" 、または"invalidate"のいずれか 1 つ。

  • fullDocument
    • タイプ: object

    • この操作によって操作されたドキュメントの完全なコピー。 返されるドキュメントのバージョンの詳細については、 MongoDBリファレンス マニュアルを参照してください。

  • ns
    • タイプ: object

    • このイベントによって影響を受けるコレクションの名前空間。

      • db
        • タイプ: string

        • databaseName

      • coll
        • タイプ: string

        • コレクション名

  • 次の行動をします:
    • タイプ: object

    • "rename"イベントの宛先名前空間。

      • db
        • タイプ: string

        • databaseName

      • coll
        • タイプ: string

        • コレクション名

  • documentKey
    • タイプ: object

    • 変更されたドキュメントの_idと シャードキー 。 _idは、シャードキーの一部である場合、重複しません。

  • updateDescription
    • タイプ: object
      • UpdatedFields
        • タイプ: object

        • 変更されたフィールド名から新しい値にマッピングするオブジェクト。

      • disabledFields
        • タイプ: [string, ...]

        • 削除されたフィールド名のリスト。

  • clusterTime
    • タイプ: Timestamp

    • イベントに関連付けられた oplog エントリのタイムスタンプ。

  • txnNumber
    • タイプ: Long

    • トランザクション番号。 マルチドキュメントトランザクションの一部である場合にのみ存在します。

  • lsid
    • タイプ: object

    • トランザクションの論理セッション ID。 マルチドキュメントトランザクションの一部である場合にのみ存在します。

次を参照してください。 https://mongodb.com/java-j/docs/manual/reference/change-events/
DeleteResult

ドキュメントの削除の結果

タイプ:
object
プロパティ:
  • deleteCount
    • タイプ: number

    • 削除されたドキュメントの数。

InsertManyResult
プロパティ:
  • insertIds
    • タイプ: Array

    • 挿入されたドキュメントの ID

InsertOneResult
プロパティ:
  • insertedId

    • 挿入されたドキュメントの ID

UpdateResult

ドキュメントの更新の結果

タイプ:
object
プロパティ:
  • matchCount
    • タイプ: number

    • フィルターに一致したドキュメントの数。

  • modifiedCount
    • タイプ: number

    • クエリに一致したドキュメントの数。

  • upsertedId 任意

    • アップサート が実行された場合、挿入されたドキュメントの識別子。