Class GeoNearOptions<TInputDocument, TOutputDocument>

| MongoDB CSharp Driver API Reference (original) (raw)

Namespace

MongoDB.Driver

Assembly

MongoDB.Driver.dll

Represents options for the $geoNear stage.

public class GeoNearOptions<TInputDocument, TOutputDocument>

Type Parameters

TInputDocument

TOutputDocument

Inheritance

GeoNearOptions<TInputDocument, TOutputDocument>

Inherited Members

Properties

DistanceField

Gets or sets the output field that contains the calculated distance. Required if querying a time-series collection. Optional for non-time series collections in MongoDB 8.1+

DistanceMultiplier

Gets or sets the factor to multiply all distances returned by the query.

IncludeLocs

Gets or sets the output field that identifies the location used to calculate the distance.

Key

Gets or sets the geospatial indexed field used when calculating the distance.

MaxDistance

Gets or sets the max distance from the center point that the documents can be.

MinDistance

Gets or sets the min distance from the center point that the documents can be.

OutputSerializer

Gets or sets the output serializer.

Query

Gets or sets the query that limits the results to the documents that match the query.

Spherical

Gets or sets the spherical option which determines how to calculate the distance between two points.