Skip to content

fix: Edge case with metric not getting quoted in sort by when normalize_columns is enabled #33337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mistercrunch merged 1 commit into from
May 3, 2025
Merged

fix: Edge case with metric not getting quoted in sort by when normalize_columns is enabled #33337

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions superset/models/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1585,10 +1585,6 @@ def get_sqla_query( # pylint: disable=too-many-arguments,too-many-locals,too-ma
# use the existing instance.
col = metrics_exprs_by_expr.get(str(col), col)
need_groupby = True
elif col in columns_by_name:
col = self.convert_tbl_column_to_sqla_col(
columns_by_name[col], template_processor=template_processor
)
elif col in metrics_exprs_by_label:
col = metrics_exprs_by_label[col]
need_groupby = True
Expand All @@ -1597,6 +1593,10 @@ def get_sqla_query( # pylint: disable=too-many-arguments,too-many-locals,too-ma
template_processor=template_processor
)
need_groupby = True
elif col in columns_by_name:
col = self.convert_tbl_column_to_sqla_col(
columns_by_name[col], template_processor=template_processor
)
Comment on lines +1596 to +1599
Copy link
Contributor Author

@Vitor-Avila Vitor-Avila May 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm basically just changing the order to first evaluate the column against metrics, and then across columns.

My understanding of the issue is that in the current if/elif ordering, we would first evaluate col across columns_by_name, which would be true (even tho it's a metric), and then convert_tbl_column_to_sqla_col() does col = sa.column(tbl_column.column_name, type_=type_) which seems to return quoted if the column is uppercase (hence the issue does not happen with normalize_columns disabled):

import sqlalchemy as sa
print(sa.column("test", sa.String))
print(sa.column("TEST", sa.String))
test
"TEST"

With normalize_columns, we send a lowercase column label to sa.column() which then does not quote it.


if isinstance(col, ColumnElement):
orderby_exprs.append(col)
Expand Down
Loading