Cursor (Nitrite 3.1.0 API)

All Superinterfaces:: java.lang.Iterable<Document>, RecordIterable<Document>

public interface Cursor
extends RecordIterable<Document>

An interface to iterate over database find() results. It provides a mechanism to iterate over all NitriteIds of the result.

. Example of {@link Cursor}
--
 // create/open a database
 Nitrite db = Nitrite.builder()
        .openOrCreate("user", "password");

// create a collection named - test
NitriteCollection collection = db.getCollection("test");

// returns all ids un-filtered
Cursor result = collection.find();

for (Document doc : result) {
    // use your logic with the retrieved doc here
}

To create an iterator over the documents instead of the ids, call on the Cursor.

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RecordIterable<Document>`	`join(Cursor foreignCursor, Lookup lookup)` Performs a left outer join with a foreign cursor with the specified lookup parameters.
`RecordIterable<Document>`	`project(Document projection)` Gets a lazy iterable containing all the selected keys of the result documents.

Methods inherited from interface org.dizitart.no2.RecordIterable
firstOrDefault, hasMore, size, toList, totalCount

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Interface Cursor