Click or drag to resize

MongoQueryableSearchTSource Method

Appends a $search stage to the LINQ pipeline.

Namespace:  MongoDB.Driver.Linq
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
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
)

Parameters

source
Type: MongoDB.Driver.LinqIMongoQueryableTSource
A sequence of values.
searchDefinition
Type: MongoDB.Driver.SearchSearchDefinitionTSource
The search definition.
highlight (Optional)
Type: MongoDB.Driver.SearchSearchHighlightOptionsTSource
The highlight options.
indexName (Optional)
Type: SystemString
The index name.
count (Optional)
Type: MongoDB.Driver.SearchSearchCountOptions
The count options.
returnStoredSource (Optional)
Type: SystemBoolean
Flag that specifies whether to perform a full document lookup on the backend database or return only stored source fields directly from Atlas Search.

Type Parameters

TSource
The type of the elements of source.

Return Value

Type: IMongoQueryableTSource
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 IMongoQueryableTSource. 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