FindOptions Class |
Options for finding documents.
Inheritance HierarchyNamespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
SyntaxThe FindOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FindOptions | Initializes a new instance of the FindOptions class |
Properties| Name | Description | |
|---|---|---|
 | AllowDiskUse |
Gets or sets a value indicating whether the server is allowed to write to disk while executing the Find operation.
(Inherited from FindOptionsBase.) |
| AllowPartialResults |
Gets or sets a value indicating whether to allow partial results when some shards are unavailable.
(Inherited from FindOptionsBase.) |
| BatchSize |
Gets or sets the size of a batch.
(Inherited from FindOptionsBase.) |
| Collation |
Gets or sets the collation.
(Inherited from FindOptionsBase.) |
| Comment |
Gets or sets the comment.
(Inherited from FindOptionsBase.) |
| CursorType |
Gets or sets the type of the cursor.
(Inherited from FindOptionsBase.) |
| Hint |
Gets or sets the hint.
(Inherited from FindOptionsBase.) |
| Let |
Gets or sets the let document.
(Inherited from FindOptionsBase.) |
| Max |
Gets or sets the max key value.
(Inherited from FindOptionsBase.) |
| MaxAwaitTime |
Gets or sets the maximum await time for TailableAwait cursors.
(Inherited from FindOptionsBase.) |
| MaxTime |
Gets or sets the maximum time.
(Inherited from FindOptionsBase.) |
| Min |
Gets or sets the min key value.
(Inherited from FindOptionsBase.) |
| Modifiers | Obsolete.
Gets or sets the modifiers.
(Inherited from FindOptionsBase.) |
| NoCursorTimeout |
Gets or sets whether a cursor will time out.
(Inherited from FindOptionsBase.) |
| OplogReplay | Obsolete.
Gets or sets whether the OplogReplay bit will be set.
(Inherited from FindOptionsBase.) |
| ReturnKey |
Gets or sets returnKey. If true, returns only the index keys in the resulting documents.
(Inherited from FindOptionsBase.) |
| ShowRecordId |
Gets or sets whether the record Id should be added to the result document.
(Inherited from FindOptionsBase.) |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | 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.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| 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