LinqToMongo.WithIndex(TSource) Method (IQueryable(TSource), BsonDocument)

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.4.1

Syntax

public static IQueryable<TSource> WithIndex<TSource>(
	this IQueryable<TSource> source,
	BsonDocument indexHint
)

<ExtensionAttribute>
Public Shared Function WithIndex(Of TSource) ( 
	source As IQueryable(Of TSource),
	indexHint As BsonDocument
) As IQueryable(Of TSource)

[<ExtensionAttribute>]
static member WithIndex : 
        source : IQueryable<'TSource> * 
        indexHint : BsonDocument -> IQueryable<'TSource>

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).

Reference

LinqToMongo Class

WithIndex Overload

MongoDB.Driver.Linq Namespace