$explain

Sets a special operator of $explain which, if true, explains the query instead of returning results.

This is the same as calling the explain() method on the cursor.

$hint

Sets a special operator $hint which forces the query to use a given index.

This is the same as calling hint() on the cursor.

$max

Sets maximum index bounds - commonly paired with $max

$maxScan

Sets a special operator of $maxScan Which defines the max number of items to scan.

$min

Sets minimum index bounds - commonly paired with $max

$orderby

Sets a special operator of $orderby which defines the sort spec for this cursor.

This is the same as calling sort on the cursor.

$query

Sets a special operator of $query Which defines the query for this cursor.

This is the same as running find() on a Collection with the query.

$returnKey

Sets a special operator of $returnKey If true, returns ONLY the index key. Defaults to true if you just call $returnKey

$showDiskLoc

Sets a special operator $showDiskLoc which, if true, shows the disk location of results.

$snapshot

Sets a special operator of $snapshot which, if True, sets snapshot mode on the query.

This is the same as calling the snapshot() method on the cursor.

_newInstance

Utility method which concrete subclasses are expected to implement for creating a new instance of THIS concrete implementation from a Java cursor. Good with cursor calls that return a new cursor.

"Special" Operators for cursors

adds a special operator like $maxScan or $returnKey

batchSize

Limits the number of elements returned in one batch.

close

Kill the current cursor on the server

copy

Creates a new copy of an existing database cursor. The new cursor is an iterator even if the original was an array.

count

The DBCursor's count of elements in the query, passed through from the Java object. Note that Scala Iterator[_] base trait has a count method which tests predicates and you should be careful about using that.

NOTE: count() ignores any skip/limit settings on a cursor; it is the count of the ENTIRE query results. If you want to get a count post-skip/limit you must use size()

cursorId

explain

Returns an object containing basic information about the execution of the query that created this cursor. This creates an instance of CursorExplanation which is a custom dbObject with the key/value pairs: - cursor = Cursor Type - nscanned = Number of items examined by Mongo for this query - nscannedObjects = Number of objects examined by Mongo - n = the number of records which Mongo returned - millis = how long it took Mongo to execute the query - nYields = number of times this query yielded the read lock to let writes in - indexBounds = the index boundaries used.

CursorExplanation provides utility methods to access these fields.

hasNext

Is there another element in the cursor?

<invalid inheritdoc annotation>

hint

Provide the Database a hint of an indexed field of a collection to use to improve performance.

hint

Provide the Database a hint of which indexed fields of a collection to use to improve performance.

limit

Limits the number of elements returned.

NOTE: Specifying a negative number instructs the server to retrun that number of items and close the cursor. It will only return what can fit into a single 4MB response

Set the maximum execution time for operations on this cursor.

next

Iterator increment.

TODO: The cast to T should be examined for sanity/safety.

<invalid inheritdoc annotation>

numSeen

Returns the number of objects through which this cursor has iterated, as tracked by the java driver.

Manipulate Query Options

Gets current option settings - see Bytes.QUERYOPTION_* for list

Manipulate Query Options

Adds an option - see Bytes.QUERYOPTION_* for list TODO - Create Scala version of Bytes.QUERYOPTION_*

Manipulate Query Options

Gets current option settings - see Bytes.QUERYOPTION_* for list

Manipulate Query Options

Sets current option settings - see Bytes.QUERYOPTION_* for list

Manipulate Query Options

Resets options to default.

size

The DBCursor's count of elements in the query, AFTER the application of skip/limit, passed through from the Java object.

NOTE: size() takes into account any skip/limit settings on a cursor; it is the size of just the window. If you want to get a count of the entire query ignoring skip/limit you must use count()

skip

Discards a given number of elements at the beginning of the cursor.

Use snapshot mode for the query. Snapshot mode prevents the cursor from returning a document more than once because an intervening write operation results in a move of the document. Even in snapshot mode, documents inserted or deleted during the lifetime of the cursor may or may not be returned. Currently, snapshot mode may not be used with sorting or explicit hints.

sort

Sort this cursor's elements

slaveOk

Makes this query OK to run on a non-master node.