fix(table-chart): support orderby adhoc columns with server-side pagination by wuqicyber · Pull Request #37521 · apache/superset

wuqicyber · 2026-01-28T12:40:29Z

SUMMARY

When using server-side pagination in table charts, sorting by custom SQL expression columns (adhoc columns) fails with:
Error: Unknown column used in orderby: <column_label>

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Before:

After:

ROOT CAUSE

In superset/models/helpers.py, the orderby validation loop (lines ~2767-2810) handles:

Adhoc metrics via utils.is_adhoc_metric(col)
Named metrics via lookup in metrics_exprs_by_label
Physical columns via lookup in columns_by_name
However, it does NOT handle adhoc columns (SQL expression columns with expressionType: "SQL"). When the orderby value is a string label that matches an adhoc column, the code fails to recognize it and raises QueryObjectValidationError.

TESTING INSTRUCTIONS

Create a table chart with server-side pagination enabled
Add a custom SQL expression column (e.g., {"expressionType": "SQL", "label": "custom_col", "sqlExpression": "column_a + 1"})
Click the adhoc column header to sort
Verify sorting works without error

ADDITIONAL INFORMATION

Has associated issue: Fixes Unknown column used in orderby for SQL expression columns (server-side pagination) #37520
Required feature flags:
Changes UI
Includes DB Migration (follow approval process in SIP-59)
- 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

…nation

bito-code-review · 2026-01-28T12:40:39Z

Code Review Agent Run #737cc3

Actionable Suggestions - 0

Review Details

Files reviewed - 2 · Commit Range: 6d4d9d7..6d4d9d7
- superset/models/helpers.py
- tests/unit_tests/models/helpers_test.py
Files skipped - 0
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- MyPy (Static Code Analysis) - ✔︎ Successful
- Astral Ruff (Static Code Analysis) - ✔︎ Successful

Bito Usage Guide

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 documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by

…nation

…side-pagination' into fix/orderby-adhoc-column-server-side-pagination

bito-code-review · 2026-01-28T13:56:10Z

Code Review Agent Run #873428

Actionable Suggestions - 0

Review Details

Files reviewed - 2 · Commit Range: 6d4d9d7..1521ab1
- superset/models/helpers.py
- tests/unit_tests/models/helpers_test.py
Files skipped - 0
Tools
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful
- MyPy (Static Code Analysis) - ✔︎ Successful
- Astral Ruff (Static Code Analysis) - ✔︎ Successful

Bito Usage Guide

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 documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by

codecov · 2026-01-28T18:34:29Z

Codecov Report

❌ Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 66.58%. Comparing base (76d897e) to head (1521ab1).
⚠️ Report is 3911 commits behind head on master.

Files with missing lines	Patch %	Lines
superset/models/helpers.py	0.00%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #37521      +/-   ##
==========================================
+ Coverage   60.48%   66.58%   +6.09%     
==========================================
  Files        1931      643    -1288     
  Lines       76236    49053   -27183     
  Branches     8568     5502    -3066     
==========================================
- Hits        46114    32661   -13453     
+ Misses      28017    15097   -12920     
+ Partials     2105     1295     -810

