IndexKeysDefinitionExtensionsGeoHaystackTDocument Method (IndexKeysDefinitionTDocument, FieldDefinitionTDocument, FieldDefinitionTDocument) |
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.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax [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
)
<ExtensionAttribute>
<ObsoleteAttribute("GeoHaystack indexes were deprecated in server version 4.4.")>
Public Shared Function GeoHaystack(Of TDocument) (
keys As IndexKeysDefinition(Of TDocument),
field As FieldDefinition(Of TDocument),
Optional additionalFieldName As FieldDefinition(Of TDocument) = Nothing
) As IndexKeysDefinition(Of TDocument)
[<ExtensionAttribute>]
[<ObsoleteAttribute("GeoHaystack indexes were deprecated in server version 4.4.")>]
static member GeoHaystack :
keys : IndexKeysDefinition<'TDocument> *
field : FieldDefinition<'TDocument> *
?additionalFieldName : FieldDefinition<'TDocument>
(* Defaults:
let _additionalFieldName = defaultArg additionalFieldName null
*)
-> IndexKeysDefinition<'TDocument>
Parameters
- keys
- Type: MongoDB.DriverIndexKeysDefinitionTDocument
The keys. - field
- Type: MongoDB.DriverFieldDefinitionTDocument
The field. - additionalFieldName (Optional)
- Type: MongoDB.DriverFieldDefinitionTDocument
Name of the additional field.
Type Parameters
- TDocument
- The type of the document.
Return Value
Type:
IndexKeysDefinitionTDocument
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
IndexKeysDefinitionTDocument. 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