Click or drag to resize

PipelineDefinitionBuilderSearchTInput, TOutput Method (PipelineDefinitionTInput, TOutput, SearchDefinitionTOutput, SearchHighlightOptionsTOutput, String, SearchCountOptions, Boolean, Boolean)

Appends a $search stage to the pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
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,
	bool scoreDetails = false
)

Parameters

pipeline
Type: MongoDB.DriverPipelineDefinitionTInput, TOutput
The pipeline.
searchDefinition
Type: MongoDB.Driver.SearchSearchDefinitionTOutput
The search definition.
highlight (Optional)
Type: MongoDB.Driver.SearchSearchHighlightOptionsTOutput
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.
scoreDetails (Optional)
Type: SystemBoolean
Flag that specifies whether to return a detailed breakdown of the score for each document in the result.

Type Parameters

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

Return Value

Type: PipelineDefinitionTInput, 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 PipelineDefinitionTInput, 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