Search(TSource) Method (IMongoQueryable(TSource), SearchDefinition(TSource), SearchHighlightOptions(TSource), String, SearchCountOptions, Boolean, Boolean)

MongoQueryable.Search<TSource> Method (IMongoQueryable<TSource>, SearchDefinition<TSource>, SearchOptions<TSource>)

Appends a $search stage to the LINQ pipeline.

Namespace: MongoDB.Driver.Linq
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e

Syntax

Copy

public static IMongoQueryable<TSource> Search<TSource>(
	this IMongoQueryable<TSource> source,
	SearchDefinition<TSource> searchDefinition,
	SearchOptions<TSource> searchOptions
)

<ExtensionAttribute>
Public Shared Function Search(Of TSource) ( 
	source As IMongoQueryable(Of TSource),
	searchDefinition As SearchDefinition(Of TSource),
	searchOptions As SearchOptions(Of TSource)
) As IMongoQueryable(Of TSource)

[<ExtensionAttribute>]
static member Search : 
        source : IMongoQueryable<'TSource> * 
        searchDefinition : SearchDefinition<'TSource> * 
        searchOptions : SearchOptions<'TSource> -> IMongoQueryable<'TSource>

Parameters

source: Type: MongoDB.Driver.Linq.IMongoQueryable<TSource>
A sequence of values.
searchDefinition: Type: MongoDB.Driver.Search.SearchDefinition<TSource>
The search definition.
searchOptions: Type: MongoDB.Driver.Search.SearchOptions<TSource>
The search options.

Type Parameters

TSource: The type of the elements of source.

Return Value

Type: IMongoQueryable<TSource>
The queryable with a new stage appended.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMongoQueryable<TSource>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Reference

MongoQueryable Class

Search Overload

MongoDB.Driver.Linq Namespace