クラス MongoDBCollection<T>

Readonly データベース名

Readonly service 名

name

• get name （ ） : string

• コレクションの名前。

  string を返します

集計

• 集計(パイプライン): Promise<不明>

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

  パラメーター

  • パイプライン: Aggregate PipelineStage []

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

  Promise <不明>を返します

  集計結果に解決される Promise 。

count

• count(フィルターです。 、 オプション は ？ ) : Promise < number >

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

  注：フィルターなしでこれを呼び出すと、コレクションのメタデータに基づいて結果が返されるため、不正確なドキュメント数が表示される可能性があり、その結果、おおよそのカウントが返される場合があります。 特に、

  • シャーディングされたクラスターでは、結果のカウントで孤立したドキュメントが正しく除外されません。
  • シャットダウンを正常に行わなかった後、またはファイルのコピーによる初期同期の後は、カウントが正しくない場合があります。

  パラメーター

  • フィルター:フィルター= {}

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

  • オプション: CountOptions = {{}

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

  Promise < number >を返します

  フィルターに一致するドキュメントの数に解決される Promise 。

deleteMany

• deleteMany(フィルター?): Promise<DeleteResult>

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

  パラメーター

  • フィルター:フィルター= {}

    結果を絞り込むために適用されるフィルター。 省略した場合、デフォルトは{}になり、コレクション内のすべてのドキュメントが削除されます。

  Promise [ DeleteResult ] を 返します

  削除されたドキュメントの数を含むオブジェクトに解決される Promise（ deletedCount ）。

delete One

• delete One(フィルター?): Promise<DeleteResult>

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

  パラメーター

  • フィルター:フィルター= {}

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

  Promise [ DeleteResult ] を 返します

  削除されたドキュメントの数を含むオブジェクトに解決される Promise（ deletedCount ）。

find

• find(フィルターです。 、 オプション は ？ ） : Promise < T [] >

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

  パラメーター

  • フィルター:フィルター= {}

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

  • オプション: FindOptions = {}

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

  Promise < T [] >を返します

  見つかったドキュメントに解決される Promise 。

find One

• find One(フィルター?, options?): Promise<null | T>

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

  パラメーター

  • フィルター:フィルター= {}

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

  • オプション: FindOneOptions = {}

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

  Promise < null を返します。 T >

  見つかったドキュメントに解決される Promise 。

1 つの を検索して削除

• 1 つの を検索して削除(フィルター?, options?): Promise<null | T>

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

  パラメーター

  • フィルター:フィルター= {}

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

  • オプション: FindOneOptions = {}

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

  Promise < null を返します。 T >

  削除される前に、見つかったドキュメントに解決される Promise 。

1 つの検索と置換

• 1 つの検索と置換(フィルター 、 置換 、 オプション ） : Promise < null | T >

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

  パラメーター

  • フィルター:フィルター

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

  • 置換:不明

    新しい置換ドキュメント。

  • オプション: FindOneAndModifyOptions = {}

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

  Promise < null を返します。 T >

  置換前に見つかったドキュメントに解決される Promise 。

findOneAndUpdate

• findOneAndUpdate(filter, update, options?): Promise<null | T>

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

  パラメーター

  • フィルター:フィルター

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

  • update: Update

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

  • オプション: FindOneAndModifyOptions = {}

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

  Promise < null を返します。 T >

  アップデートを適用する前に、見つかったドキュメントに解決される Promise 。

insertMany

• insertMany(ドキュメント): Promise<InsertManyResult<t["_id"]>>

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

  パラメーター

  • ドキュメント: NewDocument < T > []

    挿入するドキュメントの配列。

  Promise < InsertManyResult < T [ "_id" ] > >を返します

  挿入された ID の配列を含むオブジェクトに解決される Promise 。（ insertedIds ）。

insertOne

• insertOne(ドキュメント): Promise<InsertOneResult<t["_id"]>>

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

  パラメーター

  • ドキュメント: NewDocument < T >

    挿入するドキュメント。

  Promise < InsertOneResult < T [ "_id" ] > >を返します

  挿入されたオブジェクト ID を含むオブジェクトを解決する Promise（ insertedId ）。

updateMany

• updateMany(filter, update, options?): Promise<UpdateResult<T["_id"]>>

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

  パラメーター

  • フィルター:フィルター

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

  • update: Update

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

  • options: UpdateOptions = {}

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

  Promise < UpdateResult < T [ "_id" ] > >を返します

  以下を含むオブジェクトに変換される Promise 。

  {
   matchedCount: number;
   modifiedCount: number;
   upsertedId: IdType | undefined;
  }
  コピー

updateOne

• updateOne(filter, update, options?): Promise<UpdateResult<T["_id"]>>

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

  パラメーター

  • フィルター:フィルター

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

  • update: Update

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

  • options: UpdateOptions = {}

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

  Promise < UpdateResult < T [ "_id" ] > >を返します

  以下を含むオブジェクトに変換される Promise 。

  {
   matchedCount: number;
   modifiedCount: number;
   upsertedId: IdType | undefined;
  }
  コピー

監視

• 監視(): AsyncGenerator<ChangeEvent<t>, any, 不明>

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

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

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

  1. fetchとReadableStreamのポリゴン（ https://www.npmjs.com/ Package/react-native-polyfill- globals
  2. 非同期ジェネレーターの構文を有効にするBagel プラグイン：https://npmjs.com/package/@babel/plugin-proposal-async-generator-functions

  AsyncGenerator < ChangeEvent < T > 、任意の 、不明な値を返します

  変更イベントの非同期ジェネレーター。

  詳細は、次を参照してください:

  https://mongodb.com/java-j/docs/manual/reference/change-events/

• 監視(options): AsyncGenerator<ChangeEvent<t>, any, 不明>

• パラメーター

  • options : {
        フィルター:未定義。
        ids : T [ "_id" ] [] ,
    }

    • Optional フィルター?: 未定義

    • ids: t["_id"][]

  AsyncGenerator < ChangeEvent < T > 、任意の 、不明な値を返します

• 監視(options): AsyncGenerator<ChangeEvent<t>, any, 不明>

• パラメーター

  • options : {
        フィルター:フィルター）
        ID :未定義。
    }

    • フィルター: フィルター

    • Optional ids?: 未定義

  AsyncGenerator < ChangeEvent < T > 、任意の 、不明な値を返します