class CursorOptions extends Object
Cursor Options
- Annotations
- @RawJSType() @ScalaJSDefined()
- Alphabetic
- By Inheritance
- CursorOptions
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
CursorOptions(skip: UndefOr[Int] = js.undefined, limit: UndefOr[Int] = js.undefined, sort: Any = null, hint: UndefOr[Object] = js.undefined, explain: UndefOr[Boolean] = js.undefined, snapshot: UndefOr[Boolean] = js.undefined, timeout: UndefOr[Boolean] = js.undefined, tailable: UndefOr[Boolean] = js.undefined, awaitdata: UndefOr[Boolean] = js.undefined, oplogReplay: UndefOr[Boolean] = js.undefined, batchSize: UndefOr[Int] = js.undefined, raw: UndefOr[Boolean] = js.undefined, read: UndefOr[Boolean] = js.undefined, returnKey: UndefOr[Boolean] = js.undefined, maxScan: UndefOr[Int] = js.undefined, min: UndefOr[Int] = js.undefined, max: UndefOr[Int] = js.undefined, maxTimeMS: UndefOr[Int] = js.undefined, showDiskLoc: UndefOr[Boolean] = js.undefined, comment: UndefOr[String] = js.undefined, numberOfRetries: UndefOr[Int] = js.undefined, dbName: UndefOr[String] = js.undefined, tailableRetryInterval: UndefOr[Int] = js.undefined, exhaust: UndefOr[Boolean] = js.undefined, partial: UndefOr[Boolean] = js.undefined)
- skip
the number of documents to skip.
- limit
the number of results to return. -1 has a special meaning and is used by Db.eval. A value of 1 will also be treated as if it were -1.
- sort
{Array | Object}, set to sort the documents coming back from the query. Array of indexes, 1 etc.
- hint
{Object}, hint force the query to use a specific index.
- explain
return the explaination of the query.
- snapshot
Snapshot mode assures no duplicates are returned.
- timeout
the allow the query to timeout.
- tailable
allow the cursor to be tailable.
- awaitdata
allow the cursor to wait for data, only applicable for tailable cursor.
- oplogReplay
sets an internal flag, only applicable for tailable cursor.
- batchSize
batchSize the number of the subset of results to request the database to return for every request. This should initially be greater than 1 otherwise the database will automatically close the cursor. The batch size can be set to 1 with cursorInstance.batchSize after performing the initial query to the database.
- raw
return all query documents as raw buffers (default false).
- read
specify override of read from source (primary/secondary).
- returnKey
only return the index key.
- maxScan
limit the number of items to scan.
- min
set minimum index bounds.
- max
set maximum index bounds.
- maxTimeMS
the number of miliseconds to wait before aborting the query.
- showDiskLoc
show disk location of results.
- comment
you can put a $comment field on a query to make looking in the profiler logs simpler.
- numberOfRetries
if using awaidata specifies the number of times to retry on timeout.
- dbName
override the default dbName.
- tailableRetryInterval
specify the miliseconds between getMores on tailable cursor.
- exhaust
have the server send all the documents at once as getMore packets.
- partial
have the sharded system return a partial result from mongos.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- var awaitdata: UndefOr[Boolean]
- var batchSize: UndefOr[Int]
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- var comment: UndefOr[String]
- var dbName: UndefOr[String]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- var exhaust: UndefOr[Boolean]
- var explain: UndefOr[Boolean]
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- var hint: UndefOr[Object]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- var limit: UndefOr[Int]
- var max: UndefOr[Int]
- var maxScan: UndefOr[Int]
- var maxTimeMS: UndefOr[Int]
- var min: UndefOr[Int]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- var numberOfRetries: UndefOr[Int]
- var oplogReplay: UndefOr[Boolean]
- var partial: UndefOr[Boolean]
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- var raw: UndefOr[Boolean]
- var read: UndefOr[Boolean]
- var returnKey: UndefOr[Boolean]
- var showDiskLoc: UndefOr[Boolean]
- var skip: UndefOr[Int]
- var snapshot: UndefOr[Boolean]
- var sort: Any
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- var tailable: UndefOr[Boolean]
- var tailableRetryInterval: UndefOr[Int]
- var timeout: UndefOr[Boolean]
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
valueOf(): Any
- Definition Classes
- Object
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )