Add ability to customize confiuration properties.

getredash · Oct 17, 2018 · 81366f0 · 81366f0
1 parent 6186cd3
commit 81366f0
Show file tree

Hide file tree

Showing 21 changed files with 433 additions and 390 deletions.
diff --git a/redash/query_runner/__init__.py b/redash/query_runner/__init__.py
@@ -51,6 +51,7 @@ class NotSupported(Exception):
 
 class BaseQueryRunner(object):
     noop_query = None
+    configuration_properties = None
 
     def __init__(self, configuration):
         self.syntax = 'sql'
@@ -76,6 +77,12 @@ def annotate_query(cls):
     def configuration_schema(cls):
         return {}
 
+    @classmethod
+    def add_configuration_property(cls, property, value):
+        if cls.configuration_properties is None:
+            raise NotImplementedError()
+        cls.configuration_properties[property] = value
+
     def test_connection(self):
         if self.noop_query is None:
             raise NotImplementedError()
@@ -149,25 +156,26 @@ class BaseHTTPQueryRunner(BaseQueryRunner):
     url_title = 'URL base path'
     username_title = 'HTTP Basic Auth Username'
     password_title = 'HTTP Basic Auth Password'
+    configuration_properties = {
+        'url': {
+            'type': 'string',
+            'title': url_title,
+        },
+        'username': {
+            'type': 'string',
+            'title': username_title,
+        },
+        'password': {
+            'type': 'string',
+            'title': password_title,
+        },
+    }
 
     @classmethod
     def configuration_schema(cls):
         schema = {
             'type': 'object',
-            'properties': {
-                'url': {
-                    'type': 'string',
-                    'title': cls.url_title,
-                },
-                'username': {
-                    'type': 'string',
-                    'title': cls.username_title,
-                },
-                'password': {
-                    'type': 'string',
-                    'title': cls.password_title,
-                },
-            },
+            'properties': cls.configuration_properties,
             'required': ['url'],
             'secret': ['password']
         }

diff --git a/redash/query_runner/big_query.py b/redash/query_runner/big_query.py
@@ -82,6 +82,40 @@ def _get_query_results(jobs, project_id, location, job_id, start_index):
 
 class BigQuery(BaseQueryRunner):
     noop_query = "SELECT 1"
+    configuration_properties = {
+        'projectId': {
+            'type': 'string',
+            'title': 'Project ID'
+        },
+        'jsonKeyFile': {
+            "type": "string",
+            'title': 'JSON Key File'
+        },
+        'totalMBytesProcessedLimit': {
+            "type": "number",
+            'title': 'Scanned Data Limit (MB)'
+        },
+        'userDefinedFunctionResourceUri': {
+            "type": "string",
+            'title': 'UDF Source URIs (i.e. gs://bucket/date_utils.js, gs://bucket/string_utils.js )'
+        },
+        'useStandardSql': {
+            "type": "boolean",
+            'title': "Use Standard SQL (Beta)",
+        },
+        'location': {
+            "type": "string",
+            "title": "Processing Location",
+        },
+        'loadSchema': {
+            "type": "boolean",
+            "title": "Load Schema"
+        },
+        'maximumBillingTier': {
+            "type": "number",
+            "title": "Maximum Billing Tier"
+        }
+    }
 
     @classmethod
     def enabled(cls):
