feat: Improve EXPLAIN support for MySQL and PostgreSQL#2165
Open
seladb wants to merge 12 commits intotortoise:developfrom
Open
feat: Improve EXPLAIN support for MySQL and PostgreSQL#2165seladb wants to merge 12 commits intotortoise:developfrom
seladb wants to merge 12 commits intotortoise:developfrom
Conversation
- Implement execute_explain() in mysql/executor.py with support for FORMAT (JSON, TRADITIONAL, TREE) and ANALYZE options - Update base_executor to raise proper errors for unsupported formats/options - Add comprehensive tests for explain() in test_postgres.py, test_mysql.py, and test_explain.py covering various formats and options - Add error handling for unsupported options in MySQL executor
Contributor
Author
|
@abondar I'm not sure why MSSQL tests fail randomly, but it's not related to the changes in this PR |
Contributor
Author
|
@abondar this PR is also ready for review! 🙏 |
Contributor
Author
@abondar @waketzheng a gentle reminder to review this PR 🙏 |
abondar
reviewed
Apr 30, 2026
| raise UnSupportedError(f"Unsupported options: {unsupported_options}") | ||
|
|
||
| required_options.add("FORMAT " + output_fmt.upper()) | ||
| postrges_options = ", ".join(required_options) |
| posix_regex: mysql_posix_regex, | ||
| } | ||
| EXPLAIN_PREFIX = "EXPLAIN FORMAT=JSON" | ||
| EXPLAIN_PREFIX = "EXPLAIN {}" |
Member
There was a problem hiding this comment.
This overriden EXPLAIN_PREFIX is not used anywhere?
Comment on lines
-1065
to
+1066
| - PostgreSQL: ``EXPLAIN (FORMAT JSON, VERBOSE) ...`` | ||
| - SQLite: ``EXPLAIN QUERY PLAN ...`` | ||
| - MySQL: ``EXPLAIN FORMAT=JSON ...`` | ||
| :param output_fmt: The output format for the EXPLAIN result. | ||
| - PostgreSQL: ``text``, ``json``, ``xml``, ``yaml`` (default: ``json``) |
Member
There was a problem hiding this comment.
do I understand correctly that we lost default "VERBOSE" for pg here? Is it intended? Do you think verbose is bad default option?
Contributor
Author
There was a problem hiding this comment.
I added back VERBOSE as a default option if no options are provided in this commit: 042d901
Contributor
Author
|
@abondar thanks for the PR review. I addressed all the comments, can you please re-review? |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Improve EXPLAIN support - add output format and explain options for supported databases (PostgreSQL and MySQL)
Description
execute_explain()with support forFORMAT(JSON,TRADITIONAL,TREE) andANALYZEoptionsTEXT,JSON,XML,YAML) and options (ANALYZE,BUFFERS,COSTS,MEMORY,SETTINGS,SERIALIZE,SUMMARY,TIMING,VERBOSE,WAL)output_fmtand additionaloptionsMotivation and Context
Previously, the
explain()method had limited functionality. This adds comprehensive EXPLAIN support for MySQL and PostgreSQL, allowing users to get detailed query execution plans in multiple formats and with various options.How Has This Been Tested?
Added the following tests:
Checklist: