bearcage commented on a change in pull request #7422: [WIP] Add `validate_sql_json` endpoint
for checking that a given sql query is valid for the chosen database
URL: https://github.com/apache/incubator-superset/pull/7422#discussion_r280512090
##########
File path: superset/views/core.py
##########
@@ -2503,6 +2504,61 @@ def stop_query(self):
pass
return self.json_response('OK')
+ @has_access_api
+ @expose('/validate_sql_json/', methods=['POST', 'GET'])
+ @log_this
+ def validate_sql_json(self):
+ """Validates that arbitrary sql is acceptable for the given database.
+ Returns a list of error/warning annotations as json.
+ """
+ sql = request.form.get('sql')
+ database_id = request.form.get('database_id')
+ schema = request.form.get('schema') or None
+ template_params = json.loads(
+ request.form.get('templateParams') or '{}')
+
+ if len(template_params) > 0:
+ # TODO: factor the Database object out of template rendering
+ # or provide it as mydb so we can render template params
+ # without having to also persist a Query ORM object.
+ return json_error_response(
+ 'SQL validation does not support template parameters')
+
+ session = db.session()
+ mydb = session.query(models.Database).filter_by(id=database_id).first()
+ if not mydb:
+ json_error_response(
+ 'Database with id {} is missing.'.format(database_id))
+
+ spec = mydb.db_engine_spec
+ if not spec.engine in SQL_VALIDATORS_BY_ENGINE:
+ return json_error_response(
Review comment:
IMO 400 bad request is the right return — we're bombing out because the user asked us
to do something we explicitly don't do, so we should let them know that.
This is assuming we're able to plumb through the "can I validate on this backend" db property
to the client, of course.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
|