This is an automated email from the ASF dual-hosted git repository.
yongjiezhao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new d1a6f0ebc4 fix: allow adhoc columns in non-aggregate query (#21729)
d1a6f0ebc4 is described below
commit d1a6f0ebc4e2dd092580ad49da7c724c577e6ece
Author: Mayur <[email protected]>
AuthorDate: Mon Oct 10 09:38:33 2022 +0530
fix: allow adhoc columns in non-aggregate query (#21729)
---
superset/connectors/sqla/models.py | 18 ++++++++---
superset/superset_typing.py | 4 +--
superset/utils/core.py | 4 ++-
tests/integration_tests/charts/data/api_tests.py | 41 ++++++++++++++++++++++++
4 files changed, 60 insertions(+), 7 deletions(-)
diff --git a/superset/connectors/sqla/models.py
b/superset/connectors/sqla/models.py
index 3b7a786441..43bbcee125 100644
--- a/superset/connectors/sqla/models.py
+++ b/superset/connectors/sqla/models.py
@@ -119,6 +119,7 @@ from superset.sql_parse import (
from superset.superset_typing import (
AdhocColumn,
AdhocMetric,
+ Column as ColumnTyping,
Metric,
OrderBy,
QueryObjectDict,
@@ -1242,7 +1243,7 @@ class SqlaTable(Model, BaseDatasource): # pylint:
disable=too-many-public-metho
def get_sqla_query( # pylint:
disable=too-many-arguments,too-many-locals,too-many-branches,too-many-statements
self,
apply_fetch_values_predicate: bool = False,
- columns: Optional[List[Column]] = None,
+ columns: Optional[List[ColumnTyping]] = None,
extras: Optional[Dict[str, Any]] = None,
filter: Optional[ # pylint: disable=redefined-builtin
List[QueryObjectFilterClause]
@@ -1438,15 +1439,24 @@ class SqlaTable(Model, BaseDatasource): # pylint:
disable=too-many-public-metho
select_exprs.append(outer)
elif columns:
for selected in columns:
+ if is_adhoc_column(selected):
+ _sql = selected["sqlExpression"]
+ _column_label = selected["label"]
+ elif isinstance(selected, str):
+ _sql = selected
+ _column_label = selected
+
selected = validate_adhoc_subquery(
- selected,
+ _sql,
self.database_id,
self.schema,
)
select_exprs.append(
columns_by_name[selected].get_sqla_col()
- if selected in columns_by_name
- else
self.make_sqla_column_compatible(literal_column(selected))
+ if isinstance(selected, str) and selected in
columns_by_name
+ else self.make_sqla_column_compatible(
+ literal_column(selected), _column_label
+ )
)
metrics_exprs = []
diff --git a/superset/superset_typing.py b/superset/superset_typing.py
index eeaca0dd51..8eaea54176 100644
--- a/superset/superset_typing.py
+++ b/superset/superset_typing.py
@@ -53,8 +53,8 @@ class AdhocMetric(TypedDict, total=False):
class AdhocColumn(TypedDict, total=False):
hasCustomLabel: Optional[bool]
- label: Optional[str]
- sqlExpression: Optional[str]
+ label: str
+ sqlExpression: str
columnType: Optional[Literal["BASE_AXIS", "SERIES"]]
timeGrain: Optional[str]
diff --git a/superset/utils/core.py b/superset/utils/core.py
index 2786cfa27f..a893696e02 100644
--- a/superset/utils/core.py
+++ b/superset/utils/core.py
@@ -1271,7 +1271,9 @@ def is_adhoc_metric(metric: Metric) ->
TypeGuard[AdhocMetric]:
def is_adhoc_column(column: Column) -> TypeGuard[AdhocColumn]:
- return isinstance(column, dict)
+ return isinstance(column, dict) and ({"label", "sqlExpression"}).issubset(
+ column.keys()
+ )
def get_base_axis_labels(columns: Optional[List[Column]]) -> Tuple[str, ...]:
diff --git a/tests/integration_tests/charts/data/api_tests.py
b/tests/integration_tests/charts/data/api_tests.py
index 4a56d0df29..acf44be6f5 100644
--- a/tests/integration_tests/charts/data/api_tests.py
+++ b/tests/integration_tests/charts/data/api_tests.py
@@ -764,6 +764,47 @@ class TestPostChartDataApi(BaseTestChartDataApi):
assert "':xyz:qwerty'" in result["query"]
assert "':qwerty:'" in result["query"]
+ @pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+ def test_with_table_columns_without_metrics(self):
+ request_payload = self.query_context_payload
+ request_payload["queries"][0]["columns"] = ["name", "gender"]
+ request_payload["queries"][0]["metrics"] = None
+ request_payload["queries"][0]["orderby"] = []
+
+ rv = self.post_assert_metric(CHART_DATA_URI, request_payload, "data")
+ result = rv.json["result"][0]
+
+ assert rv.status_code == 200
+ assert "name" in result["colnames"]
+ assert "gender" in result["colnames"]
+ assert "name" in result["query"]
+ assert "gender" in result["query"]
+ assert list(result["data"][0].keys()) == ["name", "gender"]
+
+ @pytest.mark.usefixtures("load_birth_names_dashboard_with_slices")
+ def test_with_adhoc_column_without_metrics(self):
+ request_payload = self.query_context_payload
+ request_payload["queries"][0]["columns"] = [
+ "name",
+ {
+ "label": "num divide by 10",
+ "sqlExpression": "num/10",
+ "expressionType": "SQL",
+ },
+ ]
+ request_payload["queries"][0]["metrics"] = None
+ request_payload["queries"][0]["orderby"] = []
+
+ rv = self.post_assert_metric(CHART_DATA_URI, request_payload, "data")
+ result = rv.json["result"][0]
+
+ assert rv.status_code == 200
+ assert "num divide by 10" in result["colnames"]
+ assert "name" in result["colnames"]
+ assert "num divide by 10" in result["query"]
+ assert "name" in result["query"]
+ assert list(result["data"][0].keys()) == ["name", "num divide by 10"]
+
@pytest.mark.chart_data_flow
class TestGetChartDataApi(BaseTestChartDataApi):
