GT-154 Update the structures to align them with the ArangoDB 3.10 release (#416)

* GT-154 Update the structures to align them with the ArangoDB 3.10 release

* fix name

* update doc

Author: jwierzbo

.travis.yml

@@ -32,13 +32,13 @@ env:
   - TEST_SUITE=run-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.6.16
   - TEST_SUITE=run-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.7.17
   - TEST_SUITE=run-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.8.5.1
-  - TEST_SUITE=run-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.9.0 ALWAYS=1
-  - TEST_SUITE=run-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=gcr.io/gcr-for-testing/arangodb/arangodb-preview:latest TEST_DISALLOW_UNKNOWN_FIELDS=false
+  - TEST_SUITE=run-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.9.0
+  - TEST_SUITE=run-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=gcr.io/gcr-for-testing/arangodb/arangodb-preview:3.10-nightly TEST_DISALLOW_UNKNOWN_FIELDS=false  ALWAYS=1
   - TEST_SUITE=run-v2-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.6.16
   - TEST_SUITE=run-v2-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.7.17
   - TEST_SUITE=run-v2-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.8.5.1
-  - TEST_SUITE=run-v2-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.9.0 ALWAYS=1
-  - TEST_SUITE=run-v2-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=gcr.io/gcr-for-testing/arangodb/arangodb-preview:latest
+  - TEST_SUITE=run-v2-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=eu.gcr.io/arangodb-ci/official/arangodb/arangodb:3.9.0
+  - TEST_SUITE=run-v2-tests-single GOIMAGE=gcr.io/gcr-for-testing/golang:1.17.6 STARTER=gcr.io/gcr-for-testing/arangodb/arangodb-starter:latest ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.4 ARANGODB=gcr.io/gcr-for-testing/arangodb/arangodb-preview:3.10-nightly ALWAYS=1
 
 script:
   - |

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Add support for `computedValues`
 - Optional `computeOn` field in `computedValues`
 - Add support for `computedValues` into collection inventory
+- Update the structures to align them with the ArangoDB 3.10 release
 
 ## [1.3.3](https://github.com/arangodb/go-driver/tree/v1.3.3) (2022-07-27)
 - Fix `lastValue` field type

client_server_admin.go

@@ -132,6 +132,7 @@ type TransactionStats struct {
 	Committed           int64 `json:"committed"`
 	IntermediateCommits int64 `json:"intermediateCommits"`
 	ReadOnly            int64 `json:"readOnly,omitempty"`
+	DirtyReadOnly       int64 `json:"dirtyReadOnly,omitempty"`
 }
 
 // MemoryStats contains statistics about memory usage.

cluster.go

@@ -315,6 +315,7 @@ type InventoryIndex struct {
 	ExpireAfter     int      `json:"expireAfter,omitempty"`
 	Estimates       bool     `json:"estimates,omitempty"`
 	FieldValueTypes string   `json:"fieldValueTypes,omitempty"`
+	CacheEnabled    *bool    `json:"cacheEnabled,omitempty"`
 }
 
 // FieldsEqual returns true when the given fields list equals the

collection.go

@@ -296,6 +296,13 @@ type CollectionStatistics struct {
 			// The memory used for storing the revisions of this collection in the storage engine (in bytes). This figure does not include the document data but only mappings from document revision ids to storage engine datafile positions.
 			Size int64 `json:"size,omitempty"`
 		} `json:"revisions"`
+
+		DocumentsSize *int64 `json:"documentsSize,omitempty"`
+
+		// RocksDB cache statistics
+		CacheInUse *bool  `json:"cacheInUse,omitempty"`
+		CacheSize  *int64 `json:"cacheSize,omitempty"`
+		CacheUsage *int64 `json:"cacheUsage,omitempty"`
 	} `json:"figures"`
 }
 

collection_indexes_impl.go

