Click or drag to resize

LinqToMongoWithIndexTSource Method (IQueryableTSource, BsonDocument)

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.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax
public static IQueryable<TSource> WithIndex<TSource>(
	this IQueryable<TSource> source,
	BsonDocument indexHint
)

Parameters

source
Type: System.LinqIQueryableTSource
The query being built.
indexHint
Type: MongoDB.BsonBsonDocument
Hint for what index to use.

Type Parameters

TSource
The type of the elements of source.

Return Value

Type: IQueryableTSource
New 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