support for geo_s2 analyzers (#492)

Author: informalict

CHANGELOG.md

@@ -6,6 +6,7 @@
 - [V2] Support for Collection Documents removal
 - [V2] Fix: Plain Connection doesn't work with JWT authentication
 - Support for new error codes if write concern is not fulfilled
+- Support for geo_s2 analyzers
 
 ## [1.5.2](https://github.com/arangodb/go-driver/tree/v1.5.2) (2023-03-01)
 - Bump `DRIVER_VERSION`

test/arangosearch_analyzers_test.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2018 ArangoDB GmbH, Cologne, Germany
+// Copyright 2018-2023 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -17,8 +17,6 @@
 //
 // Copyright holder is ArangoDB GmbH, Cologne, Germany
 //
-// Author Ewout Prangsma
-//
 
 package test
 
@@ -29,7 +27,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	driver "github.com/arangodb/go-driver"
+	"github.com/arangodb/go-driver"
 )
 
 func newInt(v int) *int {
@@ -95,7 +93,6 @@ func TestArangoSearchAnalyzerEnsureAnalyzer(t *testing.T) {
 		HasError           bool
 		EnterpriseOnly     bool
 	}{
-
 		{
 			Name: "create-my-identity",
 			Definition: driver.ArangoSearchAnalyzerDefinition{
@@ -261,6 +258,37 @@ func TestArangoSearchAnalyzerEnsureAnalyzer(t *testing.T) {
 				},
 			},
 		},
+		{
+			Name:       "create-geo_s2",
+			MinVersion: newVersion("3.10.5"),
+			Definition: driver.ArangoSearchAnalyzerDefinition{
+				Name: "my-geo_s2",
+				Type: driver.ArangoSearchAnalyzerTypeGeoS2,
+				Properties: driver.ArangoSearchAnalyzerProperties{
+					Format: driver.FormatLatLngInt.New(),
+					Options: &driver.ArangoSearchAnalyzerGeoOptions{
+						MaxCells: newInt(20),
+						MinLevel: newInt(4),
+						MaxLevel: newInt(23),
+					},
+					Type: driver.ArangoSearchAnalyzerGeoJSONTypeShape.New(),
+				},
+			},
+			ExpectedDefinition: &driver.ArangoSearchAnalyzerDefinition{
+				Name: "my-geo_s2",
+				Type: driver.ArangoSearchAnalyzerTypeGeoS2,
+				Properties: driver.ArangoSearchAnalyzerProperties{
+					Format: driver.FormatLatLngInt.New(),
+					Options: &driver.ArangoSearchAnalyzerGeoOptions{
+						MaxCells: newInt(20),
+						MinLevel: newInt(4),
+						MaxLevel: newInt(23),
+					},
+					Type: driver.ArangoSearchAnalyzerGeoJSONTypeShape.New(),
+				},
+			},
+			EnterpriseOnly: true,
+		},
 		{
 			Name:       "create-segmentation",
 			MinVersion: newVersion("3.9"),

view_arangosearch.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2018 ArangoDB GmbH, Cologne, Germany
+// Copyright 2018-2023 ArangoDB GmbH, Cologne, Germany
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -17,8 +17,6 @@
 //
 // Copyright holder is ArangoDB GmbH, Cologne, Germany
 //
-// Author Ewout Prangsma
-//
 
 package driver
 
@@ -63,6 +61,10 @@ const (
 	ArangoSearchAnalyzerTypeStopwords ArangoSearchAnalyzerType = "stopwords"
 	// ArangoSearchAnalyzerTypeGeoJSON an Analyzer capable of breaking up a GeoJSON object into a set of indexable tokens for further usage with ArangoSearch Geo functions.
 	ArangoSearchAnalyzerTypeGeoJSON ArangoSearchAnalyzerType = "geojson"
+	// ArangoSearchAnalyzerTypeGeoS2 an Analyzer capable of index GeoJSON data with inverted indexes or Views similar
+	// to the existing `geojson` Analyzer, but it internally uses a format for storing the geo-spatial data.
+	// that is more efficient.
+	ArangoSearchAnalyzerTypeGeoS2 ArangoSearchAnalyzerType = "geo_s2"
 	// ArangoSearchAnalyzerTypeGeoPoint an Analyzer capable of breaking up JSON object describing a coordinate into a set of indexable tokens for further usage with ArangoSearch Geo functions.
 	ArangoSearchAnalyzerTypeGeoPoint ArangoSearchAnalyzerType = "geopoint"
 	// ArangoSearchAnalyzerTypeSegmentation an Analyzer capable of breaking up the input text into tokens in a language-agnostic manner
@@ -133,6 +135,24 @@ type ArangoSearchEdgeNGram struct {
 	PreserveOriginal *bool `json:"preserveOriginal,omitempty"`
 }
 
+type ArangoSearchFormat string
+
+const (
+	// FormatLatLngDouble stores each latitude and longitude value as an 8-byte floating-point value (16 bytes per coordinate pair).
+	// It is default value.
+	FormatLatLngDouble ArangoSearchFormat = "latLngDouble"
+	// FormatLatLngInt stores each latitude and longitude value as an 4-byte integer value (8 bytes per coordinate pair).
+	// This is the most compact format but the precision is limited to approximately 1 to 10 centimeters.
+	FormatLatLngInt ArangoSearchFormat = "latLngInt"
+	// FormatS2Point store each longitude-latitude pair in the native format of Google S2 which is used for geo-spatial
+	// calculations (24 bytes per coordinate pair).
+	FormatS2Point ArangoSearchFormat = "s2Point"
+)
+
+func (a ArangoSearchFormat) New() *ArangoSearchFormat {
+	return &a
+}
+
 // ArangoSearchAnalyzerProperties specifies options for the analyzer. Which fields are required and
 // respected depends on the analyzer type.
 // more information can be found here: https://www.arangodb.com/docs/stable/arangosearch-analyzers.html#analyzer-properties
@@ -223,6 +243,9 @@ type ArangoSearchAnalyzerProperties struct {
 	// NumHashes used by Minhash
 	// Size of min hash signature. Must be greater or equal to 1.
 	NumHashes *uint64 `json:"numHashes,omitempty"`
+
+	// Format is the internal binary representation to use for storing the geo-spatial data in an index.
+	Format *ArangoSearchFormat `json:"format,omitempty"`
 }
 
 // ArangoSearchAnalyzerGeoJSONType GeoJSON Type parameter.