Drivers 3.9: Hybrid SmartGraphs (TG-201) (#351)

Author: jwierzbo

database_graphs.go

@@ -70,6 +70,8 @@ type CreateGraphOptions struct {
 	WriteConcern int
 	// IsDisjoint set isDisjoint flag for Graph. Required ArangoDB 3.7+
 	IsDisjoint bool
+	// Satellites contains an array of collection names that will be used to create SatelliteCollections for a Hybrid (Disjoint) SmartGraph (Enterprise Edition only)
+	Satellites []string `json:"satellites"`
 }
 
 // EdgeDefinition contains all information needed to define a single edge in a graph.
@@ -80,4 +82,6 @@ type EdgeDefinition struct {
 	To []string `json:"to"`
 	// From contains the names of one or more vertex collections that can contain source vertices.
 	From []string `json:"from"`
+	// Options contains optional parameters
+	Options CreateEdgeCollectionOptions `json:"options,omitempty"`
 }

database_graphs_impl.go

@@ -166,6 +166,8 @@ type createGraphAdditionalOptions struct {
 	WriteConcern int `json:"writeConcern,omitempty"`
 	// IsDisjoint set isDisjoint flag for Graph. Required ArangoDB 3.7+
 	IsDisjoint bool `json:"isDisjoint,omitempty"`
+	// Satellites contains an array of collection names that will be used to create SatelliteCollections for a Hybrid (Disjoint) SmartGraph (Enterprise Edition only)
+	Satellites []string `json:"satellites"`
 }
 
 // CreateGraph creates a new graph with given name and options, and opens a connection to it.
@@ -183,6 +185,7 @@ func (d *database) CreateGraph(ctx context.Context, name string, options *Create
 				SmartGraphAttribute: options.SmartGraphAttribute,
 				ReplicationFactor:   graphReplicationFactor(options.ReplicationFactor),
 				IsDisjoint:          options.IsDisjoint,
+				Satellites:          options.Satellites,
 			}
 		} else if options.SmartGraphAttribute != "" || options.NumberOfShards != 0 {
 			input.Options = &createGraphAdditionalOptions{
@@ -191,6 +194,7 @@ func (d *database) CreateGraph(ctx context.Context, name string, options *Create
 				ReplicationFactor:   graphReplicationFactor(options.ReplicationFactor),
 				WriteConcern:        options.WriteConcern,
 				IsDisjoint:          options.IsDisjoint,
+				Satellites:          options.Satellites,
 			}
 		}
 	}

graph_edge_collections.go

@@ -44,6 +44,9 @@ type GraphEdgeCollections interface {
 	// constraints.To: contains the names of one or more edge collections that can contain target vertices.
 	CreateEdgeCollection(ctx context.Context, collection string, constraints VertexConstraints) (Collection, error)
 
+	// CreateEdgeCollectionWithOptions creates an edge collection in the graph with additional options
+	CreateEdgeCollectionWithOptions(ctx context.Context, collection string, constraints VertexConstraints, options CreateEdgeCollectionOptions) (Collection, error)
+
 	// SetVertexConstraints modifies the vertex constraints of an existing edge collection in the graph.
 	SetVertexConstraints(ctx context.Context, collection string, constraints VertexConstraints) error
 }
@@ -55,3 +58,9 @@ type VertexConstraints struct {
 	// To contains names of vertex collection that are allowed to be used in the To part of an edge.
 	To []string
 }
+
+// CreateEdgeCollectionOptions contains optional parameters for creating a new edge collection
+type CreateEdgeCollectionOptions struct {
+	// Satellites contains an array of collection names that will be used to create SatelliteCollections for a Hybrid (Disjoint) SmartGraph (Enterprise Edition only)
+	Satellites []string `json:"satellites"`
+}

graph_edge_collections_impl.go

@@ -162,6 +162,35 @@ func (g *graph) CreateEdgeCollection(ctx context.Context, collection string, con
 	return ec, nil
 }
 
+// CreateEdgeCollectionWithOptions creates an edge collection in the graph with additional options
+func (g *graph) CreateEdgeCollectionWithOptions(ctx context.Context, collection string, constraints VertexConstraints, options CreateEdgeCollectionOptions) (Collection, error) {
+	req, err := g.conn.NewRequest("POST", path.Join(g.relPath(), "edge"))
+	if err != nil {
+		return nil, WithStack(err)
+	}
+	input := EdgeDefinition{
+		Collection: collection,
+		From:       constraints.From,
+		To:         constraints.To,
+		Options:    options,
+	}
+	if _, err := req.SetBody(input); err != nil {
+		return nil, WithStack(err)
+	}
+	resp, err := g.conn.Do(ctx, req)
+	if err != nil {
+		return nil, WithStack(err)
+	}
+	if err := resp.CheckStatus(201, 202); err != nil {
+		return nil, WithStack(err)
+	}
+	ec, err := newEdgeCollection(collection, g)
+	if err != nil {
+		return nil, WithStack(err)
+	}
+	return ec, nil
+}
+
 // SetVertexConstraints modifies the vertex constraints of an existing edge collection in the graph.
 func (g *graph) SetVertexConstraints(ctx context.Context, collection string, constraints VertexConstraints) error {
 	req, err := g.conn.NewRequest("PUT", path.Join(g.relPath(), "edge", collection))

graph_vertex_collections.go

@@ -41,4 +41,13 @@ type GraphVertexCollections interface {
 	// CreateVertexCollection creates a vertex collection in the graph.
 	// collection: The name of the vertex collection to be used.
 	CreateVertexCollection(ctx context.Context, collection string) (Collection, error)
+
+	// CreateVertexCollectionWithOptions creates a vertex collection in the graph
+	CreateVertexCollectionWithOptions(ctx context.Context, collection string, options CreateVertexCollectionOptions) (Collection, error)
+}
+
+// CreateVertexCollectionOptions contains optional parameters for creating a new vertex collection
+type CreateVertexCollectionOptions struct {
+	// Satellites contains an array of collection names that will be used to create SatelliteCollections for a Hybrid (Disjoint) SmartGraph (Enterprise Edition only)
+	Satellites []string `json:"satellites"`
 }

graph_vertex_collections_impl.go

@@ -143,3 +143,33 @@ func (g *graph) CreateVertexCollection(ctx context.Context, collection string) (
 	}
 	return ec, nil
 }
+
+// CreateVertexCollectionWithOptions creates a vertex collection in the graph
+func (g *graph) CreateVertexCollectionWithOptions(ctx context.Context, collection string, options CreateVertexCollectionOptions) (Collection, error) {
+	req, err := g.conn.NewRequest("POST", path.Join(g.relPath(), "vertex"))
+	if err != nil {
+		return nil, WithStack(err)
+	}
+	input := struct {
+		Collection string                        `json:"collection,omitempty"`
+		Options    CreateVertexCollectionOptions `json:"options,omitempty"`
+	}{
+		Collection: collection,
+		Options:    options,
+	}
+	if _, err := req.SetBody(input); err != nil {
+		return nil, WithStack(err)
+	}
+	resp, err := g.conn.Do(ctx, req)
+	if err != nil {
+		return nil, WithStack(err)
+	}
+	if err := resp.CheckStatus(201, 202); err != nil {
+		return nil, WithStack(err)
+	}
+	ec, err := newVertexCollection(collection, g)
+	if err != nil {
+		return nil, WithStack(err)
+	}
+	return ec, nil
+}