Click or drag to resize

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

Note: This API is now obsolete.

Combines an existing index keys definition with a geo haystack index key definition.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax
Copy
[ObsoleteAttribute("GeoHaystack indexes were deprecated in server version 4.4.")]
public static IndexKeysDefinition<TDocument> GeoHaystack<TDocument>(
	this IndexKeysDefinition<TDocument> keys,
	FieldDefinition<TDocument> field,
	FieldDefinition<TDocument> additionalFieldName = null
)

Parameters

keys
Type: MongoDB.Driver.IndexKeysDefinition<TDocument>
The keys.
field
Type: MongoDB.Driver.FieldDefinition<TDocument>
The field.
additionalFieldName (Optional)
Type: MongoDB.Driver.FieldDefinition<TDocument>
Name of the additional 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).
See Also