Merge pull request #413 from ArangoDB-Community/feature3.10/DE-341-query-rules

Added support for new endpoint `GET /_api/query/rules` that returns the available optimizer rules for AQL queries.

Author: tjoubert

arangodb-net-standard.Test/AqlFunctionApi/AqlFunctionApiClientTest.cs

@@ -225,5 +225,23 @@ await _fixture.AqlFunctionClient.PutChangeQueryTrackingConfigurationAsync(
             Assert.False(putResponse.Error);
             Assert.Equal(HttpStatusCode.OK, putResponse.Code);
         }
+
+
+        [Fact]
+        public async Task GetQueryRulesAsync_ShouldSucceed()
+        {
+            if (_fixture.VersionMajor >= 3 && _fixture.VersionMinor >= 10)
+            {
+                var getResponse =
+                    await _fixture.AqlFunctionClient.GetQueryRulesAsync();
+
+                Assert.NotNull(getResponse);
+                Assert.All(getResponse, x =>
+                {
+                    Assert.NotNull(x.Name);
+                    Assert.NotNull(x.Flags);
+                });
+            }
+        }
     }
 }

arangodb-net-standard.Test/AqlFunctionApi/AqlFunctionApiClientTestFixture.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Threading.Tasks;
 using System.Collections.Generic;
+using ArangoDBNetStandard.AdminApi.Models;
 
 namespace ArangoDBNetStandardTest.AqlFunctionApi
 {
@@ -15,6 +16,9 @@ public class AqlFunctionApiClientTestFixture : ApiClientTestFixtureBase
         public AqlFunctionApiClient AqlFunctionClient { get; set; }
         public string TestCollectionName { get; internal set; } = "Pets";
         public string TestAqlQuery { get; internal set; }
+        public GetServerVersionResponse ServerVersion { get; internal set; }
+        public int VersionMajor { get; internal set; }
+        public int VersionMinor { get; internal set; }
 
         public override async Task InitializeAsync()
         {
@@ -23,7 +27,17 @@ public override async Task InitializeAsync()
             await CreateDatabase(dbName);
             var arangoClient = GetArangoDBClient(dbName);
             AqlFunctionClient = arangoClient.AqlFunction;
-
+            ServerVersion = await arangoClient.Admin.GetServerVersionAsync(
+                new GetServerVersionQuery()
+                {
+                    Details = true
+                });
+            if (ServerVersion != null)
+            {
+                var vParts = ServerVersion.Version.Split(".");
+                VersionMajor = int.Parse(vParts[0]);
+                VersionMinor = int.Parse(vParts[1]);
+            }
             try
             {
                 //create one collection for our tests...

arangodb-net-standard/AdminApi/Models/GetServerVersionResponse.cs

@@ -20,7 +20,7 @@ public class GetServerVersionResponse
         /// <summary>
         /// The version of the server.
         /// </summary>
-        public string Version { get; set; }
+        public string Version { get; set; }              
 
         /// <summary>
         /// Additional details about the DB server. 

arangodb-net-standard/AqlFunctionApi/AqlFunctionApiClient.cs

@@ -1,6 +1,7 @@
 using ArangoDBNetStandard.AqlFunctionApi.Models;
 using ArangoDBNetStandard.Serialization;
 using ArangoDBNetStandard.Transport;
+using System.Collections;
 using System.Collections.Generic;
 using System.Net;
 using System.Threading;
@@ -507,5 +508,30 @@ public virtual async Task<List<RunningAqlQuery>> GetCurrentlyRunningAqlQueriesAs
                 throw await GetApiErrorException(response).ConfigureAwait(false);
             }
         }
+
+        /// <summary>
+        /// Gets the available optimizer rules for AQL queries
+        /// GET /_api/query/rules
+        /// </summary>
+        /// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
+        /// <remarks>
+        /// Returns an array of objects that contain the name of each available 
+        /// rule and its respective flags.
+        /// </remarks>
+        /// <returns></returns>
+        public virtual async Task<List<GetQueryRule>> GetQueryRulesAsync(CancellationToken token = default)
+        {
+            string uri = "_api/query/rules";
+
+            using (var response = await _transport.GetAsync(uri).ConfigureAwait(false))
+            {
+                if (response.IsSuccessStatusCode)
+                {
+                    var stream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false);
+                    return DeserializeJsonFromStream<List<GetQueryRule>>(stream);
+                }
+                throw await GetApiErrorException(response).ConfigureAwait(false);
+            }
+        }
     }
 }

