vibe.db.mongo.cursor

MongoDB cursor abstraction

Copyright

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.

Authors

Sönke Ludwig

struct MongoCursor

class LegacyMongoCursorData MongoFindCursor MongoGenericCursor MongoQueryCursor

iface IMongoCursorData

Types 6

structMongoCursor(DocType = Bson)

Represents a cursor for a MongoDB query.

Use foreach( doc; cursor ) to iterate over the list of documents.

This struct uses reference counting to destroy the underlying MongoDB cursor.

Fields

private IMongoCursorData!DocType m_data

Methods

bool empty() @propertyReturns true if there are no more documents for this cursor.

DocType front() @propertyReturns the current document of the response.

MongoCursor sort(T)(T order)Controls the order in which the query returns matching documents.

MongoCursor limit(long count)Limits the number of documents that the cursor returns.

MongoCursor skip(long count)Skips a given number of elements at the beginning of the cursor.

void popFront()Advances the cursor to the next document of the response.

auto byPair()Iterates over all remaining documents.

Constructors

this(MongoClient client,  string collection,  QueryFlags flags,  int  nskip,  int  nret,  Q query,  S return_field_selector)

this(MongoClient client, string collection, long cursor, DocType[] existing_documents)

this(MongoClient client, string database, string collection, Q query, FindOptions options)

this(MongoClient client, Bson command, int batchSize = 0, Duration getMoreMaxTime = Duration.max)

Destructors

~this

private interfaceIMongoCursorData(DocType)

Actual iteration implementation details for MongoCursor. Abstracted using an interface because we still have code for legacy (<3.6) MongoDB servers, which may still used with the old legacy overloads.

Methods

bool alive() @property @safe nothrow;

bool empty() @safe

long index() @safe

DocType front() @safe

void popFront() @safe

void sort(Bson order) @safeBefore iterating, specify a MongoDB sort order

void limit(long count) @safeBefore iterating, specify maximum number of returned items

void skip(long count) @safeBefore iterating, skip the specified number of items (when sorted)

void killCursors() @safeKills the MongoDB cursor, further iteration attempts will result in errors. Call this in the destructor.

int refCount() ref @safeDefine an reference count property on the class, which is returned by reference with this method.

private classLegacyMongoCursorData(DocType) : IMongoCursorData!DocType

deprecated

Deprecated query internals exposed through MongoCursor.

Fields

private int m_refCount

private MongoClient m_client

private string m_collection

private long m_cursor

private long m_nskip

private int m_nret

private Bson m_sort

private int m_offset

private size_t m_currentDoc

private DocType[] m_documents

private bool m_iterationStarted

private long m_limit

Methods

bool alive() @property @safe nothrow

bool empty() @safe

long index() @safe

DocType front() @safe

void sort(Bson order) @safe

void limit(long count) @safe

void skip(long count) @safe

void popFront() @safe

void startIterating() @safe

void killCursors() @safe

void handleReply(long cursor, ReplyFlags flags, int first_doc, int num_docs)

void handleDocument(size_t idx, ref DocType doc)

int refCount() ref

private classMongoFindCursor(DocType) : IMongoCursorData!DocType

Find + getMore internals exposed through MongoCursor. Unifies the old LegacyMongoCursorData approach, so it can be used both for find queries and for custom commands.

Fields

private int m_refCount

private MongoClient m_client

private Bson m_findQuery

private string m_database

private string m_ns

private string m_collection

private long m_cursor

private int m_batchSize

private Duration m_maxTime

private long m_totalReceived

private size_t m_readDoc

private size_t m_insertDoc

private DocType[] m_documents

private bool m_iterationStarted

private long m_queryLimit

Methods

bool alive() @property @safe nothrow

bool empty() @safe

long index() @safe

DocType front() @safe

void sort(Bson order) @safe

void limit(long count) @safe

void skip(long count) @safe

void popFront() @safe

private void startIterating() @safe

void killCursors() @safe

void handleReply(long id, string ns, size_t count)

void handleDocument(ref DocType doc)

int refCount() ref

Constructors

this(MongoClient client, Bson command, int batchSize = 0, Duration getMoreMaxTime = Duration.max)

private classMongoQueryCursor(Q, R, S) : LegacyMongoCursorData!R

deprecated

Internal class implementing MongoCursorData for find queries

Fields

private QueryFlags m_flags

private Q m_query

private S m_returnFieldSelector

Methods

void startIterating() @safe

Constructors

this(MongoClient client,  string collection,  QueryFlags flags,  int  nskip,  int  nret,  Q query,  S return_field_selector)

private classMongoGenericCursor(DocType) : LegacyMongoCursorData!DocType

deprecated

Internal class implementing MongoCursorData for already initialized generic cursors

Methods

void startIterating() @safe

Constructors

this(MongoClient client, string collection, long cursor, DocType[] existing_documents)