Class SearchSpanDefinitionBuilder<TDocument>

Namespace

MongoDB.Driver.Search

Assembly

MongoDB.Driver.dll

A builder for a span clause.

public sealed class SearchSpanDefinitionBuilder<TDocument>

Type Parameters

TDocument

The type of the document.

Inheritance

object

SearchSpanDefinitionBuilder<TDocument>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

First(SearchSpanDefinition<TDocument>, int)

Creates a span clause that matches near the beginning of the string.

public SearchSpanDefinition<TDocument> First(SearchSpanDefinition<TDocument> @operator, int endPositionLte)

Parameters

operator SearchSpanDefinition<TDocument>

The span operator.

endPositionLte int

The highest position in which to match the query.

Returns

SearchSpanDefinition<TDocument>

A first span clause.

Near(IEnumerable<SearchSpanDefinition<TDocument>>, int, bool)

Creates a span clause that matches multiple string found near each other.

public SearchSpanDefinition<TDocument> Near(IEnumerable<SearchSpanDefinition<TDocument>> clauses, int slop, bool inOrder = false)

Parameters

clauses IEnumerable<SearchSpanDefinition<TDocument>>

The clauses.

slop int

The allowable distance between words in the query phrase.

inOrder bool

Whether to require that the clauses appear in the specified order.

Returns

SearchSpanDefinition<TDocument>

A near span clause.

Or(params SearchSpanDefinition<TDocument>[])

Creates a span clause that matches any of its subclauses.

public SearchSpanDefinition<TDocument> Or(params SearchSpanDefinition<TDocument>[] clauses)

Parameters

clauses SearchSpanDefinition<TDocument>[]

The clauses.

Returns

SearchSpanDefinition<TDocument>

An or span clause.

Or(IEnumerable<SearchSpanDefinition<TDocument>>)

Creates a span clause that matches any of its subclauses.

public SearchSpanDefinition<TDocument> Or(IEnumerable<SearchSpanDefinition<TDocument>> clauses)

Parameters

clauses IEnumerable<SearchSpanDefinition<TDocument>>

The clauses.

Returns

SearchSpanDefinition<TDocument>

An or span clause.

Subtract(SearchSpanDefinition<TDocument>, SearchSpanDefinition<TDocument>)

Creates a span clause that excludes certain strings from the search results.

public SearchSpanDefinition<TDocument> Subtract(SearchSpanDefinition<TDocument> include, SearchSpanDefinition<TDocument> exclude)

Parameters

include SearchSpanDefinition<TDocument>

Clause to be included.

exclude SearchSpanDefinition<TDocument>

Clause to be excluded.

Returns

SearchSpanDefinition<TDocument>

A subtract span clause.

Term(SearchPathDefinition<TDocument>, SearchQueryDefinition)

Creates a span clause that matches a single term.

public SearchSpanDefinition<TDocument> Term(SearchPathDefinition<TDocument> path, SearchQueryDefinition query)

Parameters

path SearchPathDefinition<TDocument>

The indexed field or fields to search.

query SearchQueryDefinition

The string or strings to search for.

Returns

SearchSpanDefinition<TDocument>

A term span clause.

Term<TField>(Expression<Func<TDocument, TField>>, SearchQueryDefinition)

Creates a span clause that matches a single term.

public SearchSpanDefinition<TDocument> Term<TField>(Expression<Func<TDocument, TField>> path, SearchQueryDefinition query)

Parameters

path Expression<Func<TDocument, TField>>

The indexed field or fields to search.

query SearchQueryDefinition

The string or string to search for.

Returns

SearchSpanDefinition<TDocument>

A term span clause.

Type Parameters

TField

The type of the field.