SearchDefinitionBuilder<TDocument>.GeoWithin<TCoordinates> Method (SearchPathDefinition<TDocument>, GeoJsonGeometry<TCoordinates>, SearchScoreDefinition<TDocument>)

Creates a search definition that queries for geographic points within a given geometry.

Namespace: MongoDB.Driver.Search
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4

Syntax

Copy

public SearchDefinition<TDocument> GeoWithin<TCoordinates>(
	SearchPathDefinition<TDocument> path,
	GeoJsonGeometry<TCoordinates> geometry,
	SearchScoreDefinition<TDocument> score = null
)
where TCoordinates : GeoJsonCoordinates

Public Function GeoWithin(Of TCoordinates As GeoJsonCoordinates) ( 
	path As SearchPathDefinition(Of TDocument),
	geometry As GeoJsonGeometry(Of TCoordinates),
	Optional score As SearchScoreDefinition(Of TDocument) = Nothing
) As SearchDefinition(Of TDocument)

member GeoWithin : 
        path : SearchPathDefinition<'TDocument> * 
        geometry : GeoJsonGeometry<'TCoordinates> * 
        ?score : SearchScoreDefinition<'TDocument> 
(* Defaults:
        let _score = defaultArg score null
*)
-> SearchDefinition<'TDocument>  when 'TCoordinates : GeoJsonCoordinates

Parameters

path: Type: MongoDB.Driver.Search.SearchPathDefinition<TDocument>
Indexed geo type field or fields to search.
geometry: Type: MongoDB.Driver.GeoJsonObjectModel.GeoJsonGeometry<TCoordinates>
GeoJSON object specifying the MultiPolygon or Polygon to search within.
score (Optional): Type: MongoDB.Driver.Search.SearchScoreDefinition<TDocument>
The score modifier.

Type Parameters

TCoordinates: The type of the coordinates.

Return Value

Type: SearchDefinition<TDocument>
A geo within search definition.

Reference

SearchDefinitionBuilder<TDocument> Class

GeoWithin Overload

MongoDB.Driver.Search Namespace