IndexKeysDefinitionExtensions.Geo2DSphere<TDocument> Method (IndexKeysDefinition<TDocument>, FieldDefinition<TDocument>)

Combines an existing index keys definition with a 2dsphere index key definition.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2

Syntax

Copy

public static IndexKeysDefinition<TDocument> Geo2DSphere<TDocument>(
	this IndexKeysDefinition<TDocument> keys,
	FieldDefinition<TDocument> field
)

<ExtensionAttribute>
Public Shared Function Geo2DSphere(Of TDocument) ( 
	keys As IndexKeysDefinition(Of TDocument),
	field As FieldDefinition(Of TDocument)
) As IndexKeysDefinition(Of TDocument)

[<ExtensionAttribute>]
static member Geo2DSphere : 
        keys : IndexKeysDefinition<'TDocument> * 
        field : FieldDefinition<'TDocument> -> IndexKeysDefinition<'TDocument>

Parameters

keys: Type: MongoDB.Driver.IndexKeysDefinition<TDocument>
The keys.
field: Type: MongoDB.Driver.FieldDefinition<TDocument>
The field.

Type Parameters

TDocument: The type of the document.

Return Value

Type: IndexKeysDefinition<TDocument>
A combined index keys definition.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IndexKeysDefinition<TDocument>. 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

IndexKeysDefinitionExtensions Class

Geo2DSphere Overload

MongoDB.Driver Namespace