GT-570 Allow skipping validation for Database and Collection existence (#575)

Author: jwierzbo

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Switch to Go 1.21.5
 - Disable AF mode in tests (not supported since 3.12)
 - Remove graph with all collections
+- Allow skipping validation for Database and Collection existence
 
 ## [1.6.1](https://github.com/arangodb/go-driver/tree/v1.6.1) (2023-10-31)
 - Add support for getting license

client_databases_impl.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2017 ArangoDB GmbH, Cologne, Germany
+// Copyright 2017-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
 
@@ -30,6 +28,19 @@ import (
 // Database opens a connection to an existing database.
 // If no database with given name exists, an NotFoundError is returned.
 func (c *client) Database(ctx context.Context, name string) (Database, error) {
+	db, err := newDatabase(name, c.conn)
+	if err != nil {
+		return nil, WithStack(err)
+	}
+
+	if ctx != nil {
+		if v := ctx.Value(keySkipExistCheck); v != nil {
+			if skipIfExistCheck, ok := v.(bool); ok && skipIfExistCheck {
+				return db, nil
+			}
+		}
+	}
+
 	escapedName := pathEscape(name)
 	req, err := c.conn.NewRequest("GET", path.Join("_db", escapedName, "_api/database/current"))
 	if err != nil {
@@ -42,10 +53,7 @@ func (c *client) Database(ctx context.Context, name string) (Database, error) {
 	if err := resp.CheckStatus(200); err != nil {
 		return nil, WithStack(err)
 	}
-	db, err := newDatabase(name, c.conn)
-	if err != nil {
-		return nil, WithStack(err)
-	}
+
 	return db, nil
 }
 

context.go

@@ -69,6 +69,7 @@ const (
 	keyRefillIndexCaches        ContextKey = "arangodb-driver-refill-index-caches"
 	keyAsyncRequest             ContextKey = "arangodb-async-request"
 	keyAsyncID                  ContextKey = "arangodb-async-id"
+	keySkipExistCheck           ContextKey = "arangodb-skip-exist-check"
 )
 
 type OverwriteMode string
@@ -307,6 +308,12 @@ func WithAsyncID(parent context.Context, asyncID string) context.Context {
 	return context.WithValue(contextOrBackground(parent), keyAsyncID, asyncID)
 }
 
+// WithSkipExistCheck is used to disable validation for resource existence
+// e.g.: ClientDatabases.Database will do not call the additional check to ArangoDB for ensuring that DB exist
+func WithSkipExistCheck(parent context.Context, value bool) context.Context {
+	return context.WithValue(contextOrBackground(parent), keySkipExistCheck, value)
+}
+
 type contextSettings struct {
 	Silent                   bool
 	WaitForSync              bool

database_collections_impl.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2017 ArangoDB GmbH, Cologne, Germany
+// Copyright 2017-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
 
@@ -30,6 +28,19 @@ import (
 // Collection opens a connection to an existing collection within the database.
 // If no collection with given name exists, an NotFoundError is returned.
 func (d *database) Collection(ctx context.Context, name string) (Collection, error) {
+	coll, err := newCollection(name, d)
+	if err != nil {
+		return nil, WithStack(err)
+	}
+
+	if ctx != nil {
+		if v := ctx.Value(keySkipExistCheck); v != nil {
+			if skipIfExistCheck, ok := v.(bool); ok && skipIfExistCheck {
+				return coll, nil
+			}
+		}
+	}
+
 	escapedName := pathEscape(name)
 	req, err := d.conn.NewRequest("GET", path.Join(d.relPath(), "_api/collection", escapedName))
 	if err != nil {
@@ -42,10 +53,6 @@ func (d *database) Collection(ctx context.Context, name string) (Collection, err
 	if err := resp.CheckStatus(200); err != nil {
 		return nil, WithStack(err)
 	}
-	coll, err := newCollection(name, d)
-	if err != nil {
-		return nil, WithStack(err)
-	}
 	return coll, nil
 }
 

test/collection_test.go

@@ -59,6 +59,22 @@ func assertCollection(ctx context.Context, db driver.Database, name string, t *t
 	return c
 }
 
+func TestGetCollection(t *testing.T) {
+	c := createClient(t, nil)
+	db := ensureDatabase(nil, c, "collection_get_test", nil, t)
+
+	name := "test_wrong_collection"
+
+	_, err := db.Collection(nil, name)
+	require.Error(t, err)
+
+	_, err = db.Collection(driver.WithSkipExistCheck(nil, false), name)
+	require.Error(t, err)
+
+	_, err = db.Collection(driver.WithSkipExistCheck(nil, true), name)
+	require.NoError(t, err)
+}
+
 // TestCreateCollection creates a collection and then checks that it exists.
 func TestCreateCollection(t *testing.T) {
 	c := createClient(t, nil)

test/database_test.go

@@ -74,6 +74,21 @@ func skipIfEngineType(t *testing.T, db driver.Database, engineType driver.Engine
 	}
 }
 
+func TestGetDatabase(t *testing.T) {
+	c := createClient(t, nil)
+
+	name := "test_wrong_database"
+
+	_, err := c.Database(nil, name)
+	require.Error(t, err)
+
+	_, err = c.Database(driver.WithSkipExistCheck(nil, false), name)
+	require.Error(t, err)
+
+	_, err = c.Database(driver.WithSkipExistCheck(nil, true), name)
+	require.NoError(t, err)
+}
+
 // TestCreateDatabase creates a database and then checks that it exists.
 func TestCreateDatabase(t *testing.T) {
 	c := createClient(t, nil)

v2/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [master](https://github.com/arangodb/go-driver/tree/master) (N/A)
 - Switch to Go 1.21.5
 - Disable AF mode in tests (not supported since 3.12)
+- Allow skipping validation for Database and Collection existence
 
 ## [2.0.3](https://github.com/arangodb/go-driver/tree/v2.0.3) (2023-10-31)
 - Add optional status code checks. Consistent return of response

v2/arangodb/client_database.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2020 ArangoDB GmbH, Cologne, Germany
+// Copyright 2020-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 Adam Janikowski
-//
 
 package arangodb
 
@@ -29,8 +27,13 @@ import (
 type ClientDatabase interface {
 	// Database opens a connection to an existing database.
 	// If no database with given name exists, an NotFoundError is returned.
+	// deprecated: use GetDatabase instead
 	Database(ctx context.Context, name string) (Database, error)
 
+	// GetDatabase opens a connection to an existing database.
+	// If no database with given name exists, an NotFoundError is returned.
+	GetDatabase(ctx context.Context, name string, options *GetDatabaseOptions) (Database, error)
+
 	// DatabaseExists returns true if a database with given name exists.
 	DatabaseExists(ctx context.Context, name string) (bool, error)
 
@@ -63,6 +66,12 @@ type CreateDatabaseOptions struct {
 	Options CreateDatabaseDefaultOptions `json:"options,omitempty"`
 }
 
+// GetDatabaseOptions contains options that customize the getting of a database.
+type GetDatabaseOptions struct {
+	// SkipExistCheck skips checking if database exists
+	SkipExistCheck bool `json:"skipExistCheck,omitempty"`
+}
+
 // DatabaseReplicationVersion defines replication protocol version to use for this database
 // Available since ArangoDB version 3.11
 // Note: this feature is still considered experimental and should not be used in production

v2/arangodb/client_database_impl.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2020 ArangoDB GmbH, Cologne, Germany
+// Copyright 2020-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 Adam Janikowski
-//
 
 package arangodb
 
@@ -79,7 +77,7 @@ func (c clientDatabase) AccessibleDatabases(ctx context.Context) ([]Database, er
 }
 
 func (c clientDatabase) DatabaseExists(ctx context.Context, name string) (bool, error) {
-	_, err := c.Database(ctx, name)
+	_, err := c.GetDatabase(ctx, name, nil)
 	if err == nil {
 		return true, nil
 	}
@@ -97,6 +95,16 @@ func (c clientDatabase) Databases(ctx context.Context) ([]Database, error) {
 }
 
 func (c clientDatabase) Database(ctx context.Context, name string) (Database, error) {
+	return c.GetDatabase(ctx, name, nil)
+}
+
+func (c clientDatabase) GetDatabase(ctx context.Context, name string, options *GetDatabaseOptions) (Database, error) {
+	db := newDatabase(c.client, name)
+
+	if options != nil && options.SkipExistCheck {
+		return db, nil
+	}
+
 	url := connection.NewUrl("_db", name, "_api", "database", "current")
 
 	var response struct {
@@ -111,7 +119,7 @@ func (c clientDatabase) Database(ctx context.Context, name string) (Database, er
 
 	switch code := resp.Code(); code {
 	case http.StatusOK:
-		return newDatabase(c.client, name), nil
+		return db, nil
 	default:
 		return nil, response.AsArangoErrorWithCode(code)
 	}

v2/arangodb/database_collection.go

@@ -27,8 +27,13 @@ import (
 type DatabaseCollection interface {
 	// Collection opens a connection to an existing collection within the database.
 	// If no collection with given name exists, an NotFoundError is returned.
+	// deprecated: use GetCollection instead
 	Collection(ctx context.Context, name string) (Collection, error)
 
+	// GetCollection opens a connection to an existing collection within the database.
+	// If no collection with given name exists, an NotFoundError is returned.
+	GetCollection(ctx context.Context, name string, options *GetCollectionOptions) (Collection, error)
+
 	// CollectionExists returns true if a collection with given name exists within the database.
 	CollectionExists(ctx context.Context, name string) (bool, error)
 
@@ -43,3 +48,8 @@ type DatabaseCollection interface {
 	// If a collection with given name already exists within the database, a DuplicateError is returned.
 	CreateCollectionWithOptions(ctx context.Context, name string, props *CreateCollectionProperties, options *CreateCollectionOptions) (Collection, error)
 }
+
+type GetCollectionOptions struct {
+	// SkipExistCheck skips checking if collection exists
+	SkipExistCheck bool `json:"skipExistCheck,omitempty"`
+}

v2/arangodb/database_collection_impl.go

@@ -44,6 +44,16 @@ type databaseCollection struct {
 }
 
 func (d databaseCollection) Collection(ctx context.Context, name string) (Collection, error) {
+	return d.GetCollection(ctx, name, nil)
+}
+
+func (d databaseCollection) GetCollection(ctx context.Context, name string, options *GetCollectionOptions) (Collection, error) {
+	col := newCollection(d.db, name)
+
+	if options != nil && options.SkipExistCheck {
+		return col, nil
+	}
+
 	url := d.db.url("_api", "collection", name)
 
 	var response struct {
@@ -57,14 +67,14 @@ func (d databaseCollection) Collection(ctx context.Context, name string) (Collec
 
 	switch code := resp.Code(); code {
 	case http.StatusOK:
-		return newCollection(d.db, name), nil
+		return col, nil
 	default:
 		return nil, response.AsArangoErrorWithCode(code)
 	}
 }
 
 func (d databaseCollection) CollectionExists(ctx context.Context, name string) (bool, error) {
-	_, err := d.Collection(ctx, name)
+	_, err := d.GetCollection(ctx, name, nil)
 	if err == nil {
 		return true, nil
 	}