fix: Allow "EXPLAIN" queries when "Allow DML" setting is False #11348
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #11348 +/- ##
==========================================
- Coverage 65.75% 61.08% -4.68%
==========================================
Files 838 838
Lines 39714 39714
Branches 3613 3613
==========================================
- Hits 26115 24260 -1855
- Misses 13498 15273 +1775
- Partials 101 181 +80
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
mistercrunch
changed the title
superset/sql_parse.py
Outdated
| @@ -111,7 +111,11 @@ def is_select(self) -> bool: | |||
| return self._parsed[0].get_type() == "SELECT" | |||
|
|
|||
| def is_explain(self) -> bool: | |||
| return self.stripped().upper().startswith("EXPLAIN") | |||
| # Parsing SQL statement for EXPLAIN and filtering out comments | |||
There was a problem hiding this comment.
Thinking about whether the right logic here is first(), any() or all() and I think it's either
-
- it works only if the SQL is a single statement, and raises otherwise
-
- all of the statements are
EXPLAIN(which is not typical)
- all of the statements are
betodealmeida
requested changes
Oct 21, 2020
superset/sql_parse.py
Outdated
Comment on lines
122
to
125
| if statements_without_comments[0].startswith("EXPLAIN"): | ||
| return True | ||
|
|
||
| return False |
There was a problem hiding this comment.
You can simplify this:
return statements_without_comments[0].startswith("EXPLAIN")
superset/sql_parse.py
Outdated
| statement.strip(" \t\n;") | ||
| for statement in self.stripped().upper().splitlines() | ||
| if not statement.startswith("--") | ||
| ] |
There was a problem hiding this comment.
This will miss some edge cases like:
-- This is a comment
-- this is another comment but with a space in the front
EXPLAIN SELECT * FROM TABLEYou need to lstrip() each line as well before testing if it startswith():
statements_without_comments = [
statement.strip(" \t\n;")
for statement in self.stripped().upper().splitlines()
if not statement.lstrip().startswith("--")
]
There was a problem hiding this comment.
I find it simpler to just use regular expression:
queries = re.sub(r'\s*--.*', '', queries)
queries = [x.strip(' \t\n\r') for x in queries.split(';')]
queries = [x for x in queries if x] # query must be non-empty
superset/sql_parse.py
Outdated
| if statement.upper().startswith("EXPLAIN"): | ||
| return True | ||
| # Remove comments | ||
| statements_without_comments = [statement.strip(" \t\n;") for statement in self.stripped().upper().splitlines() if not statement.startswith("--")] |
There was a problem hiding this comment.
sqlparse.format offers a strip_comments option that will also take care of /*this*/ and probably more.
Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
betodealmeida
approved these changes
Oct 21, 2020
|
WAIT A MINUTE! DARK THEME!?!?!? |
auxten
pushed a commit
to auxten/incubator-superset
that referenced
this pull request
Nov 20, 2020
…e#11348) Co-authored-by: Beto Dealmeida <roberto@dealmeida.net>
mistercrunch
added
🏷️ bot
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Fixing
is_explainfunction in sql_parse to properly catch EXPLAIN statements. sqlparse out of the box doesn't handle comments well, so we have to parse the query ourselves.Closes #8827
Before
After
TEST PLAN
Goto Sqllab
Run the following query:
ADDITIONAL INFORMATION