Type alias EnsureGeoIndexOptions

EnsureGeoIndexOptions: EnsureIndexOptionsType<"geo", [string, string] | [string], {
    geoJson?: boolean;
    legacyPolygons?: boolean;
}>

Options for creating a geo index.

Type declaration

  • Optional geoJson?: boolean

    If set to true, fields must be an array containing a single attribute path and the attribute value must be an array with two values, the first of which will be interpreted as the longitude and the second of which will be interpreted as the latitude of the document.

    If set to false, fields can be either an array containing two attribute paths, the first of which will be interpreted as the latitude and the second as the longitude, or a single attribute path for an array containing two values, the first of which will be interpreted as the latitude, the second as the longitude.

    Default: false

  • Optional legacyPolygons?: boolean

    If set to true, the index will use pre-3.10 rules for parsing GeoJSON polygons. This option is always implicitly true when using ArangoDB 3.9 or lower.