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

オブジェクト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

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

1
String MongoCursor.toString();

戻り結果:

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

toJSON

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

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

呼び出しパラメーター:

  • key:文字列、未使用

戻り結果:

  • Value、シリアル化可能なJSONを含む値を返します