Class SearchPathDefinitionBuilder<TDocument>

Namespace

MongoDB.Driver.Search

Assembly

MongoDB.Driver.dll

A builder for a search path.

public sealed class SearchPathDefinitionBuilder<TDocument>

Type Parameters

TDocument

The type of the document.

Inheritance

object

SearchPathDefinitionBuilder<TDocument>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Analyzer(FieldDefinition<TDocument>, string)

Creates a search path that searches using the specified analyzer.

public SearchPathDefinition<TDocument> Analyzer(FieldDefinition<TDocument> field, string analyzerName)

Parameters

field FieldDefinition<TDocument>

The field definition

analyzerName string

The name of the analyzer.

Returns

SearchPathDefinition<TDocument>

An analyzer search path.

Analyzer<TField>(Expression<Func<TDocument, TField>>, string)

Creates a search path that searches using the specified analyzer.

public SearchPathDefinition<TDocument> Analyzer<TField>(Expression<Func<TDocument, TField>> field, string analyzerName)

Parameters

field Expression<Func<TDocument, TField>>

The field definition

analyzerName string

The name of the analyzer.

Returns

SearchPathDefinition<TDocument>

An analyzer search path.

Type Parameters

TField

The type of the field.

Multi(params FieldDefinition<TDocument>[])

Creates a search path for multiple fields.

public SearchPathDefinition<TDocument> Multi(params FieldDefinition<TDocument>[] fields)

Parameters

fields FieldDefinition<TDocument>[]

The array of field definitions.

Returns

SearchPathDefinition<TDocument>

A multi-field search path.

Multi(IEnumerable<FieldDefinition<TDocument>>)

Creates a search path for multiple fields.

public SearchPathDefinition<TDocument> Multi(IEnumerable<FieldDefinition<TDocument>> fields)

Parameters

fields IEnumerable<FieldDefinition<TDocument>>

The collection of field definitions.

Returns

SearchPathDefinition<TDocument>

A multi-field search path.

Multi<TField>(params Expression<Func<TDocument, TField>>[])

Creates a search path for multiple fields.

public SearchPathDefinition<TDocument> Multi<TField>(params Expression<Func<TDocument, TField>>[] fields)

Parameters

fields Expression<Func<TDocument, TField>>[]

The array of field definitions.

Returns

SearchPathDefinition<TDocument>

A multi-field search path.

Type Parameters

TField

The type of the fields.

Single(FieldDefinition<TDocument>)

Creates a search path for a single field.

public SearchPathDefinition<TDocument> Single(FieldDefinition<TDocument> field)

Parameters

field FieldDefinition<TDocument>

The field definition.

Returns

SearchPathDefinition<TDocument>

A single-field search path.

Single<TField>(Expression<Func<TDocument, TField>>)

Creates a search path for a single field.

public SearchPathDefinition<TDocument> Single<TField>(Expression<Func<TDocument, TField>> field)

Parameters

field Expression<Func<TDocument, TField>>

The field definition.

Returns

SearchPathDefinition<TDocument>

A single-field search path.

Type Parameters

TField

The type of the field.

Wildcard(string)

Creates a search path that uses special characters in the field name that can match any character.

public SearchPathDefinition<TDocument> Wildcard(string query)

Parameters

query string

The wildcard string that the field name must match.

Returns

SearchPathDefinition<TDocument>

A wildcard search path.