Click or drag to resize

MongoQueryable.Search<TSource> Method (IMongoQueryable<TSource>, SearchDefinition<TSource>, SearchHighlightOptions<TSource>, String, SearchCountOptions, Boolean, Boolean)

Appends a $search stage to the LINQ pipeline.

Namespace:  MongoDB.Driver.Linq
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
public static IMongoQueryable<TSource> Search<TSource>(
	this IMongoQueryable<TSource> source,
	SearchDefinition<TSource> searchDefinition,
	SearchHighlightOptions<TSource> highlight = null,
	string indexName = null,
	SearchCountOptions count = null,
	bool returnStoredSource = false,
	bool scoreDetails = false
)

Parameters

source
Type: MongoDB.Driver.Linq.IMongoQueryable<TSource>
A sequence of values.
searchDefinition
Type: MongoDB.Driver.Search.SearchDefinition<TSource>
The search definition.
highlight (Optional)
Type: MongoDB.Driver.Search.SearchHighlightOptions<TSource>
The highlight options.
indexName (Optional)
Type: System.String
The index name.
count (Optional)
Type: MongoDB.Driver.Search.SearchCountOptions
The count options.
returnStoredSource (Optional)
Type: System.Boolean
Flag that specifies whether to perform a full document lookup on the backend database or return only stored source fields directly from Atlas Search.
scoreDetails (Optional)
Type: System.Boolean
Flag that specifies whether to return a detailed breakdown of the score for each document in the result.

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).
See Also