New Query Runner: Arango query runner (#5124)

Co-authored-by: Hugo Gresse <[email protected]>

Author: bryanyang0528

client/app/assets/images/db-logos/arangodb.png

@@ -0,0 +1,89 @@
+import logging
+
+from redash.query_runner import *
+from redash.utils import json_dumps
+
+logger = logging.getLogger(__name__)
+
+try:
+    from arango import ArangoClient
+
+    enabled = True
+except ImportError:
+    enabled = False
+
+
+_TYPE_MAPPINGS = {
+    "boolean": TYPE_BOOLEAN,
+    "number": TYPE_FLOAT,
+    "string": TYPE_STRING,
+    "array": TYPE_STRING,
+    "object": TYPE_STRING,
+}
+
+
+class Arango(BaseQueryRunner):
+    noop_query = "RETURN {'id': 1}"
+
+    @classmethod
+    def name(cls):
+        return "ArangoDB"
+
+    @classmethod
+    def configuration_schema(cls):
+        return {
+            "type": "object",
+            "properties": {
+                "user": {"type": "string"},
+                "password": {"type": "string"},
+                "host": {"type": "string", "default": "127.0.0.1"},
+                "port": {"type": "number", "default": 8529},
+                "dbname": {"type": "string", "title": "Database Name"},
+                "timeout": {"type": "number", "default": 0.0, "title": "AQL Timeout in seconds (0 = no timeout)"},
+            },
+            "order": ["host", "port", "user", "password", "dbname"],
+            "required": ["host", "user", "password", "dbname"],
+            "secret": ["password"],
+        }
+
+    @classmethod
+    def enabled(cls):
+        try:
+            import arango
+        except ImportError:
+            return False
+
+        return True
+
+    @classmethod
+    def type(cls):
+        return "arangodb"
+
+    def run_query(self, query, user):
+        client = ArangoClient(hosts='{}:{}'.format(self.configuration["host"],
+                                                   self.configuration.get("port", 8529)))
+        db = client.db(self.configuration["dbname"],
+                       username=self.configuration["user"],
+                       password=self.configuration["password"])
+
+        try:
+            cursor = db.aql.execute(query, max_runtime=self.configuration.get("timeout", 0.0))
+            result = [i for i in cursor]
+            column_tuples = [
+                (i, TYPE_STRING) for i in result[0].keys()
+            ]
+            columns = self.fetch_columns(column_tuples)
+            data = {
+                "columns": columns,
+                "rows": result,
+            }
+
+            json_data = json_dumps(data, ignore_nan=True)
+            error = None
+        except Exception:
+            raise
+
+        return json_data, error
+
+
+register(Arango)

redash/query_runner/arango.py

@@ -387,7 +387,8 @@ def email_server_is_configured():
     "redash.query_runner.sparql_endpoint",
     "redash.query_runner.excel",
     "redash.query_runner.csv",
-    "redash.query_runner.firebolt"
+    "redash.query_runner.firebolt",
+    "redash.query_runner.arango"
 ]
 
 enabled_query_runners = array_from_string(

redash/settings/__init__.py

@@ -42,3 +42,4 @@ xlrd==2.0.1
 openpyxl==3.0.7
 firebolt-sdk
 pandas==1.3.4
+python-arango==6.1.0