@@ -46,6 +46,8 @@ type indexData struct {
 	SelectivityEstimate float64  `json:"selectivityEstimate,omitempty"`
 	BestIndexedLevel    int      `json:"bestIndexedLevel,omitempty"`
 	WorstIndexedLevel   int      `json:"worstIndexedLevel,omitempty"`
+	LegacyPolygons      *bool    `json:"legacyPolygons,omitempty"`
+	CacheEnabled        *bool    `json:"cacheEnabled,omitempty"`
 
 	ArangoError `json:",inline"`
 }

context.go

@@ -159,6 +159,7 @@ func WithWaitForSync(parent context.Context, value ...bool) context.Context {
 // You can pass a reference to a boolean that will set according to whether a potentially dirty read
 // happened or not. nil is allowed.
 // This is valid for document reads, aql queries, gharial vertex and edge reads.
+// Since 3.10 This feature is available in the Enterprise Edition for cluster deployments as well
 func WithAllowDirtyReads(parent context.Context, wasDirtyRead *bool) context.Context {
 	return context.WithValue(contextOrBackground(parent), keyAllowDirtyReads, wasDirtyRead)
 }

cursor_impl.go

@@ -58,6 +58,7 @@ type cursor struct {
 	lastReadWasDirty bool
 }
 
+// CursorStats TODO: all these int64 should be changed into uint64
 type cursorStats struct {
 	// The total number of data-modification operations successfully executed.
 	WritesExecutedInt int64 `json:"writesExecuted,omitempty"`
@@ -76,6 +77,21 @@ type cursorStats struct {
 	Nodes            []cursorPlanNodes `json:"nodes,omitempty"`
 	HttpRequests     int64             `json:"httpRequests,omitempty"`
 	PeakMemoryUsage  int64             `json:"peakMemoryUsage,omitempty"`
+
+	// CursorsCreated the total number of cursor objects created during query execution. Cursor objects are created for index lookups.
+	CursorsCreated uint64 `json:"cursorsCreated,omitempty"`
+	// CursorsRearmed the total number of times an existing cursor object was repurposed.
+	// Repurposing an existing cursor object is normally more efficient compared to destroying an existing cursor object
+	// and creating a new one from scratch.
+	CursorsRearmed uint64 `json:"cursorsRearmed,omitempty"`
+	// CacheHits the total number of index entries read from in-memory caches for indexes of type edge or persistent.
+	// This value will only be non-zero when reading from indexes that have an in-memory cache enabled,
+	// and when the query allows using the in-memory cache (i.e. using equality lookups on all index attributes).
+	CacheHits uint64 `json:"cacheHits,omitempty"`
+	// CacheMisses the total number of cache read attempts for index entries that could not be served from in-memory caches for indexes of type edge or persistent.
+	// This value will only be non-zero when reading from indexes that have an in-memory cache enabled,
+	// the query allows using the in-memory cache (i.e. using equality lookups on all index attributes) and the looked up values are not present in the cache.
+	CacheMisses uint64 `json:"cacheMisses,omitempty"`
 }
 
 type cursorPlan struct {
@@ -131,9 +147,10 @@ func (c cursorExtra) GetPlanRaw() ([]byte, bool, error) {
 }
 
 type cursorPlanVariable struct {
-	ID                   int    `json:"id"`
-	Name                 string `json:"name"`
-	IsDataFromCollection bool   `json:"isDataFromCollection"`
+	ID                           int    `json:"id"`
+	Name                         string `json:"name"`
+	IsDataFromCollection         bool   `json:"isDataFromCollection"`
+	IsFullDocumentFromCollection bool   `json:"isFullDocumentFromCollection"`
 }
 
 type cursorPlanCollection struct {

database_collections_schema.go

@@ -39,6 +39,7 @@ type CollectionSchemaOptions struct {
 	Rule    interface{}           `json:"rule,omitempty"`
 	Level   CollectionSchemaLevel `json:"level,omitempty"`
 	Message string                `json:"message,omitempty"`
+	Type    string                `json:"type,omitempty"`
 }
 
 func (d *CollectionSchemaOptions) LoadRule(data []byte) error {

test/collection_schema_test.go

@@ -49,7 +49,7 @@ func TestCollectionSchema(t *testing.T) {
 	ctx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 
-	EnsureVersion(t, ctx, c).CheckVersion(MinimumVersion("3.7.0"))
+	EnsureVersion(t, ctx, c).CheckVersion(MinimumVersion("3.10.0"))
 
 	name := "document_schema_validation_test"
 	db := ensureDatabase(nil, c, name, nil, t)
@@ -58,6 +58,7 @@ func TestCollectionSchema(t *testing.T) {
 			Schema: &driver.CollectionSchemaOptions{
 				Level:   driver.CollectionSchemaLevelStrict,
 				Message: "Validation Err",
+				Type:    "json",
 			},
 		}
 
@@ -91,6 +92,7 @@ func TestCollectionSchema(t *testing.T) {
 		schema := &driver.CollectionSchemaOptions{
 			Level:   driver.CollectionSchemaLevelStrict,
 			Message: "Validation Err",
+			Type:    "json",
 		}
 
 		require.NoError(t, schema.LoadRule([]byte(`{
@@ -127,6 +129,7 @@ func TestCollectionSchema(t *testing.T) {
 		schema := &driver.CollectionSchemaOptions{
 			Level:   driver.CollectionSchemaLevelStrict,
 			Message: "Validation Err",
+			Type:    "json",
 		}
 
 		require.NoError(t, schema.LoadRule([]byte(`{
@@ -150,6 +153,7 @@ func TestCollectionSchema(t *testing.T) {
 		schema := &driver.CollectionSchemaOptions{
 			Level:   driver.CollectionSchemaLevelStrict,
 			Message: "Validation Err",
+			Type:    "json",
 		}
 
 		require.NoError(t, schema.LoadRule([]byte(`{

v2/arangodb/cursor.go

@@ -54,6 +54,7 @@ type Cursor interface {
 	Statistics() CursorStats
 }
 
+// CursorStats TODO: all these int64 should be changed into uint64
 type CursorStats struct {
 	// The total number of data-modification operations successfully executed.
 	WritesExecutedInt int64 `json:"writesExecuted,omitempty"`
@@ -69,6 +70,24 @@ type CursorStats struct {
 	FullCountInt int64 `json:"fullCount,omitempty"`
 	// Query execution time (wall-clock time). value will be set from the outside
 	ExecutionTimeInt float64 `json:"executionTime,omitempty"`
+
+	HTTPRequests    uint64 `json:"httpRequests,omitempty"`
+	PeakMemoryUsage uint64 `json:"peakMemoryUsage,omitempty"`
+
+	// CursorsCreated the total number of cursor objects created during query execution. Cursor objects are created for index lookups.
+	CursorsCreated uint64 `json:"cursorsCreated,omitempty"`
+	// CursorsRearmed the total number of times an existing cursor object was repurposed.
+	// Repurposing an existing cursor object is normally more efficient compared to destroying an existing cursor object
+	// and creating a new one from scratch.
+	CursorsRearmed uint64 `json:"cursorsRearmed,omitempty"`
+	// CacheHits the total number of index entries read from in-memory caches for indexes of type edge or persistent.
+	// This value will only be non-zero when reading from indexes that have an in-memory cache enabled,
+	// and when the query allows using the in-memory cache (i.e. using equality lookups on all index attributes).
+	CacheHits uint64 `json:"cacheHits,omitempty"`
+	// CacheMisses the total number of cache read attempts for index entries that could not be served from in-memory caches for indexes of type edge or persistent.
+	// This value will only be non-zero when reading from indexes that have an in-memory cache enabled,
+	// the query allows using the in-memory cache (i.e. using equality lookups on all index attributes) and the looked up values are not present in the cache.
+	CacheMisses uint64 `json:"cacheMisses,omitempty"`
 }
 
 type cursorData struct {