MongoCursorTDocument 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
SyntaxType Parameters
- TDocument
- The type of the documents returned.
The MongoCursorTDocument type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MongoCursorTDocument(MongoCollection, IMongoQuery, ReadPreference, IBsonSerializer) | Obsolete.
Creates a new MongoCursor. It is very unlikely that you will call this constructor. Instead, see all the Find methods in MongoCollection.
|
| MongoCursorTDocument(MongoCollection, IMongoQuery, ReadConcern, ReadPreference, IBsonSerializer) | Obsolete.
Initializes a new instance of the MongoCursorTDocument class.
|
Properties| Name | Description | |
|---|---|---|
 | BatchSize |
Gets or sets the batch size (the number of documents returned per batch).
(Inherited from MongoCursor.) |
| Collation |
Gets the collation.
(Inherited from MongoCursor.) |
| Collection |
Gets the collection that is being queried.
(Inherited from MongoCursor.) |
| Database |
Gets the database that constains the collection that is being queried.
(Inherited from MongoCursor.) |
| Fields |
Gets or sets the fields that will be returned from the server.
(Inherited from MongoCursor.) |
| Flags |
Gets or sets the query flags.
(Inherited from MongoCursor.) |
| IsFrozen |
Gets whether the cursor has been frozen to prevent further changes.
(Inherited from MongoCursor.) |
| Limit |
Gets or sets the limit on the number of documents to be returned.
(Inherited from MongoCursor.) |
| MaxAwaitTime |
Gets or sets the maximum await time for TailableAwait cursors.
(Inherited from MongoCursor.) |
| Options |
Gets or sets the cursor options. See also the individual Set{Option} methods, which are easier to use.
(Inherited from MongoCursor.) |
| Query |
Gets the query that will be sent to the server.
(Inherited from MongoCursor.) |
| ReadConcern |
Gets the read concern.
(Inherited from MongoCursor.) |
| ReadPreference |
Gets or sets the read preference.
(Inherited from MongoCursor.) |
| Serializer |
Gets the serializer.
|
| Server |
Gets the server that the query will be sent to.
(Inherited from MongoCursor.) |
| Skip |
Gets or sets the number of documents the server should skip before returning the rest of the documents.
(Inherited from MongoCursor.) |
Methods| Name | Description | |
|---|---|---|
| Clone(Type) |
Creates a clone of the cursor.
(Inherited from MongoCursor.) |
| Clone(Type, IBsonSerializer) |
Creates a clone of the cursor.
(Inherited from MongoCursor.) |
| CloneTDocument |
Creates a clone of the cursor.
(Inherited from MongoCursor.) |
| CloneTDocument(IBsonSerializer) |
Creates a clone of the cursor.
(Inherited from MongoCursor.) |
| Count |
Returns the number of documents that match the query (ignores Skip and Limit, unlike Size which honors them).
(Inherited from MongoCursor.) |
 | CreateExplainOperation |
Creates an explain operation for this cursor.
(Overrides MongoCursorCreateExplainOperation(ExplainVerbosity).) |
| 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).
(Inherited from MongoCursor.) |
| Explain(Boolean) |
Returns an explanation of how the query was executed (instead of the results).
(Inherited from MongoCursor.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that can be used to enumerate the cursor. Normally you will use the foreach statement
to enumerate the cursor (foreach will call GetEnumerator for you).
|
| 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.
(Overrides MongoCursorIEnumerableGetEnumerator.) |
| 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(IBsonSerializer) |
Sets the serializer.
(Inherited from MongoCursor.) |
| SetSerializer(IBsonSerializerTDocument) |
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).
(Inherited from MongoCursor.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AllElementsTDocument |
Represents all elements in an array (corresponds to the server's "$[]" update operator).
(Defined by MongoEnumerable.) |
| AllMatchingElementsTDocument |
Represents all matching elements in an array when using an array filter (corresponds to the server's "$[identifier]" update operator).
(Defined by MongoEnumerable.) |
| BottomTDocument, TResult |
Returns the bottom result.
(Defined by MongoEnumerable.) |
| BottomNTDocument, TResult(SortDefinitionTDocument, FuncTDocument, TResult, Int32) | Overloaded.
Returns the bottom n results.
(Defined by MongoEnumerable.) |
| BottomNTDocument, TKey, TResult(SortDefinitionTDocument, FuncTDocument, TResult, TKey, FuncTKey, Int32) | Overloaded.
Returns the bottom n results.
(Defined by MongoEnumerable.) |
| ContainsAllTDocument |
Determines whether a sequence contains all of the specified values.
(Defined by LinqToMongo.) |
| ContainsAnyTDocument |
Determines whether a sequence contains any of the specified values.
(Defined by LinqToMongo.) |
| FirstMatchingElementTDocument |
Represents the first matching element in an array used in a query (corresponds to the server's "$" update operator).
(Defined by MongoEnumerable.) |
| FirstNTDocument, TResult(FuncTDocument, TResult, Int32) | Overloaded.
Returns the first n results.
(Defined by MongoEnumerable.) |
| FirstNTDocument, TKey, TResult(FuncTDocument, TResult, TKey, FuncTKey, Int32) | Overloaded.
Returns the first n results.
(Defined by MongoEnumerable.) |
| LastNTDocument, TResult(FuncTDocument, TResult, Int32) | Overloaded.
Returns the last n results.
(Defined by MongoEnumerable.) |
| LastNTDocument, TKey, TResult(FuncTDocument, TResult, TKey, FuncTKey, Int32) | Overloaded.
Returns the last n results.
(Defined by MongoEnumerable.) |
| MaxNTDocument, TResult(FuncTDocument, TResult, Int32) | Overloaded.
Returns the max n results.
(Defined by MongoEnumerable.) |
| MaxNTDocument, TKey, TResult(FuncTDocument, TResult, TKey, FuncTKey, Int32) | Overloaded.
Returns the max n results.
(Defined by MongoEnumerable.) |
| MinNTDocument, TResult(FuncTDocument, TResult, Int32) | Overloaded.
Returns the min n results.
(Defined by MongoEnumerable.) |
| MinNTDocument, TKey, TResult(FuncTDocument, TResult, TKey, FuncTKey, Int32) | Overloaded.
Returns the min n results.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, Int32) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, NullableInt32) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, Int64) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, NullableInt64) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, Single) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, NullableSingle) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, Double) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, NullableDouble) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, Decimal) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationPopulationTDocument(FuncTDocument, NullableDecimal) | Overloaded.
Computes the population standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, Int32) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, NullableInt32) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, Int64) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, NullableInt64) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, Single) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, NullableSingle) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, Double) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, NullableDouble) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, Decimal) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| StandardDeviationSampleTDocument(FuncTDocument, NullableDecimal) | Overloaded.
Computes the sample standard deviation of a sequence of values that are obtained by invoking a transform function on each element of the input sequence.
(Defined by MongoEnumerable.) |
| 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.) |
| TopTDocument, TResult |
Returns the top n results.
(Defined by MongoEnumerable.) |
| TopNTDocument, TResult(SortDefinitionTDocument, FuncTDocument, TResult, Int32) | Overloaded.
Returns the top n results.
(Defined by MongoEnumerable.) |
| TopNTDocument, TKey, TResult(SortDefinitionTDocument, FuncTDocument, TResult, TKey, FuncTKey, Int32) | Overloaded.
Returns the top n results.
(Defined by MongoEnumerable.) |
| WhereTDocument |
Filters a sequence of values based on a predicate and limits the number of results.
(Defined by MongoEnumerable.) |
See Also