Click or drag to resize

PipelineDefinitionBuilder.SearchMeta<TInput, TOutput> Method

Appends a $searchMeta stage to the pipeline.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
public static PipelineDefinition<TInput, SearchMetaResult> SearchMeta<TInput, TOutput>(
	this PipelineDefinition<TInput, TOutput> pipeline,
	SearchDefinition<TOutput> query,
	string indexName = null,
	SearchCountOptions count = null
)

Parameters

pipeline
Type: MongoDB.Driver.PipelineDefinition<TInput, TOutput>
The pipeline.
query
Type: MongoDB.Driver.Search.SearchDefinition<TOutput>
The search definition.
indexName (Optional)
Type: System.String
The index name.
count (Optional)
Type: MongoDB.Driver.Search.SearchCountOptions
The count options.

Type Parameters

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

Return Value

Type: PipelineDefinition<TInput, SearchMetaResult>
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