Method GeoWithin

Namespace

MongoDB.Driver.Search

Assembly

MongoDB.Driver.dll

GeoWithin<TCoordinates>(SearchPathDefinition<TDocument>, GeoJsonGeometry<TCoordinates>, SearchScoreDefinition<TDocument>)

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

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

Parameters

path SearchPathDefinition<TDocument>

Indexed geo type field or fields to search.

geometry GeoJsonGeometry<TCoordinates>

GeoJSON object specifying the MultiPolygon or Polygon to search within.

score SearchScoreDefinition<TDocument>

The score modifier.

Returns

SearchDefinition<TDocument>

A geo within search definition.

Type Parameters

TCoordinates

The type of the coordinates.

GeoWithin<TCoordinates, TField>(Expression<Func<TDocument, TField>>, GeoJsonGeometry<TCoordinates>, SearchScoreDefinition<TDocument>)

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

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

Parameters

path Expression<Func<TDocument, TField>>

Indexed geo type field or fields to search.

geometry GeoJsonGeometry<TCoordinates>

GeoJSON object specifying the MultiPolygon or Polygon to search within.

score SearchScoreDefinition<TDocument>

The score modifier.

Returns

SearchDefinition<TDocument>

A geo within search definition.

Type Parameters

TCoordinates

The type of the coordinates.

TField

The type of the field.

GeoWithin<TCoordinates, TField>(Expression<Func<TDocument, TField>>, GeoWithinArea<TCoordinates>, SearchScoreDefinition<TDocument>)

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

public SearchDefinition<TDocument> GeoWithin<TCoordinates, TField>(Expression<Func<TDocument, TField>> path, GeoWithinArea<TCoordinates> area, SearchScoreDefinition<TDocument> score = null) where TCoordinates : GeoJsonCoordinates

Parameters

path Expression<Func<TDocument, TField>>

Indexed geo type field or fields to search.

area GeoWithinArea<TCoordinates>

Object that specifies the area to search within.

score SearchScoreDefinition<TDocument>

The score modifier.

Returns

SearchDefinition<TDocument>

A geo within search definition.

Type Parameters

TCoordinates

The type of the coordinates.

TField

The type of the field.

GeoWithin<TCoordinates>(SearchPathDefinition<TDocument>, GeoWithinArea<TCoordinates>, SearchScoreDefinition<TDocument>)

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

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

Parameters

path SearchPathDefinition<TDocument>

Indexed geo type field or fields to search.

area GeoWithinArea<TCoordinates>

Object that specifies the area to search within.

score SearchScoreDefinition<TDocument>

The score modifier.

Returns

SearchDefinition<TDocument>

A geo within search definition.

Type Parameters

TCoordinates

The type of the coordinates.