bring back execution plan and introduce explain (#153)

* bring back execution plan and introduce explain

* fix

* keep graph function list minimal

Co-authored-by: Roi Lipman <[email protected]>

Author: AviAvni

redisgraph/graph.py

@@ -217,6 +217,21 @@ def query(self, q, params=None, timeout=None, read_only=False):
             return self.query(q, params, timeout, read_only)
 
     def execution_plan(self, query, params=None):
+        """
+        Get the execution plan for given query,
+        GRAPH.EXPLAIN returns an array of operations.
+
+        Args:
+            query: the query that will be executed
+            params: query parameters
+        """
+        if params is not None:
+            query = self._build_params_header(params) + query
+
+        plan = self.redis_con.execute_command("GRAPH.EXPLAIN", self.name, query)
+        return "\n".join(plan)
+
+    def explain(self, query, params=None):
         """
         Get the execution plan for given query,
         GRAPH.EXPLAIN returns ExecutionPlan object.

tests/functional/test_all.py

@@ -245,6 +245,19 @@ def test_cached_execution(self):
         redis_graph.delete()
 
     def test_execution_plan(self):
+        redis_graph = Graph('execution_plan', self.r)
+        create_query = """CREATE (:Rider {name:'Valentino Rossi'})-[:rides]->(:Team {name:'Yamaha'}),
+        (:Rider {name:'Dani Pedrosa'})-[:rides]->(:Team {name:'Honda'}),
+        (:Rider {name:'Andrea Dovizioso'})-[:rides]->(:Team {name:'Ducati'})"""
+        redis_graph.query(create_query)
+
+        result = redis_graph.execution_plan("MATCH (r:Rider)-[:rides]->(t:Team) WHERE t.name = $name RETURN r.name, t.name, $params", {'name': 'Yehuda'})
+        expected = "Results\n    Project\n        Conditional Traverse | (t:Team)->(r:Rider)\n            Filter\n                Node By Label Scan | (t:Team)"
+        self.assertEqual(result, expected)
+
+        redis_graph.delete()
+
+    def test_explain(self):
         redis_graph = Graph('execution_plan', self.r)
         # graph creation / population
         create_query = """CREATE
@@ -253,13 +266,13 @@ def test_execution_plan(self):
                           (:Rider {name:'Andrea Dovizioso'})-[:rides]->(:Team {name:'Ducati'})"""
         redis_graph.query(create_query)
 
-        result = redis_graph.execution_plan("""MATCH (r:Rider)-[:rides]->(t:Team)
-                                               WHERE t.name = $name
-                                               RETURN r.name, t.name
-                                               UNION
-                                               MATCH (r:Rider)-[:rides]->(t:Team)
-                                               WHERE t.name = $name
-                                               RETURN r.name, t.name""", {'name': 'Yamaha'})
+        result = redis_graph.explain("""MATCH (r:Rider)-[:rides]->(t:Team)
+                                        WHERE t.name = $name
+                                        RETURN r.name, t.name
+                                        UNION
+                                        MATCH (r:Rider)-[:rides]->(t:Team)
+                                        WHERE t.name = $name
+                                        RETURN r.name, t.name""", {'name': 'Yamaha'})
         expected = '''\
 Results
     Distinct