Click or drag to resize

PipelineDefinitionBuilder.Search<TInput, TOutput> Method

Appends a $search stage to the pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax
public static PipelineDefinition<TInput, TOutput> Search<TInput, TOutput>(
	this PipelineDefinition<TInput, TOutput> pipeline,
	SearchDefinition<TOutput> searchDefinition,
	SearchHighlightOptions<TOutput> highlight = null,
	string indexName = null,
	SearchCountOptions count = null,
	bool returnStoredSource = false
)

Parameters

pipeline
Type: MongoDB.Driver.PipelineDefinition<TInput, TOutput>
The pipeline.
searchDefinition
Type: MongoDB.Driver.Search.SearchDefinition<TOutput>
The search definition.
highlight (Optional)
Type: MongoDB.Driver.Search.SearchHighlightOptions<TOutput>
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.

Type Parameters

TInput
The type of the input documents.
TOutput
The type of the output documents.

Return Value

Type: PipelineDefinition<TInput, TOutput>
A new pipeline with an additional stage.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type PipelineDefinition<TInput, TOutput>. 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