Add Rename collection (#558)

Author: NicolasGB

CHANGELOG.md

@@ -26,6 +26,7 @@
 - Bugfix: Force analyzer removal
 - Move examples to separate package
 - Deprecate ClientConfig.SynchronizeEndpointsInterval due to bug in implementation
+- [V1] Add Rename function for collections (single server only).
 
 ## [1.6.0](https://github.com/arangodb/go-driver/tree/v1.6.0) (2023-05-30)
 - Add ErrArangoDatabaseNotFound and IsExternalStorageError helper to v2

collection.go

@@ -77,6 +77,10 @@ type Collection interface {
 	// Truncate removes all documents from the collection, but leaves the indexes intact.
 	Truncate(ctx context.Context) error
 
+	// Rename renames the collection (SINGLE server only).
+	// If the collection does not exist, a NotFoundError is returned.
+	Rename(ctx context.Context, newName string) error
+
 	// All index functions
 	CollectionIndexes
 

collection_impl.go

@@ -334,6 +334,26 @@ func (c *collection) Truncate(ctx context.Context) error {
 	return nil
 }
 
+// Rename renames the collection. (SINGLE server only).
+// If the collection does not exist, a NotFoundError is returned.
+func (c *collection) Rename(ctx context.Context, newName string) error {
+	req, err := c.conn.NewRequest("PUT", path.Join(c.relPath("collection"), "rename"))
+	if err != nil {
+		return WithStack(err)
+	}
+
+	req.SetBody(map[string]string{"name": newName})
+
+	resp, err := c.conn.Do(ctx, req)
+	if err != nil {
+		return WithStack(err)
+	}
+	if err := resp.CheckStatus(200); err != nil {
+		return WithStack(err)
+	}
+	return nil
+}
+
 type setCollectionPropertiesOptionsInternal struct {
 	WaitForSync       *bool             `json:"waitForSync,omitempty"`
 	JournalSize       int64             `json:"journalSize,omitempty"`

edge_collection_impl.go

@@ -185,3 +185,12 @@ func (c *edgeCollection) Truncate(ctx context.Context) error {
 	}
 	return nil
 }
+
+// Rename renames the collection (SINGLE server only).
+// If the collection does not exist, a NotFoundError is returned.
+func (c *edgeCollection) Rename(ctx context.Context, newName string) error {
+	if err := c.rawCollection().Rename(ctx, newName); err != nil {
+		return WithStack(err)
+	}
+	return nil
+}

test/edge_collection_test.go

@@ -278,3 +278,50 @@ func TestSetVertexConstraints(t *testing.T) {
 		}
 	}
 }
+
+// TestRenameEdgeCollection creates a graph and then adds an edge collection in it and then renames the edge collection.
+func TestRenameEdgeCollection(t *testing.T) {
+	c := createClient(t, nil)
+
+	//Run only in single server
+	skipNoSingle(c, t)
+
+	db := ensureDatabase(nil, c, "edge_collection_test", nil, t)
+	name := "test_rename_edge_collection"
+	g, err := db.CreateGraphV2(nil, name, nil)
+	if err != nil {
+		t.Fatalf("Failed to create graph '%s': %s", name, describe(err))
+	}
+
+	// Now create an edge collection
+	colName := "rename_edge_collection"
+	ec, err := g.CreateEdgeCollection(nil, colName, driver.VertexConstraints{From: []string{"person"}, To: []string{"person"}})
+	if err != nil {
+		t.Fatalf("CreateEdgeCollection failed: %s", describe(err))
+	} else if ec.Name() != colName {
+		t.Errorf("Invalid name, expected '%s', got '%s'", colName, ec.Name())
+	}
+
+	// Collection must exist
+	if found, err := g.EdgeCollectionExists(nil, colName); err != nil {
+		t.Errorf("EdgeCollectionExists failed: %s", describe(err))
+	} else if !found {
+		t.Errorf("EdgeCollectionExists return false, expected true")
+	}
+
+	// Rename edge collection to new name
+	newColName := "rename_edge_collection_new"
+	if err := ec.Rename(nil, newColName); err != nil {
+		t.Errorf("Rename failed: %s", describe(err))
+	}
+
+	// Original edge collection must NOT exits
+	if found, err := g.EdgeCollectionExists(nil, colName); err != nil {
+		t.Errorf("EdgeCollectionExists failed: %s", describe(err))
+	} else if found {
+		t.Errorf("EdgeCollectionExists return true, expected false")
+	}
+
+	// Collection must still exist in database
+	assertCollection(nil, db, newColName, t)
+}

test/vertex_collection_test.go

@@ -188,3 +188,51 @@ func TestRemoveVertexCollection(t *testing.T) {
 	assertCollection(nil, db, "friends", t)
 
 }
+
+// TestRenameVertexCollection creates a graph and then adds an vertex collection in it and then renames the vertex collection.
+func TestRenameVertexCollection(t *testing.T) {
+	c := createClient(t, nil)
+
+	//Run only in single server
+	skipNoSingle(c, t)
+
+	db := ensureDatabase(nil, c, "vertex_collection_test", nil, t)
+	name := "test_rename_vertex_collection"
+	g, err := db.CreateGraphV2(nil, name, nil)
+	if err != nil {
+		t.Fatalf("Failed to create graph '%s': %s", name, describe(err))
+	}
+
+	// Now create an vertex collection
+	colName := "friends"
+	vc, err := g.CreateVertexCollection(nil, colName)
+	if err != nil {
+		t.Errorf("CreateVertexCollection failed: %s", describe(err))
+	} else if vc.Name() != "friends" {
+		t.Errorf("Invalid name, expected 'friends', got '%s'", vc.Name())
+	}
+
+	// Friends vertex collection must exits
+	if found, err := g.VertexCollectionExists(nil, colName); err != nil {
+		t.Errorf("VertexCollectionExists failed: %s", describe(err))
+	} else if !found {
+		t.Errorf("VertexCollectionExists return false, expected true")
+	}
+
+	// Rename vertex collection
+	newName := "old_friends"
+	if err := vc.Rename(nil, newName); err != nil {
+		t.Errorf("Rename failed: %s", describe(err))
+	}
+
+	// Friends vertex collection must NOT exits
+	if found, err := g.VertexCollectionExists(nil, colName); err != nil {
+		t.Errorf("VertexCollectionExists failed: %s", describe(err))
+	} else if found {
+		t.Errorf("VertexCollectionExists return true, expected false")
+	}
+
+	// Collection must still exist in database
+	assertCollection(nil, db, newName, t)
+
+}

vertex_collection_impl.go

@@ -185,3 +185,12 @@ func (c *vertexCollection) Truncate(ctx context.Context) error {
 	}
 	return nil
 }
+
+// Rename renames the collection (SINGLE server only).
+// If the collection does not exist, a NotFoundError is returned.
+func (c *vertexCollection) Rename(ctx context.Context, newName string) error {
+	if err := c.rawCollection().Rename(ctx, newName); err != nil {
+		return WithStack(err)
+	}
+	return nil
+}