オブジェクト組み込みオブジェクト

オブジェクトMongoCursor

mongodb データベース データ カーソル オブジェクト

継承

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<this>MongoCursor|skip();limit();sort();hasNext();next();count();size();forEach();map();toArray();hint()] [object] <:- [MongoCursor] object toString() toJSON() MongoCursor skip() limit() sort() hasNext() next() count() size() forEach() map() toArray() hint()

メンバー関数

skip

結果を返すときにスキップするレコードの数を指定します

1
MongoCursor MongoCursor.skip(Integer num) async;

呼び出しパラメータ:

  • num: 整数、レコード数

結果を返す:

  • MongoCursor、チェーン呼び出しを容易にするためにカーソル オブジェクト自体を返します

limit

結果を返すレコードの最大数を指定します

1
MongoCursor MongoCursor.limit(Integer size) async;

呼び出しパラメータ:

  • size: 整数、レコード数

結果を返す:

  • MongoCursor、チェーン呼び出しを容易にするためにカーソル オブジェクト自体を返します

sort

返される結果の順序を設定する

1
MongoCursor MongoCursor.sort(Object opts);

呼び出しパラメータ:

  • opts: オブジェクト、ソート条件を指定

結果を返す:

  • MongoCursor、チェーン呼び出しを容易にするためにカーソル オブジェクト自体を返します

hasNext

現在のカーソルに次のレコードがあるかどうかを照会します

1
Boolean MongoCursor.hasNext();

結果を返す:

  • Boolean、レコードがあればtrueを返す

next

現在のカーソルの次のレコードを返す

1
Object MongoCursor.next();

結果を返す:

  • Object、レコード オブジェクト、レコードがない場合は null を返します

count

カーソルの総レコード数を問い合わせる

1
Integer MongoCursor.count(Boolean applySkipLimit = false);

呼び出しパラメータ:

  • applySkipLimit: ブール値、スキップおよび制限後のレコード数を照会するかどうかを指定します。デフォルトは false です。レコードの合計数を照会します

結果を返す:

  • Integer、レコードの総数を返します

size

カーソルの合計レコード数を照会する、count(true) と同等

1
Integer MongoCursor.size();

結果を返す:

  • Integer、レコードの総数を返します

forEach

すべてのレコードをトラバースし、処理関数をコールバックします

1
MongoCursor.forEach(Function func);

呼び出しパラメータ:

  • func:関数、処理関数を指定

map

全レコードをトラバースして処理結果を返す

1
Array MongoCursor.map(Function func);

呼び出しパラメータ:

  • func:関数、処理関数を指定

結果を返す:

  • Array、処理結果の配列を返します

toArray

現在のカーソルのすべてのレコードの配列を返します

1
Array MongoCursor.toArray();

結果を返す:

  • Array、すべてのデータを含む Javascript 配列を返します

hint

mongodb サーバーのデフォルトのインデックス戦略を変更し、クエリに指定されたインデックスを使用します

1
MongoCursor MongoCursor.hint(Object opts);

呼び出しパラメータ:

  • opts: オブジェクト、必須のインデックスを指定します

結果を返す:

  • MongoCursor、チェーン呼び出しを容易にするためにカーソル オブジェクト自体を返します

toString

オブジェクトの文字列表現を返します。通常は「[ネイティブ オブジェクト]」を返します。オブジェクトは独自の特性に従って再実装できます。

1
String MongoCursor.toString();

結果を返す:

  • String、オブジェクトの文字列表現を返します

toJSON

オブジェクトの JSON 形式の表現を返します。通常は、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

1
Value MongoCursor.toJSON(String key = "");

呼び出しパラメータ:

  • key: ストリング、未使用

結果を返す:

  • Value、シリアライズ可能なJSONを含む値を返します