Class GridFSFindOptions<TFileId>

Namespace

MongoDB.Driver.GridFS

Assembly

MongoDB.Driver.GridFS.dll

Represents options for a GridFS Find operation.

public class GridFSFindOptions<TFileId>

Type Parameters

TFileId

The type of the file identifier.

Inheritance

object

GridFSFindOptions<TFileId>

Derived

GridFSFindOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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?

BatchSize

Gets or sets the batch size.

public int? BatchSize { get; set; }

Property Value

int?

The batch size.

Limit

Gets or sets the maximum number of documents to return.

public int? Limit { get; set; }

Property Value

int?

The maximum number of documents to return.

MaxTime

Gets or sets the maximum time the server should spend on the Find.

public TimeSpan? MaxTime { get; set; }

Property Value

TimeSpan?

The maximum time the server should spend on the Find.

NoCursorTimeout

Gets or sets whether the cursor should not timeout.

public bool? NoCursorTimeout { get; set; }

Property Value

bool?

Whether the cursor should not timeout.

Skip

Gets or sets the number of documents to skip.

public int? Skip { get; set; }

Property Value

int?

The number of documents to skip.

Sort

Gets or sets the sort order.

public SortDefinition<GridFSFileInfo<TFileId>> Sort { get; set; }

Property Value

SortDefinition<GridFSFileInfo<TFileId>>

The sort order.