added query profiling

jsteemann · jsteemann · commit 1bf5198ebb2d · 2021-04-28T09:11:49.000+02:00
diff --git a/lib/ArangoDBClient/Statement.php b/lib/ArangoDBClient/Statement.php
@@ -149,6 +149,13 @@ class Statement
      * @var bool
      */
     private $_failOnWarning = false;
+    
+    /**
+     * Whether or not the query should return profiling information
+     *
+     * @var bool
+     */
+    private $_profile = false;
 
     /**
      * Approximate memory limit value (in bytes) that a query can use on the server-side
@@ -202,6 +209,11 @@ class Statement
      */
     const ENTRY_FAIL_ON_WARNING = 'failOnWarning';
     
+    /**
+     * Profile flag
+     */
+    const ENTRY_PROFILE = 'profile';
+    
     /**
      * Memory limit threshold for query
      */
@@ -309,6 +321,10 @@ public function __construct(Connection $connection, array $data)
             $this->_failOnWarning = (bool) $data[self::ENTRY_FAIL_ON_WARNING];
         }
         
+        if (isset($data[self::ENTRY_PROFILE])) {
+            $this->_profile = (bool) $data[self::ENTRY_PROFILE];
+        }
+        
         if (isset($data[self::ENTRY_MEMORY_LIMIT])) {
             $this->_memoryLimit = (int) $data[self::ENTRY_MEMORY_LIMIT];
         }
@@ -658,6 +674,28 @@ public function getFailOnWarning()
         return $this->_failOnWarning;
     }
     
+    /**
+     * Set whether or not query profiling should be enabled
+     *
+     * @param bool $value - value for profiling
+     *
+     * @return void
+     */
+    public function setProfile($value = true)
+    {
+        $this->_profile = (bool) $value;
+    }
+    
+    /**
+     * Get the configured value for profiling
+     *
+     * @return bool - current value of profiling option
+     */
+    public function getProfiling()
+    {
+        return $this->_profile;
+    }
+    
     /**
      * Set the approximate memory limit threshold to be used by the query on the server-side
      * (a value of 0 or less will mean the memory is not limited)
@@ -729,7 +767,8 @@ private function buildData()
             self::ENTRY_COUNT => $this->_doCount,
             'options'         => [
                 self::FULL_COUNT => $this->_fullCount,
-                self::ENTRY_FAIL_ON_WARNING => $this->_failOnWarning
+                self::ENTRY_FAIL_ON_WARNING => $this->_failOnWarning,
+                self::ENTRY_PROFILE => $this->_profile
             ]
         ];
         
diff --git a/tests/StatementTest.php b/tests/StatementTest.php
@@ -609,6 +609,35 @@ public function testMaxRuntime()
         static::assertTrue($excepted);
     }
     
+    public function testProfiling()
+    {
+        $connection = $this->connection;
+
+        $statement = new Statement(
+            $connection, [ 
+                'query' => 'FOR i IN 1..10000 RETURN CONCAT("testisiteisiitit", i)',
+                '_flat' => true
+            ]
+        );
+        static::assertFalse($statement->getProfiling());
+
+        $statement = new Statement(
+            $connection, [ 
+                'query' => 'FOR i IN 1..10000 RETURN CONCAT("testisiteisiitit", i)',
+                'profile' => true,
+                '_flat' => true
+            ]
+        );
+
+        static::assertTrue($statement->getProfiling());
+
+        $cursor = $statement->execute();
+        $result = $cursor->getExtra();
+        static::assertArrayHasKey('profile', $result);
+        static::assertTrue(is_array($result['profile']));
+        static::assertArrayHasKey('executing', $result['profile']);
+    }
+    
     public function testStatementStreaming()
     {
         $connection = $this->connection;
