Admin Cluster API support (#604)

Author: jwierzbo

test/database_test.go

@@ -178,13 +178,15 @@ func TestDatabaseInfo(t *testing.T) {
 	}
 }
 
+// --database.extended-names-databases=true are enabled by default in 3.12
 func TestDatabaseNameUnicode(t *testing.T) {
 	c := createClient(t, nil)
-	databaseExtendedNamesRequired(t, c)
+
+	ctx := context.Background()
+	EnsureVersion(t, ctx, c).CheckVersion(MinimumVersion("3.12"))
 
 	dbName := "\u006E\u0303\u00f1" + GenerateUUID("test-db-unicode")
 	normalized := norm.NFC.String(dbName)
-	ctx := context.Background()
 	_, err := c.CreateDatabase(ctx, dbName, nil)
 	require.EqualError(t, err, "database name is not properly UTF-8 NFC-normalized")
 
@@ -251,29 +253,6 @@ func TestCreateDatabaseReplication2(t *testing.T) {
 	}
 }
 
-// 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) {
-	ctx := context.Background()
-	EnsureVersion(t, ctx, c).CheckVersion(MinimumVersion("3.9.0"))
-
-	// If the database can be created with the below name then it means that it excepts unicode names.
-	dbName := "\u006E\u0303\u00f1"
-	normalized := norm.NFC.String(dbName)
-	db, err := c.CreateDatabase(ctx, normalized, nil)
-	if err == nil {
-		require.NoErrorf(t, db.Remove(ctx), "failed to remove testing unicode database")
-		return
-	}
-
-	if driver.IsArangoErrorWithErrorNum(err, driver.ErrArangoDatabaseNameInvalid, driver.ErrArangoIllegalName) {
-		t.Skipf("ArangoDB is not launched with the option --database.extended-names-databases=true")
-	}
-
-	// Some other error that has not been expected.
-	require.NoError(t, err)
-}
-
 // databaseReplication2Required skips test if the version is < 3.12.0.
 // It also skips the test if the ArangoDB has not been launched with the option--database.default-replication-version=2.
 func databaseReplication2Required(t *testing.T, c driver.Client) {

v2/CHANGELOG.md

@@ -17,6 +17,7 @@
 - multi_delimiter analyzer support
 - Wildcard analyzer support
 - Backup API support
+- Admin Cluster API support
 
 
 ## [2.0.3](https://github.com/arangodb/go-driver/tree/v2.0.3) (2023-10-31)

v2/arangodb/client_admin.go

@@ -28,10 +28,7 @@ type ClientAdmin interface {
 	ClientAdminLog
 	ClientAdminBackup
 	ClientAdminLicense
-
-	// Health returns the cluster configuration & health.
-	// It works in cluster or active fail-over mode.
-	Health(ctx context.Context) (ClusterHealth, error)
+	ClientAdminCluster
 
 	// ServerMode returns the current mode in which the server/cluster is operating.
 	// This call needs ArangoDB 3.3 and up.
@@ -43,6 +40,40 @@ type ClientAdmin interface {
 	SetServerMode(ctx context.Context, mode ServerMode) error
 }
 
+type ClientAdminCluster interface {
+	// Health returns the cluster configuration & health. Not available in single server deployments (403 Forbidden).
+	Health(ctx context.Context) (ClusterHealth, error)
+
+	// DatabaseInventory the inventory of the cluster collections (with entire details) from a specific database.
+	DatabaseInventory(ctx context.Context, dbName string) (DatabaseInventory, error)
+
+	// MoveShard moves a single shard of the given collection between `fromServer` and `toServer`.
+	MoveShard(ctx context.Context, col Collection, shard ShardID, fromServer, toServer ServerID) (string, error)
+
+	// CleanOutServer triggers activities to clean out a DBServer.
+	CleanOutServer(ctx context.Context, serverID ServerID) (string, error)
+
+	// ResignServer triggers activities to let a DBServer resign for all shards.
+	ResignServer(ctx context.Context, serverID ServerID) (string, error)
+
+	// NumberOfServers returns the number of coordinators & dbServers in a clusters and the ID's of cleanedOut servers.
+	NumberOfServers(ctx context.Context) (NumberOfServersResponse, error)
+
+	// IsCleanedOut checks if the dbServer with given ID has been cleaned out.
+	IsCleanedOut(ctx context.Context, serverID ServerID) (bool, error)
+
+	// RemoveServer is a low-level option to remove a server from a cluster.
+	// This function is suitable for servers of type coordinator or dbServer.
+	// The use of `ClientServerAdmin.Shutdown` is highly recommended above this function.
+	RemoveServer(ctx context.Context, serverID ServerID) error
+}
+
+type NumberOfServersResponse struct {
+	NoCoordinators   int        `json:"numberOfCoordinators,omitempty"`
+	NoDBServers      int        `json:"numberOfDBServers,omitempty"`
+	CleanedServerIDs []ServerID `json:"cleanedServers,omitempty"`
+}
+
 type ClientAdminLog interface {
 	// GetLogLevels returns log levels for topics.
 	GetLogLevels(ctx context.Context, opts *LogLevelsGetOptions) (LogLevels, error)
@@ -55,3 +86,54 @@ type ClientAdminLicense interface {
 	// GetLicense returns license of an ArangoDB deployment.
 	GetLicense(ctx context.Context) (License, error)
 }
+
+type DatabaseInventory struct {
+	Info        DatabaseInfo          `json:"properties,omitempty"`
+	Collections []InventoryCollection `json:"collections,omitempty"`
+	Views       []InventoryView       `json:"views,omitempty"`
+	State       ServerStatus          `json:"state,omitempty"`
+	Tick        string                `json:"tick,omitempty"`
+}
+
+type InventoryCollection struct {
+	Parameters  InventoryCollectionParameters `json:"parameters"`
+	Indexes     []InventoryIndex              `json:"indexes,omitempty"`
+	PlanVersion int64                         `json:"planVersion,omitempty"`
+	IsReady     bool                          `json:"isReady,omitempty"`
+	AllInSync   bool                          `json:"allInSync,omitempty"`
+}
+
+type InventoryCollectionParameters struct {
+	Deleted bool                   `json:"deleted,omitempty"`
+	Shards  map[ShardID][]ServerID `json:"shards,omitempty"`
+	PlanID  string                 `json:"planId,omitempty"`
+
+	CollectionProperties
+}
+
+type InventoryIndex struct {
+	ID              string   `json:"id,omitempty"`
+	Type            string   `json:"type,omitempty"`
+	Fields          []string `json:"fields,omitempty"`
+	Unique          bool     `json:"unique"`
+	Sparse          bool     `json:"sparse"`
+	Deduplicate     bool     `json:"deduplicate"`
+	MinLength       int      `json:"minLength,omitempty"`
+	GeoJSON         bool     `json:"geoJson,omitempty"`
+	Name            string   `json:"name,omitempty"`
+	ExpireAfter     int      `json:"expireAfter,omitempty"`
+	Estimates       bool     `json:"estimates,omitempty"`
+	FieldValueTypes string   `json:"fieldValueTypes,omitempty"`
+	CacheEnabled    *bool    `json:"cacheEnabled,omitempty"`
+}
+
+type InventoryView struct {
+	Name     string   `json:"name,omitempty"`
+	Deleted  bool     `json:"deleted,omitempty"`
+	ID       string   `json:"id,omitempty"`
+	IsSystem bool     `json:"isSystem,omitempty"`
+	PlanID   string   `json:"planId,omitempty"`
+	Type     ViewType `json:"type,omitempty"`
+
+	ArangoSearchViewProperties
+}

v2/arangodb/client_admin_backup.go

@@ -43,6 +43,8 @@ type ClientAdminBackup interface {
 
 	// BackupDownload triggers a download of backup into the remote repository using the given config
 	BackupDownload(ctx context.Context, backupId string, remoteRepository string, config interface{}) (TransferMonitor, error)
+
+	TransferMonitor(jobId string, transferType TransferType) (TransferMonitor, error)
 }
 
 type TransferMonitor interface {
@@ -53,6 +55,13 @@ type TransferMonitor interface {
 	Abort(ctx context.Context) error
 }
 
+type TransferType string
+
+const (
+	TransferTypeUpload   TransferType = "upload"
+	TransferTypeDownload TransferType = "download"
+)
+
 type BackupCreateOptions struct {
 	// The label for this backup.
 	// The label is used together with a timestamp string create a unique backup identifier, <timestamp>_<label>.

v2/arangodb/client_admin_backup_impl.go

@@ -30,7 +30,7 @@ import (
 	"github.com/arangodb/go-driver/v2/connection"
 )
 
-func (c clientAdmin) BackupCreate(ctx context.Context, opt *BackupCreateOptions) (BackupResponse, error) {
+func (c *clientAdmin) BackupCreate(ctx context.Context, opt *BackupCreateOptions) (BackupResponse, error) {
 	url := connection.NewUrl("_admin", "backup", "create")
 
 	var response struct {
@@ -56,7 +56,7 @@ func (c clientAdmin) BackupCreate(ctx context.Context, opt *BackupCreateOptions)
 	}
 }
 
-func (c clientAdmin) BackupRestore(ctx context.Context, id string) (BackupRestoreResponse, error) {
+func (c *clientAdmin) BackupRestore(ctx context.Context, id string) (BackupRestoreResponse, error) {
 	url := connection.NewUrl("_admin", "backup", "restore")
 
 	var response struct {
@@ -83,7 +83,7 @@ func (c clientAdmin) BackupRestore(ctx context.Context, id string) (BackupRestor
 	}
 }
 
-func (c clientAdmin) BackupDelete(ctx context.Context, id string) error {
+func (c *clientAdmin) BackupDelete(ctx context.Context, id string) error {
 	url := connection.NewUrl("_admin", "backup", "delete")
 
 	var response struct {
@@ -109,7 +109,7 @@ func (c clientAdmin) BackupDelete(ctx context.Context, id string) error {
 	}
 }
 
-func (c clientAdmin) BackupList(ctx context.Context, opt *BackupListOptions) (ListBackupsResponse, error) {
+func (c *clientAdmin) BackupList(ctx context.Context, opt *BackupListOptions) (ListBackupsResponse, error) {
 	url := connection.NewUrl("_admin", "backup", "list")
 
 	var response struct {
@@ -135,7 +135,7 @@ func (c clientAdmin) BackupList(ctx context.Context, opt *BackupListOptions) (Li
 	}
 }
 
-func (c clientAdmin) BackupUpload(ctx context.Context, backupId string, remoteRepository string, config interface{}) (TransferMonitor, error) {
+func (c *clientAdmin) BackupUpload(ctx context.Context, backupId string, remoteRepository string, config interface{}) (TransferMonitor, error) {
 	url := connection.NewUrl("_admin", "backup", "upload")
 
 	var response struct {
@@ -168,7 +168,7 @@ func (c clientAdmin) BackupUpload(ctx context.Context, backupId string, remoteRe
 	}
 }
 
-func (c clientAdmin) BackupDownload(ctx context.Context, backupId string, remoteRepository string, config interface{}) (TransferMonitor, error) {
+func (c *clientAdmin) BackupDownload(ctx context.Context, backupId string, remoteRepository string, config interface{}) (TransferMonitor, error) {
 	url := connection.NewUrl("_admin", "backup", "download")
 
 	var response struct {
@@ -201,6 +201,17 @@ func (c clientAdmin) BackupDownload(ctx context.Context, backupId string, remote
 	}
 }
 
+func (c *clientAdmin) TransferMonitor(jobId string, transferType TransferType) (TransferMonitor, error) {
+	switch transferType {
+	case TransferTypeUpload:
+		return newUploadMonitor(c.client, jobId)
+	case TransferTypeDownload:
+		return newDownloadMonitor(c.client, jobId)
+	default:
+		return nil, errors.Errorf("unsupported transfer type '%s'", transferType)
+	}
+}
+
 type uploadMonitor struct {
 	client *client
 	jobId  string