You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "justinpark (via GitHub)" <gi...@apache.org> on 2026/04/15 20:55:50 UTC
[PR] fix(sqllab: format_sql to apply db dialect by database_id [superset]
justinpark opened a new pull request, #39393:
URL: https://github.com/apache/superset/pull/39393
### SUMMARY
Fixes #39100
In the SQL Lab, during the format_sql process, the engine information of the current database was not being passed, which caused the formatting to always fall back to the basic dialect. With the latest update, the database_id is now being passed, so the code has been updated to extract the engine value based on the database_id and pass it accordingly.
### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
Before:
https://github.com/user-attachments/assets/de96138f-2872-43a3-8ab7-e024f731b30b
After:
https://github.com/user-attachments/assets/a57ce6b5-a1f2-4cda-a2af-14eacb710634
### TESTING INSTRUCTIONS
1. Connect Superset 6.0.0 (or 6.1rc1) to a Trino database (any version)
2. Open SQL Lab, ensure "Format SQL" is ON
3. Run:
SELECT date_diff('day', DATE '2023-01-01', current_date)
4. Observe error:
TrinoUserError: Function 'datediff' not registered
### ADDITIONAL INFORMATION
<!--- Check any relevant boxes with "x" -->
<!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
- [ ] Has associated issue:
- [ ] Required feature flags:
- [ ] Changes UI
- [ ] Includes DB Migration (follow approval process in [SIP-59](https://github.com/apache/superset/issues/13351))
- [ ] Migration is atomic, supports rollback & is backwards-compatible
- [ ] Confirm DB migration upgrade and downgrade tested
- [ ] Runtime estimates and downtime expectations provided
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(sqllab): format_sql to apply db dialect by database_id [superset]
Posted by "michael-s-molina (via GitHub)" <gi...@apache.org>.
michael-s-molina merged PR #39393:
URL: https://github.com/apache/superset/pull/39393
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(sqllab: format_sql to apply db dialect by database_id [superset]
Posted by "bito-code-review[bot] (via GitHub)" <gi...@apache.org>.
bito-code-review[bot] commented on PR #39393:
URL: https://github.com/apache/superset/pull/39393#issuecomment-4255407758
AI Code Review is in progress (usually takes 3 to 15 minutes unless it's a very large PR).
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(sqllab): format_sql to apply db dialect by database_id [superset]
Posted by "bito-code-review[bot] (via GitHub)" <gi...@apache.org>.
bito-code-review[bot] commented on PR #39393:
URL: https://github.com/apache/superset/pull/39393#issuecomment-4256129882
AI Code Review is in progress (usually takes 3 to 15 minutes unless it's a very large PR).
<details>
<summary>
Bito Usage Guide
</summary>
**Commands**
Type the following command in the pull request comment and save the comment.
- `/review` - Manually triggers a full AI review.
- `/pause` - Pauses automatic reviews on this pull request.
- `/resume` - Resumes automatic reviews.
- `/resolve` - Marks all Bito-posted review comments as resolved.
- `/abort` - Cancels all in-progress reviews.
Refer to the <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/available-commands" target="_blank" rel="noopener noreferrer">documentation</a> for additional commands.
**Configuration**
This repository uses `Superset` You can customize the agent settings <a href="https://alpha.bito.ai/home/ai-agents/code-review-agent" target="_blank" rel="noopener noreferrer">here</a> or contact your Bito workspace admin at evan@preset.io.
**Documentation & Help**
- <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/getting-started/install-run-using-bito-cloud/create-or-customize-an-agent-instance" target="_blank" rel="noopener noreferrer">Customize agent settings</a>
- <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/implementing-custom-code-review-rules" target="_blank" rel="noopener noreferrer">Review rules</a>
- <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent" target="_blank" rel="noopener noreferrer">General documentation</a>
- <a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/faqs" target="_blank" rel="noopener noreferrer">FAQ</a>
</details>
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(sqllab): format_sql to apply db dialect by database_id [superset]
Posted by "netlify[bot] (via GitHub)" <gi...@apache.org>.
netlify[bot] commented on PR #39393:
URL: https://github.com/apache/superset/pull/39393#issuecomment-4256087354
### <span aria-hidden="true">β
</span> Deploy Preview for *superset-docs-preview* ready!
| Name | Link |
|:-:|------------------------|
|<span aria-hidden="true">π¨</span> Latest commit | 6820726947d7fcfda0c8bece330ad8f09a571e68 |
|<span aria-hidden="true">π</span> Latest deploy log | https://app.netlify.com/projects/superset-docs-preview/deploys/69e00e9364ffe7000862fd75 |
|<span aria-hidden="true">π</span> Deploy Preview | [https://deploy-preview-39393--superset-docs-preview.netlify.app](https://deploy-preview-39393--superset-docs-preview.netlify.app) |
|<span aria-hidden="true">π±</span> Preview on mobile | <details><summary> Toggle QR Code... </summary><br /><br /><br /><br />_Use your smartphone camera to open QR code link._</details> |
---
<!-- [superset-docs-preview Preview](https://deploy-preview-39393--superset-docs-preview.netlify.app) -->
_To edit notification comments on pull requests, go to your [Netlify project configuration](https://app.netlify.com/projects/superset-docs-preview/configuration/notifications#deploy-notifications)._
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(sqllab: format_sql to apply db dialect by database_id [superset]
Posted by "codeant-ai-for-open-source[bot] (via GitHub)" <gi...@apache.org>.
codeant-ai-for-open-source[bot] commented on code in PR #39393:
URL: https://github.com/apache/superset/pull/39393#discussion_r3089332608
##########
superset/sqllab/api.py:
##########
@@ -238,31 +238,36 @@ def format_sql(self) -> FlaskResponse:
sql = model["sql"]
template_params = model.get("template_params")
database_id = model.get("database_id")
+ database_engine = None
- # Process Jinja templates if template_params and database_id are provided
+ # Process Jinja templates if template_params are provided
if template_params and database_id is not None:
database = DatabaseDAO.find_by_id(database_id)
+
if database:
- try:
- template_params = (
- json.loads(template_params)
- if isinstance(template_params, str)
- else template_params
- )
- if template_params:
- template_processor = get_template_processor(
- database=database
- )
- sql = template_processor.process_template(
- sql, **template_params
- )
- except json.JSONDecodeError:
- logger.warning(
- "Invalid template parameter %s. Skipping processing",
- str(template_params),
- )
-
- result = SQLScript(sql, model.get("engine")).format()
+ database_engine = database.db_engine_spec.engine
+
+ if template_params:
+ try:
+ template_params = (
+ json.loads(template_params)
+ if isinstance(template_params, str)
+ else template_params
+ )
+ if template_params:
+ template_processor = get_template_processor(
+ database=database
+ )
+ sql = template_processor.process_template(
+ sql, **template_params
+ )
+ except json.JSONDecodeError:
+ logger.warning(
+ "Invalid template parameter %s. Skipping processing",
+ str(template_params),
+ )
+
+ result = SQLScript(sql, model.get("engine", database_engine)).format()
Review Comment:
**Suggestion:** The database dialect is only looked up when `template_params` is present, so requests that send only `database_id` still format using the generic dialect and produce incorrect SQL transformations. Load the database engine whenever `database_id` is provided, and then use it for formatting regardless of whether Jinja params exist. [logic error]
<details>
<summary><b>Severity Level:</b> Critical π¨</summary>
```mdx
- β Format SQL endpoint ignores database dialect for non-templated queries.
- β SQL Lab UI formats queries using generic SQL dialect.
- β οΈ Dialect-specific functions rewritten incorrectly during SQL formatting.
```
</details>
```suggestion
database = None
if database_id is not None:
database = DatabaseDAO.find_by_id(database_id)
if database:
database_engine = database.db_engine_spec.engine
# Process Jinja templates if template_params are provided
if template_params and database:
try:
template_params = (
json.loads(template_params)
if isinstance(template_params, str)
else template_params
)
if template_params:
template_processor = get_template_processor(database=database)
sql = template_processor.process_template(sql, **template_params)
except json.JSONDecodeError:
logger.warning(
"Invalid template parameter %s. Skipping processing",
str(template_params),
)
result = SQLScript(sql, model.get("engine") or database_engine).format()
```
<details>
<summary><b>Steps of Reproduction β
</b></summary>
```mdx
1. Start Superset with the PR code; the SQL Lab format endpoint is registered at
`superset/sqllab/api.py:197-205` via `@expose("/format_sql/", methods=("POST",))`, and is
documented as `/api/v1/sqllab/format_sql/` in `docs/developer_docs/api.mdx:208` and
`docs/static/resources/openapi.json:36215`.
2. Trigger a request that sends `sql` and `database_id` but no `template_params`, as done
in `tests/integration_tests/sql_lab/api_tests.py:32-47` in
`test_format_sql_request_with_db_id`, which POSTs to `/api/v1/sqllab/format_sql/` with
JSON `{"sql": "select IIF(score > 0, 'positive', 'negative') from my_table",
"database_id": example_db.id}`.
3. In `superset/sqllab/api.py:237-41`, `format_sql` loads the payload into `model`, sets
`database_engine = None`, and since `template_params` is absent/None, the condition `if
template_params and database_id is not None:` at `superset/sqllab/api.py:243-40` evaluates
to False, so `DatabaseDAO.find_by_id(database_id)` is never called and `database_engine`
remains `None`.
4. At `superset/sqllab/api.py:270-66`, `result = SQLScript(sql, model.get("engine",
database_engine)).format()` constructs `SQLScript` with `engine=None`; inside
`superset/sql/parse.py:13-20`, this falls back to the generic `SQLStatement` formatter,
which formats using the base dialect (rewriting SQLite's `IIF` into `CASE WHEN`), causing
`test_format_sql_request_with_db_id` to fail its expectations and, in real SQL Lab usage,
formats database-specific functions incorrectly even when a valid `database_id` is
supplied.
```
</details>
[Fix in Cursor](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt=This%20is%20a%20comment%20left%20during%20a%20code%20review.%0A%0A%2A%2APath%3A%2A%2A%20superset%2Fsqllab%2Fapi.py%0A%2A%2ALine%3A%2A%2A%20243%3A270%0A%2A%2AComment%3A%2A%2A%0A%09%2ALogic%20Error%3A%20The%20database%20dialect%20is%20only%20looked%20up%20when%20%60template_params%60%20is%20present%2C%20so%20requests%20that%20send%20only%20%60database_id%60%20still%20format%20using%20the%20generic%20dialect%20and%20produce%20incorrect%20SQL%20transformations.%20Load%20the%20database%20engine%20whenever%20%60database_id%60%20is%20provided%2C%20and%20then%20use%20it%20for%20formatting%20regardless%20of%20whether%20Jinja%20params%20exist.%0A%0AValidate%20the%20correctness%20of%20the%20flagged%20issue.%20If%20correct%2C%20How%20can%20I%20resolve%20this%3F%20If%20you%20propose%20a%20fix%2C%20implement%20it%20and%20please%20make%20it%20concise.%0A) | [Fix in VSCode Claude](https://app.codeant.ai/fix-in-ide?tool=vscode-cl
aude&prompt=This%20is%20a%20comment%20left%20during%20a%20code%20review.%0A%0A%2A%2APath%3A%2A%2A%20superset%2Fsqllab%2Fapi.py%0A%2A%2ALine%3A%2A%2A%20243%3A270%0A%2A%2AComment%3A%2A%2A%0A%09%2ALogic%20Error%3A%20The%20database%20dialect%20is%20only%20looked%20up%20when%20%60template_params%60%20is%20present%2C%20so%20requests%20that%20send%20only%20%60database_id%60%20still%20format%20using%20the%20generic%20dialect%20and%20produce%20incorrect%20SQL%20transformations.%20Load%20the%20database%20engine%20whenever%20%60database_id%60%20is%20provided%2C%20and%20then%20use%20it%20for%20formatting%20regardless%20of%20whether%20Jinja%20params%20exist.%0A%0AValidate%20the%20correctness%20of%20the%20flagged%20issue.%20If%20correct%2C%20How%20can%20I%20resolve%20this%3F%20If%20you%20propose%20a%20fix%2C%20implement%20it%20and%20please%20make%20it%20concise.%0A)
*(Use Cmd/Ctrl + Click for best experience)*
<details>
<summary><b>Prompt for AI Agent π€ </b></summary>
```mdx
This is a comment left during a code review.
**Path:** superset/sqllab/api.py
**Line:** 243:270
**Comment:**
*Logic Error: The database dialect is only looked up when `template_params` is present, so requests that send only `database_id` still format using the generic dialect and produce incorrect SQL transformations. Load the database engine whenever `database_id` is provided, and then use it for formatting regardless of whether Jinja params exist.
Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise.
```
</details>
<a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F39393&comment_hash=1f74cbace62d5112168b15af5c720970fa0840af62435465ecd686aa03ea6549&reaction=like'>π</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F39393&comment_hash=1f74cbace62d5112168b15af5c720970fa0840af62435465ecd686aa03ea6549&reaction=dislike'>π</a>
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(sqllab: format_sql to apply db dialect by database_id [superset]
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #39393:
URL: https://github.com/apache/superset/pull/39393#issuecomment-4255472030
## [Codecov](https://app.codecov.io/gh/apache/superset/pull/39393?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
:x: Patch coverage is `0%` with `11 lines` in your changes missing coverage. Please review.
:white_check_mark: Project coverage is 56.01%. Comparing base ([`0d91f5e`](https://app.codecov.io/gh/apache/superset/commit/0d91f5e98233c439d1a1919e3424cdcc3711443c?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)) to head ([`32c7555`](https://app.codecov.io/gh/apache/superset/commit/32c75555f63c5b8152677687062aafa4bedc5e83?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)).
:warning: Report is 8 commits behind head on master.
| [Files with missing lines](https://app.codecov.io/gh/apache/superset/pull/39393?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Patch % | Lines |
|---|---|---|
| [superset/sqllab/api.py](https://app.codecov.io/gh/apache/superset/pull/39393?src=pr&el=tree&filepath=superset%2Fsqllab%2Fapi.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c3VwZXJzZXQvc3FsbGFiL2FwaS5weQ==) | 0.00% | [11 Missing :warning: ](https://app.codecov.io/gh/apache/superset/pull/39393?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) |
:x: Your project check has failed because the head coverage (99.79%) is below the target coverage (100.00%). You can increase the head coverage or adjust the [target](https://docs.codecov.com/docs/commit-status#target) coverage.
> :exclamation: There is a different number of reports uploaded between BASE (0d91f5e) and HEAD (32c7555). Click for more details.
>
> <details><summary>HEAD has 24 uploads less than BASE</summary>
>
>| Flag | BASE (0d91f5e) | HEAD (32c7555) |
>|------|------|------|
>|python|20|3|
>|presto|2|1|
>|hive|2|1|
>|unit|6|1|
></details>
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## master #39393 +/- ##
==========================================
- Coverage 64.48% 56.01% -8.47%
==========================================
Files 2556 2557 +1
Lines 132855 132924 +69
Branches 30860 30866 +6
==========================================
- Hits 85665 74453 -11212
- Misses 45699 57828 +12129
+ Partials 1491 643 -848
```
| [Flag](https://app.codecov.io/gh/apache/superset/pull/39393/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Ξ | |
|---|---|---|
| [hive](https://app.codecov.io/gh/apache/superset/pull/39393/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `39.95% <0.00%> (+<0.01%)` | :arrow_up: |
| [mysql](https://app.codecov.io/gh/apache/superset/pull/39393/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
| [postgres](https://app.codecov.io/gh/apache/superset/pull/39393/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
| [presto](https://app.codecov.io/gh/apache/superset/pull/39393/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `41.74% <0.00%> (+<0.01%)` | :arrow_up: |
| [python](https://app.codecov.io/gh/apache/superset/pull/39393/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `43.21% <0.00%> (-19.08%)` | :arrow_down: |
| [sqlite](https://app.codecov.io/gh/apache/superset/pull/39393/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `?` | |
| [unit](https://app.codecov.io/gh/apache/superset/pull/39393/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | `100.00% <ΓΈ> (ΓΈ)` | |
Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#carryforward-flags-in-the-pull-request-comment) to find out more.
</details>
[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/superset/pull/39393?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
<details><summary> :rocket: New features to boost your workflow: </summary>
- :snowflake: [Test Analytics](https://docs.codecov.com/docs/test-analytics): Detect flaky tests, report on failures, and find test suite problems.
- :package: [JS Bundle Analysis](https://docs.codecov.com/docs/javascript-bundle-analysis): Save yourself from yourself by tracking and limiting bundle sizes in JS merges.
</details>
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org