@@ -91,40 +125,7 @@ def enabled(cls):
     def configuration_schema(cls):
         return {
             'type': 'object',
-            'properties': {
-                'projectId': {
-                    'type': 'string',
-                    'title': 'Project ID'
-                },
-                'jsonKeyFile': {
-                    "type": "string",
-                    'title': 'JSON Key File'
-                },
-                'totalMBytesProcessedLimit': {
-                    "type": "number",
-                    'title': 'Scanned Data Limit (MB)'
-                },
-                'userDefinedFunctionResourceUri': {
-                    "type": "string",
-                    'title': 'UDF Source URIs (i.e. gs://bucket/date_utils.js, gs://bucket/string_utils.js )'
-                },
-                'useStandardSql': {
-                    "type": "boolean",
-                    'title': "Use Standard SQL (Beta)",
-                },
-                'location': {
-                    "type": "string",
-                    "title": "Processing Location",
-                },
-                'loadSchema': {
-                    "type": "boolean",
-                    "title": "Load Schema"
-                },
-                'maximumBillingTier': {
-                    "type": "number",
-                    "title": "Maximum Billing Tier"
-                }
-            },
+            'properties': cls.configuration_properties,
             'required': ['jsonKeyFile', 'projectId'],
             "order": ['projectId', 'jsonKeyFile', 'loadSchema', 'useStandardSql', 'location', 'totalMBytesProcessedLimit', 'maximumBillingTier', 'userDefinedFunctionResourceUri'],
             'secret': ['jsonKeyFile']

diff --git a/redash/query_runner/cass.py b/redash/query_runner/cass.py
@@ -23,6 +23,37 @@ def default(self, o):
 
 class Cassandra(BaseQueryRunner):
     noop_query = "SELECT dateof(now()) FROM system.local"
+    configuration_properties = {
+        'host': {
+            'type': 'string',
+        },
+        'port': {
+            'type': 'number',
+            'default': 9042,
+        },
+        'keyspace': {
+            'type': 'string',
+            'title': 'Keyspace name'
+        },
+        'username': {
+            'type': 'string',
+            'title': 'Username'
+        },
+        'password': {
+            'type': 'string',
+            'title': 'Password'
+        },
+        'protocol': {
+            'type': 'number',
+            'title': 'Protocol Version',
+            'default': 3
+        },
+        'timeout': {
+            'type': 'number',
+            'title': 'Timeout',
+            'default': 10
+        }
+    }
 
     @classmethod
     def enabled(cls):
@@ -32,37 +63,7 @@ def enabled(cls):
     def configuration_schema(cls):
         return {
             'type': 'object',
-            'properties': {
-                'host': {
-                    'type': 'string',
-                },
-                'port': {
-                    'type': 'number',
-                    'default': 9042,
-                },
-                'keyspace': {
-                    'type': 'string',
-                    'title': 'Keyspace name'
-                },
-                'username': {
-                    'type': 'string',
-                    'title': 'Username'
-                },
-                'password': {
-                    'type': 'string',
-                    'title': 'Password'
-                },
-                'protocol': {
-                    'type': 'number',
-                    'title': 'Protocol Version',
-                    'default': 3
-                },
-                'timeout': {
-                    'type': 'number',
-                    'title': 'Timeout',
-                    'default': 10
-                }
-            },
+            'properties': cls.configuration_properties,
             'required': ['keyspace', 'host']
         }
 

diff --git a/redash/query_runner/dynamodb_sql.py b/redash/query_runner/dynamodb_sql.py
@@ -32,22 +32,23 @@
 
 
 class DynamoDBSQL(BaseSQLQueryRunner):
+    configuration_properties = {
+        "region": {
+            "type": "string",
+            "default": "us-east-1"
+        },
+        "access_key": {
+            "type": "string",
+        },
+        "secret_key": {
+            "type": "string",
+        }
+    }
     @classmethod
     def configuration_schema(cls):
         return {
             "type": "object",
-            "properties": {
-                "region": {
-                    "type": "string",
-                    "default": "us-east-1"
-                },
-                "access_key": {
-                    "type": "string",
-                },
-                "secret_key": {
-                    "type": "string",
-                }
-            },
+            "properties": cls.configuration_properties,
             "required": ["access_key", "secret_key"],
             "secret": ["secret_key"]
         }

diff --git a/redash/query_runner/elasticsearch.py b/redash/query_runner/elasticsearch.py
@@ -45,25 +45,26 @@
 
 class BaseElasticSearch(BaseQueryRunner):
     DEBUG_ENABLED = False
+    configuration_properties = {
+        'server': {
+            'type': 'string',
+            'title': 'Base URL'
+        },
+        'basic_auth_user': {
+            'type': 'string',
+            'title': 'Basic Auth User'
+        },
+        'basic_auth_password': {
+            'type': 'string',
+            'title': 'Basic Auth Password'
+        }
+    }
 
     @classmethod
     def configuration_schema(cls):
         return {
             'type': 'object',
-            'properties': {
-                'server': {
-                    'type': 'string',
-                    'title': 'Base URL'
-                },
-                'basic_auth_user': {
-                    'type': 'string',
-                    'title': 'Basic Auth User'
-                },
-                'basic_auth_password': {
-                    'type': 'string',
-                    'title': 'Basic Auth Password'
-                }
-            },
+            'properties': cls.configuration_properties,
             "secret": ["basic_auth_password"],
             "required": ["server"]
         }

diff --git a/redash/query_runner/google_spreadsheets.py b/redash/query_runner/google_spreadsheets.py
@@ -147,6 +147,12 @@ def request(self, *args, **kwargs):
 
 
 class GoogleSpreadsheet(BaseQueryRunner):
+    configuration_properties = {
+        'jsonKeyFile': {
+            "type": "string",
+            'title': 'JSON Key File'
+        }
+    }
 
     @classmethod
     def annotate_query(cls):
@@ -164,12 +170,7 @@ def enabled(cls):
     def configuration_schema(cls):
         return {
             'type': 'object',
-            'properties': {
-                'jsonKeyFile': {
-                    "type": "string",
-                    'title': 'JSON Key File'
-                }
-            },
+            'properties': cls.configuration_properties,
             'required': ['jsonKeyFile'],
             'secret': ['jsonKeyFile']
         }