classafMongo::Cursor

Use in orderBy maps to denote sort order.

Use in orderBy maps to denote sort order.

The number of documents to be returned in each response from the server.

Leave as null to use the default size.

This value can not be changed once a query has been sent to the server.

Returns the maximum number of documents this query can return. count is constant for any given query and is affected by skip or limit.

@see http://docs.mongodb.org/manual/reference/command/count/

Optional flags to set in the query.

This value can not be changed once the query has been sent to the server.

Are more documents to be returned? Use with next() to iterate over the results:

while (cursor.hasNext) {
    doc := cursor.next
    ...
}

The name of the index to use for sorting.

This value can not be changed once the query has been sent to the server.

@see http://docs.mongodb.org/manual/reference/operator/meta/hint/

A zero based index into the documents returned by the query.

cursor.count  // --> 10
cursor.skip = 2
cursor.index  // -->  2
cursor.next
cursor.index  // -->  3

Returns true if the cursor is alive on the server.

Note this returns false if a query has not yet been sent to the server.

The maximum number of documents this cursor will read.

Leave as null or set to zero to read all results from the query.

This value can not be changed once a query has been sent to the server.

Returns the next document from the query. Use with hasNext() to iterate over the results:

while (cursor.hasNext) {
    doc := cursor.next
    ...
}

If checked is true and there are no more results to return then an MongoCursorErr is thrown, else null is returned.

Use to order the query results in ascending or descending order.

If orderBy is a [Str:Obj?] map, it should be a document with field names as keys. Values may either be the standard Mongo 1 and -1 for ascending / descending or the strings ASC / DESC. Should orderBy contain more than 1 entry, it must be ordered.

Examples:

cursor.orderBy = ["age": 1]
cursor.orderBy = [:] { ordered = true }.add("name", "asc").add("age", "desc")

This value can not be changed once the query has been sent to the server.

@see http://docs.mongodb.org/manual/reference/operator/meta/orderby/

Use to alter / set which fields returned in the Mongo responses.

Set field names with a value of 1 to limit returned fields to just those mentioned. Example:

cursor.projection = [
    "fieldName1" : 1,
    "fieldName2" : 1
]

Would limit the returned fields to just _id, fieldName1, & fieldName2.

Leave as null to return all fields.

See Projection Operators for other uses.

This value can not be changed once the query has been sent to the server.

The query as used by this cursor.

The number of documents to omit, when returning the result of the query.

Leave as 0 to return all documents.

This value can not be changed once the query has been sent to the server.

Query modifiers to use. Synonymous to using _addSpecial() in the mongo shell.

This value can not be changed once the query has been sent to the server.

@see http://docs.mongodb.org/manual/reference/operator/query-modifier/

Return all remaining and unread documents as a List.

cursor.count  // --> 10
cursor.skip = 2
cursor.next
cursor.next
list := cursor.toList
list.size    // -->  6