Class MongoCursor

Namespace: MongoDB.Driver

Assembly: MongoDB.Driver.Legacy.dll

An object that can be enumerated to fetch the results of a query. The query is not sent to the server until you begin enumerating the results.

public abstract class MongoCursor : IEnumerable

Inheritance: object

MongoCursor

Implements: IEnumerable

Derived: MongoCursor<TDocument>

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: LinqToMongo.In<TSource>(TSource, IEnumerable<TSource>)

Constructors

MongoCursor(MongoCollection, IMongoQuery, ReadConcern, ReadPreference, IBsonSerializer): Initializes a new instance of the MongoCursor class.

MongoCursor(MongoCollection, IMongoQuery, ReadPreference, IBsonSerializer): Creates a new MongoCursor. It is very unlikely that you will call this constructor. Instead, see all the Find methods in MongoCollection.

Properties

BatchSize: Gets or sets the batch size (the number of documents returned per batch).

Collation: Gets the collation.

Collection: Gets the collection that is being queried.

Database: Gets the database that constains the collection that is being queried.

Fields: Gets or sets the fields that will be returned from the server.

Flags: Gets or sets the query flags.

IsFrozen: Gets whether the cursor has been frozen to prevent further changes.

Limit: Gets or sets the limit on the number of documents to be returned.

MaxAwaitTime: Gets or sets the maximum await time for TailableAwait cursors.

Options: Gets or sets the cursor options. See also the individual Set{Option} methods, which are easier to use.

Query: Gets the query that will be sent to the server.

ReadConcern: Gets the read concern.

ReadPreference: Gets or sets the read preference.

Serializer: Gets the serializer.

Server: Gets the server that the query will be sent to.

Skip: Gets or sets the number of documents the server should skip before returning the rest of the documents.

Methods

Clone(Type): Creates a clone of the cursor.

Clone(Type, IBsonSerializer): Creates a clone of the cursor.

Clone<TDocument>(): Creates a clone of the cursor.

Clone<TDocument>(IBsonSerializer): Creates a clone of the cursor.

Count(): Returns the number of documents that match the query (ignores Skip and Limit, unlike Size which honors them).

Create(Type, MongoCollection, IMongoQuery, ReadConcern, ReadPreference, IBsonSerializer): Creates a cursor.

Create(Type, MongoCollection, IMongoQuery, ReadPreference, IBsonSerializer): Creates a cursor.

CreateExplainOperation(ExplainVerbosity): Creates an explain operation for this cursor.

Explain(): Returns an explanation of how the query was executed (instead of the results).

Explain(bool): Returns an explanation of how the query was executed (instead of the results).

IEnumerableGetEnumerator(): Gets the non-generic enumerator.

SetBatchSize(int): Sets the batch size (the number of documents returned per batch).

SetCollation(Collation): Sets the collation.

SetFields(IMongoFields): Sets the fields that will be returned from the server.

SetFields(params string[]): Sets the fields that will be returned from the server.

SetFlags(QueryFlags): Sets the query flags.

SetHint(BsonDocument): Sets the index hint for the query.

SetHint(string): Sets the index hint for the query.

SetLimit(int): Sets the limit on the number of documents to be returned.

SetMax(BsonDocument): Sets the max value for the index key range of documents to return (note: the max value itself is excluded from the range). Often combined with SetHint (if SetHint is not used the server will attempt to determine the matching index automatically).

SetMaxAwaitTime(TimeSpan?): Sets the maximum await time for tailable await cursors.

SetMaxScan(int): Sets the maximum number of documents to scan.

SetMaxTime(TimeSpan): Sets the maximum time the server should spend on this query.

SetMin(BsonDocument): Sets the min value for the index key range of documents to return (note: the min value itself is included in the range). Often combined with SetHint (if SetHint is not used the server will attempt to determine the matching index automatically).

SetOption(string, BsonValue): Sets a cursor option.

SetOptions(BsonDocument): Sets multiple cursor options. See also the individual Set{Option} methods, which are easier to use.

SetReadPreference(ReadPreference): Sets the read preference.

SetSerializer(IBsonSerializer): Sets the serializer.

SetShowDiskLoc(): Sets the $showDiskLoc option.

SetSkip(int): Sets the number of documents the server should skip before returning the rest of the documents.

SetSnapshot(): Sets the $snapshot option.

SetSortOrder(IMongoSortBy): Sets the sort order for the server to sort the documents by before returning them.

SetSortOrder(params string[]): Sets the sort order for the server to sort the documents by before returning them.

Size(): Returns the size of the result set (honors Skip and Limit, unlike Count which does not).