MongoQueryableSearchMetaTSource Method |
Appends a $searchMeta stage to the LINQ pipeline.
Namespace:
MongoDB.Driver.Linq
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntax public static IMongoQueryable<SearchMetaResult> SearchMeta<TSource>(
this IMongoQueryable<TSource> source,
SearchDefinition<TSource> searchDefinition,
string indexName = null,
SearchCountOptions count = null
)
<ExtensionAttribute>
Public Shared Function SearchMeta(Of TSource) (
source As IMongoQueryable(Of TSource),
searchDefinition As SearchDefinition(Of TSource),
Optional indexName As String = Nothing,
Optional count As SearchCountOptions = Nothing
) As IMongoQueryable(Of SearchMetaResult)
[<ExtensionAttribute>]
static member SearchMeta :
source : IMongoQueryable<'TSource> *
searchDefinition : SearchDefinition<'TSource> *
?indexName : string *
?count : SearchCountOptions
(* Defaults:
let _indexName = defaultArg indexName null
let _count = defaultArg count null
*)
-> IMongoQueryable<SearchMetaResult>
Parameters
- source
- Type: MongoDB.Driver.LinqIMongoQueryableTSource
A sequence of values. - searchDefinition
- Type: MongoDB.Driver.SearchSearchDefinitionTSource
The search definition. - indexName (Optional)
- Type: SystemString
The index name. - count (Optional)
- Type: MongoDB.Driver.SearchSearchCountOptions
The count options.
Type Parameters
- TSource
- The type of the elements of source.
Return Value
Type:
IMongoQueryableSearchMetaResultThe 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