LinqToMongoWithIndexTSource Method (IQueryableTSource, String) |
Sets an index hint on the query that's being built.
Namespace:
MongoDB.Driver.Linq
Assembly:
MongoDB.Driver.Legacy (in MongoDB.Driver.Legacy.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax public static IQueryable<TSource> WithIndex<TSource>(
this IQueryable<TSource> source,
string indexName
)
<ExtensionAttribute>
Public Shared Function WithIndex(Of TSource) (
source As IQueryable(Of TSource),
indexName As String
) As IQueryable(Of TSource)
[<ExtensionAttribute>]
static member WithIndex :
source : IQueryable<'TSource> *
indexName : string -> IQueryable<'TSource>
Parameters
- source
- Type: System.LinqIQueryableTSource
The query being built. - indexName
- Type: SystemString
The name of the index to use.
Type Parameters
- TSource
- The type of the elements of source.
Return Value
Type:
IQueryableTSourceNew query where the expression includes a WithIndex method call.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
IQueryableTSource. 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