class Mongo::Cursor

• Mongo::Cursor
• Reference
• Object

Overview

A Cursor is a pointer to the result set of a query.

This class implements the Iterator module under the hood.

# Find is one of the methods that return a cursor.
cursor = collection.find({qty: {"$gt": 20}})
# Using `to_a` iterates the cursor until the end and stores the elements inside an `Array`.
elements = cursor.to_a
# `to_a` is one of the methods inherited from the `Iterator` module.

Included Modules

• Iterator(BSON)

Direct Known Subclasses

• Mongo::ChangeStream::Cursor

Defined in:

Instance Method Summary

• #close

  Close the cursor and frees underlying resources.

• #finalize

  Clean up the underlying resource when garbage collected.

• #next

  Returns the next element in this iterator, or Iterator::Stop::INSTANCE if there are no more elements.

• #of(type : T) forall T

  Will convert the elements to the T type while iterating the Cursor.

Instance Method Detail

# Using .of is shorter than…
wrapped_cursor = cursor.of(Type)
# …having to .map and initialize.
wrapped_cursor = cursor.map { |element| Type.from_bson(element) }