Add replication version option for database creation. (#494)

Author: Lars Maier

CHANGELOG.md

@@ -7,6 +7,7 @@
 - [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
+- Add replication V2 option for database creation
 
 ## [1.5.2](https://github.com/arangodb/go-driver/tree/v1.5.2) (2023-03-01)
 - Bump `DRIVER_VERSION`

client_databases.go

@@ -62,6 +62,16 @@ type CreateDatabaseOptions struct {
 	Options CreateDatabaseDefaultOptions `json:"options,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
+type DatabaseReplicationVersion string
+
+const (
+	DatabaseReplicationVersionOne DatabaseReplicationVersion = "1"
+	DatabaseReplicationVersionTwo DatabaseReplicationVersion = "2"
+)
+
 // CreateDatabaseDefaultOptions contains options that change defaults for collections
 type CreateDatabaseDefaultOptions struct {
 	// Default replication factor for collections in database
@@ -70,6 +80,9 @@ type CreateDatabaseDefaultOptions struct {
 	WriteConcern int `json:"writeConcern,omitempty"`
 	// Default sharding for collections in database
 	Sharding DatabaseSharding `json:"sharding,omitempty"`
+	// Replication version to use for this database
+	// Available since ArangoDB version 3.11
+	ReplicationVersion DatabaseReplicationVersion `json:"replicationVersion,omitempty"`
 }
 
 // CreateDatabaseUserOptions contains options for creating a single user for a database.

database.go

@@ -94,6 +94,8 @@ type DatabaseInfo struct {
 	WriteConcern int `json:"writeConcern,omitempty"`
 	// Default sharding for collections in database
 	Sharding DatabaseSharding `json:"sharding,omitempty"`
+	// Replication version used for this database
+	ReplicationVersion DatabaseReplicationVersion `json:"replicationVersion,omitempty"`
 }
 
 // EngineType indicates type of database engine being used.

test/database_test.go

@@ -204,6 +204,44 @@ func TestDatabaseNameUnicode(t *testing.T) {
 	require.NoErrorf(t, db.Remove(ctx), "failed to remove testing database")
 }
 
+// TestCreateDatabaseReplication2 creates a database with replication version two.
+func TestCreateDatabaseReplication2(t *testing.T) {
+	ctx := context.Background()
+	c := createClientFromEnv(t, true)
+	version, _ := c.Version(ctx)
+	if version.Version.CompareTo("3.11.0") < 0 {
+		t.Skipf("Version of the ArangoDB should be at least 3.11.0")
+	}
+
+	name := "create_test1"
+	opts := driver.CreateDatabaseOptions{Options: driver.CreateDatabaseDefaultOptions{
+		ReplicationVersion: driver.DatabaseReplicationVersionTwo,
+	}}
+	if _, err := c.CreateDatabase(nil, name, &opts); err != nil {
+		t.Fatalf("Failed to create database '%s': %s", name, describe(err))
+	}
+	// Database must exist now
+	if found, err := c.DatabaseExists(nil, name); err != nil {
+		t.Errorf("DatabaseExists('%s') failed: %s", name, describe(err))
+	} else if !found {
+		t.Errorf("DatabaseExists('%s') return false, expected true", name)
+	}
+
+	// Read database properties
+	db, err := c.Database(nil, name)
+	if err != nil {
+		t.Fatal("Failed to get database ")
+	}
+	info, err := db.Info(nil)
+	if err != nil {
+		t.Fatal("Failed to get database name")
+	}
+
+	if info.ReplicationVersion != driver.DatabaseReplicationVersionTwo {
+		t.Errorf("Wrong replication version, expected %s, found %s", driver.DatabaseReplicationVersionTwo, info.ReplicationVersion)
+	}
+}
+
 // databaseExtendedNamesRequired skips test if the version is < 3.9.0 or the ArangoDB has not been launched
 // with the option --database.extended-names-databases=true.
 func databaseExtendedNamesRequired(t *testing.T, c driver.Client) {

v2/arangodb/client_database.go

@@ -63,6 +63,16 @@ type CreateDatabaseOptions struct {
 	Options CreateDatabaseDefaultOptions `json:"options,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
+type DatabaseReplicationVersion string
+
+const (
+	DatabaseReplicationVersionOne DatabaseReplicationVersion = "1"
+	DatabaseReplicationVersionTwo DatabaseReplicationVersion = "2"
+)
+
 // CreateDatabaseDefaultOptions contains options that change defaults for collections
 type CreateDatabaseDefaultOptions struct {
 	// Default replication factor for collections in database
@@ -71,6 +81,9 @@ type CreateDatabaseDefaultOptions struct {
 	WriteConcern int `json:"writeConcern,omitempty"`
 	// Default sharding for collections in database
 	Sharding DatabaseSharding `json:"sharding,omitempty"`
+	// Replication version to use for this database
+	// Available since ArangoDB version 3.11
+	ReplicationVersion DatabaseReplicationVersion `json:"replicationVersion,omitempty"`
 }
 
 // CreateDatabaseUserOptions contains options for creating a single user for a database.

v2/arangodb/database_opts.go

@@ -38,6 +38,8 @@ type DatabaseInfo struct {
 	WriteConcern int `json:"writeConcern,omitempty"`
 	// Default sharding for collections in database
 	Sharding DatabaseSharding `json:"sharding,omitempty"`
+	// Replication version used for this database
+	ReplicationVersion DatabaseReplicationVersion `json:"replicationVersion,omitempty"`
 }
 
 // EngineType indicates type of database engine being used.

v2/tests/database_transactions_test.go

@@ -35,6 +35,29 @@ import (
 	"github.com/arangodb/go-driver/v2/arangodb/shared"
 )
 
+func Test_DatabaseCreateReplicationV2(t *testing.T) {
+	client := newClient(t, connectionJsonHttp(t))
+	skipBelowVersion(client, context.Background(), "3.11.0", t)
+
+	Wrap(t, func(t *testing.T, client arangodb.Client) {
+		opts := arangodb.CreateDatabaseOptions{
+			Users: nil,
+			Options: arangodb.CreateDatabaseDefaultOptions{
+				ReplicationVersion: arangodb.DatabaseReplicationVersionTwo,
+			},
+		}
+		WithDatabase(t, client, &opts, func(db arangodb.Database) {
+			t.Run("Transaction", func(t *testing.T) {
+				withContextT(t, 30*time.Second, func(ctx context.Context, t testing.TB) {
+					info, err := db.Info(ctx)
+					require.NoErrorf(t, err, "failed to get database info")
+					require.Equal(t, arangodb.DatabaseReplicationVersionTwo, info.ReplicationVersion)
+				})
+			})
+		})
+	})
+}
+
 func Test_DatabaseTransactions_DataIsolation(t *testing.T) {
 	Wrap(t, func(t *testing.T, client arangodb.Client) {
 		WithDatabase(t, client, nil, func(db arangodb.Database) {