Improve visibility of error message during schema retrieval (getredas…

…h#5879)

* handle query execution error in one place. increase ability to debug issues with schema retrieval

* split message and details for error reporting

Co-authored-by: Dmitriy Apollonin <[email protected]>

redash/query_runner/__init__.py

@@ -234,6 +234,13 @@ def fetch_columns(self, columns):
     def get_schema(self, get_stats=False):
         raise NotSupported()
 
+    def _handle_run_query_error(self, error):
+        if error is None:
+            return
+
+        logger.error(error)
+        raise Exception(f"Error during query execution. Reason: {error}")
+
     def _run_query_internal(self, query):
         results, error = self.run_query(query, None)
 

redash/query_runner/athena.py

@@ -206,7 +206,7 @@ def get_schema(self, get_stats=False):
 
         results, error = self.run_query(query, None)
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
         for row in results["rows"]:

redash/query_runner/azure_kusto.py

@@ -138,7 +138,7 @@ def get_schema(self, get_stats=False):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/big_query.py

@@ -305,7 +305,7 @@ def get_schema(self, get_stats=False):
         query = '\nUNION ALL\n'.join(queries)
         results, error = self.run_query(query, None)
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
         for row in results["rows"]:
@@ -341,7 +341,7 @@ def run_query(self, query, user):
             json_data = json_dumps(data, ignore_nan=True)
         except apiclient.errors.HttpError as e:
             json_data = None
-            if e.resp.status == 400:
+            if e.resp.status in [400, 404]:
                 error = json_loads(e.content)["error"]["message"]
             else:
                 error = e.content

redash/query_runner/clickhouse.py

@@ -79,7 +79,7 @@ def _get_tables(self, schema):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/databricks.py

@@ -154,7 +154,7 @@ def get_databases(self):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/db2.py

@@ -65,7 +65,7 @@ def _get_definitions(self, schema, query):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/drill.py

@@ -135,7 +135,7 @@ def get_schema(self, get_stats=False):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/druid.py

@@ -77,7 +77,7 @@ def get_schema(self, get_stats=False):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         schema = {}
         results = json_loads(results)

redash/query_runner/firebolt.py

@@ -76,7 +76,7 @@ def get_schema(self, get_stats=False):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         schema = {}
         results = json_loads(results)

redash/query_runner/mssql.py

@@ -80,7 +80,7 @@ def _get_tables(self, schema):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/mssql_odbc.py

@@ -68,7 +68,7 @@ def name(cls):
     @classmethod
     def type(cls):
         return "mssql_odbc"
-    
+
     @property
     def supports_auto_limit(self):
         return False
@@ -86,7 +86,7 @@ def _get_tables(self, schema):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/mysql.py

@@ -137,7 +137,7 @@ def _get_tables(self, schema):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/oracle.py

@@ -85,7 +85,7 @@ def _get_tables(self, schema):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/pg.py

@@ -186,7 +186,7 @@ def _get_definitions(self, schema, query):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/phoenix.py

@@ -72,7 +72,7 @@ def get_schema(self, get_stats=False):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/presto.py

@@ -78,7 +78,7 @@ def get_schema(self, get_stats=False):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/query_runner/snowflake.py

@@ -173,7 +173,7 @@ def get_schema(self, get_stats=False):
         results, error = self._run_query_without_warehouse(query)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         schema = {}
         for row in results["rows"]:

redash/query_runner/sqlite.py

@@ -43,7 +43,7 @@ def _get_tables(self, schema):
             schema[table_name] = {"name": table_name, "columns": []}
             results_table, error = self.run_query(query_columns % (table_name,), None)
             if error is not None:
-                raise Exception("Failed getting schema.")
+                self._handle_run_query_error(error)
 
             results_table = json_loads(results_table)
             for row_column in results_table["rows"]:

redash/query_runner/trino.py

@@ -85,7 +85,7 @@ def get_schema(self, get_stats=False):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
         schema = {}

redash/query_runner/vertica.py

@@ -75,7 +75,7 @@ def _get_tables(self, schema):
         results, error = self.run_query(query, None)
 
         if error is not None:
-            raise Exception("Failed getting schema.")
+            self._handle_run_query_error(error)
 
         results = json_loads(results)
 

redash/tasks/general.py

@@ -85,8 +85,8 @@ def get_schema(data_source_id, refresh):
                 "message": "Data source type does not support retrieving schema",
             }
         }
-    except Exception:
-        return {"error": {"code": 2, "message": "Error retrieving schema."}}
+    except Exception as e:
+        return {"error": {"code": 2, "message": "Error retrieving schema", "details": str(e)}}
 
 
 def sync_user_details():