MongoCursor Class |
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.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
SyntaxThe MongoCursor type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | 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.
|
| MongoCursor(MongoCollection, IMongoQuery, ReadConcern, ReadPreference, IBsonSerializer) |
Initializes a new instance of the MongoCursor class.
|
Properties| Name | Description | |
|---|---|---|
 | 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| Name | Description | |
|---|---|---|
 | Clone(Type) |
Creates a clone of the cursor.
|
| Clone(Type, IBsonSerializer) |
Creates a clone of the cursor.
|
| CloneTDocument |
Creates a clone of the cursor.
|
| CloneTDocument(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, ReadPreference, IBsonSerializer) | Obsolete.
Creates a cursor.
|
| Create(Type, MongoCollection, IMongoQuery, ReadConcern, ReadPreference, IBsonSerializer) | Obsolete.
Creates a cursor.
|
| CreateExplainOperation |
Creates an explain operation for this cursor.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Explain |
Returns an explanation of how the query was executed (instead of the results).
|
| Explain(Boolean) |
Returns an explanation of how the query was executed (instead of the results).
|
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IEnumerableGetEnumerator |
Gets the non-generic enumerator.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetBatchSize |
Sets the batch size (the number of documents returned per batch).
|
| SetCollation |
Sets the collation.
|
| SetFields(String) |
Sets the fields that will be returned from the server.
|
| SetFields(IMongoFields) |
Sets the fields that will be returned from the server.
|
| SetFlags |
Sets the query flags.
|
| SetHint(String) |
Sets the index hint for the query.
|
| SetHint(BsonDocument) |
Sets the index hint for the query.
|
| SetLimit |
Sets the limit on the number of documents to be returned.
|
| SetMax |
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 |
Sets the maximum await time for tailable await cursors.
|
| SetMaxScan | Obsolete.
Sets the maximum number of documents to scan.
|
| SetMaxTime |
Sets the maximum time the server should spend on this query.
|
| SetMin |
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 |
Sets a cursor option.
|
| SetOptions |
Sets multiple cursor options. See also the individual Set{Option} methods, which are easier to use.
|
| SetReadPreference |
Sets the read preference.
|
| SetSerializer |
Sets the serializer.
|
| SetShowDiskLoc |
Sets the $showDiskLoc option.
|
| SetSkip |
Sets the number of documents the server should skip before returning the rest of the documents.
|
| SetSnapshot | Obsolete.
Sets the $snapshot option.
|
| SetSortOrder(String) |
Sets the sort order for the server to sort the documents by before returning them.
|
| SetSortOrder(IMongoSortBy) |
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).
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
See Also