Class FindOptionsBase

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Options for a find operation.

public abstract class FindOptionsBase

Inheritance

object

FindOptionsBase

Derived

FindOptions

FindOptions<TDocument, TProjection>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FindOptionsBase()

Initializes a new instance of the FindOptionsBase class.

public FindOptionsBase()

Properties

AllowDiskUse

Gets or sets a value indicating whether the server is allowed to write to disk while executing the Find operation.

public bool? AllowDiskUse { get; set; }

Property Value

bool?

AllowPartialResults

Gets or sets a value indicating whether to allow partial results when some shards are unavailable.

public bool? AllowPartialResults { get; set; }

Property Value

bool?

BatchSize

Gets or sets the size of a batch.

public int? BatchSize { get; set; }

Property Value

int?

Collation

Gets or sets the collation.

public Collation Collation { get; set; }

Property Value

Collation

Comment

Gets or sets the comment.

public BsonValue Comment { get; set; }

Property Value

BsonValue

CursorType

Gets or sets the type of the cursor.

public CursorType CursorType { get; set; }

Property Value

CursorType

Hint

Gets or sets the hint.

public BsonValue Hint { get; set; }

Property Value

BsonValue

Let

Gets or sets the let document.

public BsonDocument Let { get; set; }

Property Value

BsonDocument

Max

Gets or sets the max key value.

public BsonDocument Max { get; set; }

Property Value

BsonDocument

MaxAwaitTime

Gets or sets the maximum await time for TailableAwait cursors.

public TimeSpan? MaxAwaitTime { get; set; }

Property Value

TimeSpan?

MaxTime

Gets or sets the maximum time.

public TimeSpan? MaxTime { get; set; }

Property Value

TimeSpan?

Min

Gets or sets the min key value.

public BsonDocument Min { get; set; }

Property Value

BsonDocument

Modifiers

Gets or sets the modifiers.

[Obsolete("Use individual properties instead.")]
public BsonDocument Modifiers { get; set; }

Property Value

BsonDocument

NoCursorTimeout

Gets or sets whether a cursor will time out.

public bool? NoCursorTimeout { get; set; }

Property Value

bool?

OplogReplay

Gets or sets whether the OplogReplay bit will be set.

[Obsolete("OplogReplay is ignored by server versions 4.4.0 and newer.")]
public bool? OplogReplay { get; set; }

Property Value

bool?

ReturnKey

Gets or sets returnKey. If true, returns only the index keys in the resulting documents.

public bool? ReturnKey { get; set; }

Property Value

bool?

ShowRecordId

Gets or sets whether the record Id should be added to the result document.

public bool? ShowRecordId { get; set; }

Property Value

bool?