Merge pull request ArangoDB-Community#405 from ArangoDB-Community/feature-3.8/DE-253-add-support-for-satellite-graphs

Added support for satellite graphs in graph API

Author: tjoubert

arangodb-net-standard/GraphApi/GraphApiClient.cs

@@ -55,7 +55,7 @@ public GraphApiClient(IApiClientTransport transport, IApiClientSerialization ser
         /// <remarks>
         /// The creation of a graph requires the name of the graph and a definition of its edges.
         /// </remarks>
-        /// <param name="postGraphBody">The information of the graph to create.</param>
+        /// <param name="postGraphBody">The information of the graph to create. Must be an instance of <see cref="PostSatelliteGraphOptions"/> or <see cref="PostNonSatelliteGraphOptions"/>.</param>
         /// <param name="query">Optional query parameters of the request.</param>
         /// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
         /// <returns></returns>

arangodb-net-standard/GraphApi/Models/PostGraphBody.cs

@@ -6,7 +6,8 @@ namespace ArangoDBNetStandard.GraphApi.Models
     /// Represents a request body to create a named graph.
     /// </summary>
     /// <remarks>
-    /// The creation of a graph requires the name of the graph and a definition of its edges.
+    /// The creation of a graph requires the name of the graph
+    /// and a definition of its edges.
     /// </remarks>
     public class PostGraphBody
     {
@@ -34,9 +35,20 @@ public class PostGraphBody
         /// </remarks>
         public bool? IsSmart { get; set; }
 
+        /// <summary>
+        /// (Optional) Whether to create a Disjoint SmartGraph instead 
+        /// of a regular SmartGraph (Enterprise Edition only).
+        /// </summary>
+        /// <remarks>
+        /// (cluster only)
+        /// </remarks>
+        public bool? IsDisjoint { get; set; }
+
         /// <summary>
         /// (Optional) Defines options for creating collections within this graph.
+        /// Must be an instance of <see cref="PostSatelliteGraphOptions"/> or
+        /// <see cref="PostNonSatelliteGraphOptions"/>
         /// </summary>
         public PostGraphOptions Options { get; set; }
     }
-}
+}

arangodb-net-standard/GraphApi/Models/PostGraphOptions.cs

@@ -1,9 +1,11 @@
-namespace ArangoDBNetStandard.GraphApi.Models
+using System.Collections.Generic;
+
+namespace ArangoDBNetStandard.GraphApi.Models
 {
     /// <summary>
     /// Defines options for creating collections within a graph.
     /// </summary>
-    public class PostGraphOptions
+    public abstract class PostGraphOptions
     {
         /// <summary>
         /// The attribute name that is used to smartly shard the vertices of a graph.
@@ -18,21 +20,12 @@ public class PostGraphOptions
         public string SmartGraphAttribute { get; set; }
 
         /// <summary>
-        /// The number of shards that is used for every collection within this graph.
-        /// Cannot be modified later.
-        /// </summary>
-        /// <remarks>
-        /// (cluster only)
-        /// </remarks>
-        public int NumberOfShards { get; set; }
-
-        /// <summary>
-        /// The replication factor used when initially creating collections for this graph
-        /// (Enterprise Edition only).
+        /// (Optional) An array of collection names that will be used 
+        /// to create SatelliteCollections for a 
+        /// Hybrid (Disjoint) SmartGraph (Enterprise Edition only). 
+        /// Each array element must be a string and a valid collection name. 
+        /// The collection type cannot be modified later.
         /// </summary>
-        /// <remarks>
-        /// (cluster only)
-        /// </remarks>
-        public int ReplicationFactor { get; set; }
+        public IEnumerable<string> Satellites { get; set; }
     }
-}
+}

arangodb-net-standard/GraphApi/Models/PostNonSatelliteGraphOptions.cs

@@ -0,0 +1,41 @@
+namespace ArangoDBNetStandard.GraphApi.Models
+{
+    /// <summary>
+    /// Options to create a non-satellite graph.
+    /// </summary>
+    public class PostNonSatelliteGraphOptions : PostGraphOptions
+    {
+        /// <summary>
+        /// The replication factor used when initially creating collections for this graph
+        /// (Enterprise Edition only).
+        /// </summary>
+        /// <remarks>
+        /// (cluster only)
+        /// </remarks>
+        public int ReplicationFactor { get; set; }
+
+        /// <summary>
+        /// The number of shards that is used for every collection within this graph.
+        /// Cannot be modified later.
+        /// </summary>
+        /// <remarks>
+        /// (cluster only)
+        /// </remarks>
+        public int NumberOfShards { get; set; }
+
+        /// <summary>
+        /// Write concern for new collections in the graph.
+        /// It determines how many copies of each shard are 
+        /// required to be in sync on the different DB-Servers. 
+        /// If there are less then these many copies in the cluster
+        /// a shard will refuse to write. Writes to shards with
+        /// enough up-to-date copies will succeed at the same time however. 
+        /// The value of writeConcern can not be larger than 
+        /// <see cref="ReplicationFactor"/>.
+        /// </summary>
+        /// <remarks>
+        /// (cluster only)
+        /// </remarks>
+        public int? WriteConcern { get; set; }
+    }
+}

arangodb-net-standard/GraphApi/Models/PostSatelliteGraphOptions.cs

@@ -0,0 +1,14 @@
+namespace ArangoDBNetStandard.GraphApi.Models
+{
+    /// <summary>
+    /// Options to create a satellite graph.
+    /// </summary>
+    public class PostSatelliteGraphOptions : PostGraphOptions
+    {
+        /// <summary>
+        ///  Always set to "satellite" to create 
+        ///  a SatelliteGraph (Enterprise Edition only).
+        /// </summary>
+        public string ReplicationFactor { get; } = "satellite";
+    }
+}