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

ObjectMongoCursor

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

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

1
String MongoCursor.toString();

返される結果:

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

toJSON

オブジェクトの JSON 形式表現を返します。通常は、オブジェクトによって定義された読み取り可能なプロパティのセットを返します

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

呼び出しパラメーター:

  • key:文字列、未使用

返される結果:

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