arangodb-net-standard/AqlFunctionApi/IAqlFunctionApiClient.cs

@@ -219,5 +219,18 @@ Task<QueryTrackingConfiguration> PutChangeQueryTrackingConfigurationAsync(
         Task<List<RunningAqlQuery>> GetCurrentlyRunningAqlQueriesAsync(
             GetCurrentlyRunningAqlQueriesQuery query = null,
             CancellationToken token = default);
+
+        /// <summary>
+        /// Gets the available optimizer rules for AQL queries
+        /// GET /_api/query/rules
+        /// </summary>
+        /// <param name="token">A CancellationToken to observe while waiting for the task to complete or to cancel the task.</param>
+        /// <remarks>
+        /// Returns an array of objects that contain the name of each available 
+        /// rule and its respective flags.
+        /// </remarks>
+        /// <returns></returns>
+        Task<List<GetQueryRule>> GetQueryRulesAsync(
+            CancellationToken token = default);
     }
 }

arangodb-net-standard/AqlFunctionApi/Models/GetAqlFunctionsResponse.cs

@@ -32,4 +32,4 @@ public class GetAqlFunctionsResponse
         /// </summary>
         public IList<AqlFunctionResult> Result { get; set; }
     }
-}
+}

arangodb-net-standard/AqlFunctionApi/Models/GetQueryRule.cs

@@ -0,0 +1,22 @@
+using System.Collections.Generic;
+
+namespace ArangoDBNetStandard.AqlFunctionApi.Models
+{
+    /// <summary>
+    /// Describes an AQL optimizer rule. 
+    /// This is a response item returned by 
+    /// <see cref="IAqlFunctionApiClient.GetQueryRulesAsync(System.Threading.CancellationToken)"/>
+    /// </summary>
+    public class GetQueryRule
+    {
+        /// <summary>
+        /// The name of the optimizer rule as seen in query explain outputs.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// An object with the properties of the rule.
+        /// </summary>
+        public GetQueryRuleFlags Flags { get; set; }
+    }
+}

arangodb-net-standard/AqlFunctionApi/Models/GetQueryRuleFlags.cs

@@ -0,0 +1,44 @@
+namespace ArangoDBNetStandard.AqlFunctionApi.Models
+{
+    /// <summary>
+    /// Describes the properties of an AQL optimizer rule.
+    /// </summary>
+    public class GetQueryRuleFlags
+    {
+        /// <summary>
+        /// Whether the rule is displayed to users. 
+        /// Internal rules are hidden.
+        /// </summary>
+        public bool Hidden { get; set; }
+
+        /// <summary>
+        /// Whether the rule is applicable in the
+        /// cluster deployment mode only.
+        /// </summary>
+        public bool ClusterOnly { get; set; }
+
+        /// <summary>
+        ///  Whether users are allowed to disable 
+        ///  this rule. A few rules are mandatory.
+        /// </summary>
+        public bool CanBeDisabled { get; set; }
+
+        /// <summary>
+        /// Whether this rule may create additional
+        /// query execution plans.
+        /// </summary>
+        public bool CanCreateAdditionalPlans { get; set; }
+
+        /// <summary>
+        /// Whether the optimizer considers this 
+        /// rule by default.
+        /// </summary>
+        public bool DisabledByDefault { get; set; }
+
+        /// <summary>
+        /// Whether the rule is available in the 
+        /// Enterprise Edition only.
+        /// </summary>
+        public bool EnterpriseOnly { get; set; }
+    }
+}