This helper wraps the ArangoDB AQL function DISTANCE(latitude1, longitude1, latitude2, longitude2) which computes the great-circle (haversine) distance between two points given as separate scalar attributes. Unlike the GeoJSON functions, DISTANCE takes its coordinates in the latitude-first order.

This is the index-accelerated form when a geo index is declared over the two latitude / longitude attributes (geoJson: false), e.g. used in a FILTER DISTANCE(...) <= @radius or SORT DISTANCE(...) ASC LIMIT n.

Example AQL usage:

DISTANCE(doc.geo.latitude, doc.geo.longitude, 48.8566, 2.3522)

This helper wraps the ArangoDB AQL function GEO_AREA(geoJson, ellipsoid) which computes the area of a polygonal GeoJSON geometry. The optional ellipsoid ("sphere" or "wgs84") selects the reference model.

Example AQL usage:

GEO_AREA(doc.area)
GEO_AREA(doc.area, "wgs84")

This helper wraps the ArangoDB AQL function GEO_CONTAINS(geoJsonA, geoJsonB) which returns true when geometry B is completely inside geometry A (a point inside a polygon, a polygon inside a larger polygon, …). Both arguments use the GeoJSON longitude-first convention.

Example AQL usage:

GEO_CONTAINS(doc.area, GEO_POINT(2.3522, 48.8566))

This helper wraps the ArangoDB AQL function GEO_DISTANCE(geoJson1, geoJson2, ellipsoid) which computes the shortest distance between two GeoJSON objects. Both arguments are GeoJSON geometries (built with geoPoint(), geoPolygon(), … or a document attribute), using the longitude-first coordinate convention. The optional ellipsoid ("sphere" or "wgs84") selects the reference model.

Example AQL usage:

GEO_DISTANCE(doc.geo, GEO_POINT(2.3522, 48.8566))
GEO_DISTANCE(doc.geo, @target, "wgs84")

This helper wraps the ArangoDB AQL function GEO_EQUALS(geoJsonA, geoJsonB) which returns true when both geometries describe the same shape. Both arguments use the GeoJSON longitude-first convention.

Example AQL usage:

GEO_EQUALS(doc.geo, GEO_POINT(2.3522, 48.8566))

This helper wraps the ArangoDB AQL function GEO_IN_RANGE(geoJson1, geoJson2, low, high, includeLow, includeHigh) which returns true when the distance (in meters) between the two geometries lies between low and high. The boundary inclusion flags default to true on the ArangoDB side and are only emitted when explicitly provided. Both geometries use the GeoJSON longitude-first convention.

Example AQL usage:

GEO_IN_RANGE(doc.geo, @center, 1000, 5000)
GEO_IN_RANGE(doc.geo, @center, 1000, 5000, false, true)

This helper wraps the ArangoDB AQL function GEO_INTERSECTS(geoJsonA, geoJsonB) which returns true when the two geometries share at least one point. Both arguments use the GeoJSON longitude-first convention.

Example AQL usage:

GEO_INTERSECTS(doc.area, @zone)

This helper wraps the ArangoDB AQL function GEO_LINESTRING(points) which constructs a valid GeoJSON LineString from an ordered array of [longitude, latitude] pairs, following the GeoJSON longitude-first convention.

Example AQL usage:

GEO_LINESTRING([ [2.35, 48.85], [4.83, 45.76] ])

This helper wraps the ArangoDB AQL function GEO_MULTILINESTRING(lines) which constructs a valid GeoJSON MultiLineString from an array of line strings. Each line is an array of [longitude, latitude] pairs, following the GeoJSON longitude-first convention.

Example AQL usage:

GEO_MULTILINESTRING([ [ [2.35,48.85], [4.83,45.76] ], [ [1.44,43.60], [5.37,43.29] ] ])

This helper wraps the ArangoDB AQL function GEO_MULTIPOINT(points) which constructs a valid GeoJSON MultiPoint from an array of coordinate pairs. Each coordinate pair must already follow the GeoJSON longitude-first convention ([longitude, latitude]).

Example AQL usage:

GEO_MULTIPOINT([ [2.35, 48.85], [4.83, 45.76] ])

This helper wraps the ArangoDB AQL function GEO_MULTIPOLYGON(polygons) which constructs a valid GeoJSON MultiPolygon from an array of polygons. Each polygon is itself an array of linear rings of [longitude, latitude] pairs, following the GeoJSON longitude-first convention.

Example AQL usage:

GEO_MULTIPOLYGON([ [ [ [0,0],[1,0],[1,1],[0,0] ] ] ])

This helper wraps the ArangoDB AQL function GEO_POINT(longitude, latitude) which constructs a valid GeoJSON Point. Coordinates are accepted here in the human-friendly (latitude, longitude) order and reordered internally to the GeoJSON longitude-first convention expected by ArangoDB.

Example AQL usage:

GEO_POINT(2.3522, 48.8566)            // Paris, as [lng, lat]
GEO_POINT(doc.geo.longitude, doc.geo.latitude)

This helper wraps the ArangoDB AQL function GEO_POLYGON(points) which constructs a valid GeoJSON Polygon. The outer ring (and any holes) is an array of linear rings, each a closed list of [longitude, latitude] pairs (first and last coordinate must be equal). Coordinates must already follow the GeoJSON longitude-first convention.

Example AQL usage:

GEO_POLYGON([ [ [0,0], [1,0], [1,1], [0,1], [0,0] ] ])

This helper wraps the ArangoDB AQL function IS_IN_POLYGON(polygon, latitude, longitude) which returns true when the point is inside the polygon. The polygon is a plain array of [latitude, longitude] pairs, and — unlike the GeoJSON functions — the point is given in the latitude-first order.

This is a legacy function kept for completeness; prefer geoContains() with proper GeoJSON geometries and a geo index for new code.

Example AQL usage:

IS_IN_POLYGON([ [48.8, 2.2], [48.9, 2.2], [48.9, 2.4] ], doc.geo.latitude, doc.geo.longitude)

This helper wraps the ArangoDB AQL function NEAR(collection, latitude, longitude, limit, distanceName) which returns up to limit documents ordered by ascending distance from the given point. The collection must have a geo index. The coordinate is given in the latitude-first order.

This is a legacy function; prefer a geo index combined with SORT DISTANCE(doc.lat, doc.lng, @lat, @lng) ASC LIMIT n for new code.

Example AQL usage:

FOR place IN NEAR(places, 48.8566, 2.3522, 10, "distance") RETURN place

This helper wraps the ArangoDB AQL function WITHIN(collection, latitude, longitude, radius, distanceName) which returns all documents located within radius meters of the given point, ordered by ascending distance. The collection must have a geo index. The coordinate is given in the latitude-first order.

This is a legacy function; prefer a geo index combined with FILTER DISTANCE(doc.lat, doc.lng, @lat, @lng) <= @radius for new code.

Example AQL usage:

FOR place IN WITHIN(places, 48.8566, 2.3522, 5000, "distance") RETURN place

This helper wraps the ArangoDB AQL function WITHIN_RECTANGLE(collection, latitude1, longitude1, latitude2, longitude2) which returns all documents located inside the rectangle defined by two opposite corners. The collection must have a geo index. Coordinates are given in the latitude-first order.

This is a legacy function; prefer a geo index combined with GeoJSON geoContains() over a polygon for new code.

Example AQL usage:

FOR place IN WITHIN_RECTANGLE(places, 48.80, 2.25, 48.90, 2.40) RETURN place