Click or drag to resize

FindOptionsBase Class

Options for a find operation.
Inheritance Hierarchy

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public abstract class FindOptionsBase

The FindOptionsBase type exposes the following members.

Constructors
  NameDescription
Public methodFindOptionsBase
Initializes a new instance of the FindOptionsBase 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.
Public propertyAllowPartialResults
Gets or sets a value indicating whether to allow partial results when some shards are unavailable.
Public propertyBatchSize
Gets or sets the size of a batch.
Public propertyCollation
Gets or sets the collation.
Public propertyComment
Gets or sets the comment.
Public propertyCursorType
Gets or sets the type of the cursor.
Public propertyHint
Gets or sets the hint.
Public propertyLet
Gets or sets the let document.
Public propertyMax
Gets or sets the max key value.
Public propertyMaxAwaitTime
Gets or sets the maximum await time for TailableAwait cursors.
Public propertyMaxTime
Gets or sets the maximum time.
Public propertyMin
Gets or sets the min key value.
Public propertyModifiers Obsolete.
Gets or sets the modifiers.
Public propertyNoCursorTimeout
Gets or sets whether a cursor will time out.
Public propertyOplogReplay Obsolete.
Gets or sets whether the OplogReplay bit will be set.
Public propertyReturnKey
Gets or sets returnKey. If true, returns only the index keys in the resulting documents.
Public propertyShowRecordId
Gets or sets whether the record Id should be added to the result document.
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