Click or drag to resize

FindOptions Class

Options for finding documents.
Inheritance Hierarchy

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax
public class FindOptions : FindOptionsBase

The FindOptions type exposes the following members.

Constructors
  NameDescription
Public methodFindOptions
Initializes a new instance of the FindOptions class
Top
Properties
  NameDescription
Public propertyAllowDiskUse
Gets or sets a value indicating whether the server is allowed to write to disk while executing the Find operation.
(Inherited from FindOptionsBase.)
Public propertyAllowPartialResults
Gets or sets a value indicating whether to allow partial results when some shards are unavailable.
(Inherited from FindOptionsBase.)
Public propertyBatchSize
Gets or sets the size of a batch.
(Inherited from FindOptionsBase.)
Public propertyCollation
Gets or sets the collation.
(Inherited from FindOptionsBase.)
Public propertyComment
Gets or sets the comment.
(Inherited from FindOptionsBase.)
Public propertyCursorType
Gets or sets the type of the cursor.
(Inherited from FindOptionsBase.)
Public propertyHint
Gets or sets the hint.
(Inherited from FindOptionsBase.)
Public propertyLet
Gets or sets the let document.
(Inherited from FindOptionsBase.)
Public propertyMax
Gets or sets the max key value.
(Inherited from FindOptionsBase.)
Public propertyMaxAwaitTime
Gets or sets the maximum await time for TailableAwait cursors.
(Inherited from FindOptionsBase.)
Public propertyMaxTime
Gets or sets the maximum time.
(Inherited from FindOptionsBase.)
Public propertyMin
Gets or sets the min key value.
(Inherited from FindOptionsBase.)
Public propertyModifiers Obsolete.
Gets or sets the modifiers.
(Inherited from FindOptionsBase.)
Public propertyNoCursorTimeout
Gets or sets whether a cursor will time out.
(Inherited from FindOptionsBase.)
Public propertyOplogReplay Obsolete.
Gets or sets whether the OplogReplay bit will be set.
(Inherited from FindOptionsBase.)
Public propertyReturnKey
Gets or sets returnKey. If true, returns only the index keys in the resulting documents.
(Inherited from FindOptionsBase.)
Public propertyShowRecordId
Gets or sets whether the record Id should be added to the result document.
(Inherited from FindOptionsBase.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also