Class SearchOptions<TDocument>

Namespace

MongoDB.Driver.Search

Assembly

MongoDB.Driver.dll

Options for search.

public sealed class SearchOptions<TDocument>

Type Parameters

TDocument

The type of the document.

Inheritance

object

SearchOptions<TDocument>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CountOptions

Gets or sets the options for counting the search results.

public SearchCountOptions CountOptions { get; set; }

Property Value

SearchCountOptions

Highlight

Gets or sets the options for highlighting.

public SearchHighlightOptions<TDocument> Highlight { get; set; }

Property Value

SearchHighlightOptions<TDocument>

IndexName

Gets or sets the index name.

public string IndexName { get; set; }

Property Value

string

ReturnStoredSource

Gets or sets a flag that specifies whether to perform a full document lookup on the backend database or return only stored source fields directly from Atlas Search.

public bool ReturnStoredSource { get; set; }

Property Value

bool

ScoreDetails

Gets or sets a flag that specifies whether to return a detailed breakdown of the score for each document in the result.

public bool ScoreDetails { get; set; }

Property Value

bool

Sort

Gets or sets the sort specification.

public SortDefinition<TDocument> Sort { get; set; }

Property Value

SortDefinition<TDocument>

Tracking

Gets or sets the options for tracking search terms.

public SearchTrackingOptions Tracking { get; set; }

Property Value

SearchTrackingOptions