Object 內置對象

對象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: Integer, 記錄數

返回結果:

  • MongoCursor, 返回游標對象本身便於鍊式調用

limit

指定返回結果的最大記錄數

1
MongoCursor MongoCursor.limit(Integer size) async;

調用參數:

  • size: Integer, 記錄數

返回結果:

  • MongoCursor, 返回游標對象本身便於鍊式調用

sort

設定返回結果的排序

1
MongoCursor MongoCursor.sort(Object opts);

調用參數:

  • opts: Object, 指定排序條件

返回結果:

  • MongoCursor, 返回游標對象本身便於鍊式調用

hasNext

查詢當前游標是否有下一條記錄

1
Boolean MongoCursor.hasNext();

返回結果:

  • Boolean, 有記錄則返回true

next

返回當前游標的下一條記錄

1
Object MongoCursor.next();

返回結果:

  • Object, 記錄對象,無記錄則返回null

count

查詢游標的記錄總數

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

調用參數:

  • applySkipLimit: Boolean, 指定是否查詢skip 和limit 後的記錄數,缺省為false,查詢全部記錄數

返回結果:

  • Integer, 返回記錄總數

size

查詢游標的記錄總數,相當於count(true)

1
Integer MongoCursor.size();

返回結果:

  • Integer, 返回記錄總數

forEach

遍歷全部記錄並回調處理函數

1
MongoCursor.forEach(Function func);

調用參數:

  • func: Function, 指定處理函數

map

遍歷處理全部記錄,並返回處理結果

1
Array MongoCursor.map(Function func);

調用參數:

  • func: Function, 指定處理函數

返回結果:

  • Array, 返回處理結果數組

toArray

返回當前游標全部記錄的數組

1
Array MongoCursor.toArray();

返回結果:

  • Array, 返回包含全部數據的Javascript 數組

hint

修改mongodb 服務器缺省索引策略,使用指定的索引進行查詢

1
MongoCursor MongoCursor.hint(Object opts);

調用參數:

  • opts: Object, 指定強制使用的索引

返回結果:

  • MongoCursor, 返回游標對象本身便於鍊式調用

toString

返回對象的字符串表示,一般返回"[Native Object]",對象可以根據自己的特性重新實現

1
String MongoCursor.toString();

返回結果:

  • String, 返回對象的字符串表示

toJSON

返回對象的JSON 格式表示,一般返回對象定義的可讀屬性集合

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

調用參數:

  • key: String, 未使用

返回結果:

  • Value, 返回包含可JSON 序列化的值