Flag	Coverage Δ
hive	`41.91% <0.00%> (-7.24%)`	⬇️
javascript	`?`
mysql	`64.64% <0.00%> (?)`
postgres	`64.72% <0.00%> (?)`
presto	`41.93% <0.00%> (-11.87%)`	⬇️
python	`66.55% <0.00%> (+3.04%)`	⬆️
sqlite	`64.41% <0.00%> (?)`
unit	`100.00% <ø> (+42.36%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2026-02-20T20:30:20Z

🎪 Showtime is building environment on GHA for 1521ab1

github-actions · 2026-02-20T20:52:27Z

🎪 Showtime deployed environment on GHA for 1521ab1

• Environment: http://35.89.228.163:8080 (admin/admin)
• Lifetime: 48h auto-cleanup
• Updates: New commits create fresh environments automatically

SBIN2010

LGTM! Thank you for your contribution!
During manual testing, everything works correctly.

dosubot · 2026-02-20T21:29:43Z

Related Documentation

Checked 0 published document(s) in 2 knowledge base(s). No updates required.

^{How did I do? Any feedback?}

…nation (#37521) (cherry picked from commit 6f34ba7)

…nation (apache#37521)

…e chart When a column label is renamed in the Table chart (e.g. 'CustomerID' to 'Id'), the search filter sends the display label ('Id') but the backend columns_by_name dict is keyed by physical column names. This causes the filter to be silently rejected with 'not_in_datasource'. Add a fallback that resolves the filter column against adhoc_columns_by_label (the same pattern used by PR apache#37521 for ORDER BY). Also update the rejected/applied filter columns computation to recognize adhoc column labels. Fixes apache#38339

fix(table-chart): support orderby adhoc columns with server-side pagi…

6d4d9d7

…nation

pull-request-size Bot added the size/M label Jan 28, 2026

dosubot Bot added change:backend Requires changing the backend viz:charts:table Related to the Table chart labels Jan 28, 2026

codeant-ai-for-open-source Bot reviewed Jan 28, 2026

View reviewed changes

Comment thread superset/models/helpers.py

wuqicyber added 3 commits January 28, 2026 20:49

fix(table-chart): support orderby adhoc columns with server-side pagi…

f3f1272

…nation

Merge remote-tracking branch 'origin/fix/orderby-adhoc-column-server-…

21be11a

…side-pagination' into fix/orderby-adhoc-column-server-side-pagination

fix(table-chart): remove unnecessary format

1521ab1

rusackas requested review from Antonio-RiveroMartnez and kgabryje January 28, 2026 18:24

rusackas requested a review from SBIN2010 February 19, 2026 21:19

SBIN2010 added the 🎪 ⚡ showtime-trigger-start Create new ephemeral environment for this PR label Feb 20, 2026

github-actions Bot added 🎪 1521ab1 🚦 building 🎪 ⌛ 48h Environment expires after 48 hours (default) and removed 🎪 ⚡ showtime-trigger-start Create new ephemeral environment for this PR labels Feb 20, 2026

github-actions Bot added 🎪 1521ab1 🚦 deploying and removed 🎪 1521ab1 🚦 building labels Feb 20, 2026

SBIN2010 approved these changes Feb 20, 2026

View reviewed changes

SBIN2010 merged commit 6f34ba7 into apache:master Feb 20, 2026
78 checks passed

sadpandajoe pushed a commit that referenced this pull request Feb 26, 2026

fix(table-chart): support orderby adhoc columns with server-side pagi…

3686403

…nation (#37521) (cherry picked from commit 6f34ba7)

sadpandajoe added the v6.0 Label added by the release manager to track PRs to be included in the 6.0 branch label Feb 28, 2026

This was referenced Mar 2, 2026

Search is not working after editing/renaming the label/column in Table chart #38339

Closed

Sorting is not working after editing/renaming the label/column in Table chart #38340

Closed

sadpandajoe removed 🎪 1521ab1 📅 2026-02-20T20-30 labels Mar 19, 2026

qfcwell pushed a commit to qfcwell/superset that referenced this pull request May 12, 2026

fix(table-chart): support orderby adhoc columns with server-side pagi…

edd7383

…nation (apache#37521)

mistercrunch removed the 🎪 ⌛ 48h Environment expires after 48 hours (default) label Jun 28, 2026

prathamesh04 mentioned this pull request Jul 19, 2026

fix(query): resolve search filter against adhoc column labels in Table chart #42216

Closed

6 tasks

Navigation Menu

Uh oh!

fix(table-chart): support orderby adhoc columns with server-side pagination - #37521

fix(table-chart): support orderby adhoc columns with server-side pagination#37521
SBIN2010 merged 4 commits into
apache:masterfrom
wuqicyber:fix/orderby-adhoc-column-server-side-pagination

wuqicyber commented Jan 28, 2026 •

edited

Loading

Uh oh!

bito-code-review Bot commented Jan 28, 2026 •

edited

Loading

Code Review Agent Run #737cc3

Uh oh!

Uh oh!

bito-code-review Bot commented Jan 28, 2026 •

edited

Loading

Code Review Agent Run #873428

Uh oh!

codecov Bot commented Jan 28, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Feb 20, 2026

Uh oh!

github-actions Bot commented Feb 20, 2026

Uh oh!

SBIN2010 left a comment

Uh oh!

Uh oh!

dosubot Bot commented Feb 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

wuqicyber commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

ROOT CAUSE

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

Uh oh!

bito-code-review Bot commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #737cc3

Uh oh!

Uh oh!

bito-code-review Bot commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #873428

Uh oh!

codecov Bot commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Feb 20, 2026

Uh oh!

github-actions Bot commented Feb 20, 2026

Uh oh!

SBIN2010 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dosubot Bot commented Feb 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

wuqicyber commented Jan 28, 2026 •

edited

Loading

bito-code-review Bot commented Jan 28, 2026 •

edited

Loading

bito-code-review Bot commented Jan 28, 2026 •

edited

Loading

codecov Bot commented Jan 28, 2026 •

edited

Loading