Class LuceneQueryOptions

Namespace

Examine.Lucene.Search

Assembly

Examine.Lucene.dll

Lucene.NET specific query options

public class LuceneQueryOptions : QueryOptions

Inheritance

object

QueryOptions

LuceneQueryOptions

Inherited Members

QueryOptions.DefaultMaxResults

QueryOptions.SkipTake(int, int?)

QueryOptions.Default

QueryOptions.Skip

QueryOptions.Take

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LuceneQueryOptions(LuceneFacetSamplingQueryOptions?, int, int?, SearchAfterOptions?, bool, bool)

Constructor

public LuceneQueryOptions(LuceneFacetSamplingQueryOptions? facetSampling, int skip, int? take, SearchAfterOptions? searchAfter, bool trackDocumentScores, bool trackDocumentMaxScore)

Parameters

facetSampling LuceneFacetSamplingQueryOptions

Whether to apply Facet sampling to improve performance. If not required, leave null

skip int

Number of result documents to skip.

take int?

Optional number of result documents to take.

searchAfter SearchAfterOptions

Optionally skip to results after the results from the previous search execution. Used for efficent deep paging.

trackDocumentScores bool

Whether to Track Document Scores. For best performance, if not needed, leave false.

trackDocumentMaxScore bool

Whether to track the maximum document score. For best performance, if not needed, leave false.

LuceneQueryOptions(int, int?, SearchAfterOptions?, bool, bool)

Constructor

[Obsolete("To remove in Examine 5.0")]
public LuceneQueryOptions(int skip, int? take = null, SearchAfterOptions? searchAfter = null, bool trackDocumentScores = false, bool trackDocumentMaxScore = false)

Parameters

skip int

Number of result documents to skip.

take int?

Optional number of result documents to take.

searchAfter SearchAfterOptions

Optionally skip to results after the results from the previous search execution. Used for efficent deep paging.

trackDocumentScores bool

Whether to Track Document Scores. For best performance, if not needed, leave false.

trackDocumentMaxScore bool

Whether to track the maximum document score. For best performance, if not needed, leave false.

Properties

FacetRandomSampling

Options for Lucene Facet Sampling. If not set, no Facet Sampling is applied.

public LuceneFacetSamplingQueryOptions? FacetRandomSampling { get; }

Property Value

LuceneFacetSamplingQueryOptions

Remarks

Performance optimization for large sets

SearchAfter

Options for Searching After. Used for efficent deep paging.

public SearchAfterOptions? SearchAfter { get; }

Property Value

SearchAfterOptions

TrackDocumentMaxScore

Whether to track the maximum document score. For best performance, if not needed, leave false.

public bool TrackDocumentMaxScore { get; }

Property Value

bool

TrackDocumentScores

Whether to Track Document Scores. For best performance, if not needed, leave false.

public bool TrackDocumentScores { get; }

Property Value

bool