mirror of
https://github.com/apache/superset.git
synced 2026-04-18 23:55:00 +00:00
c11e9c8b67
- Unify the metric interface (absorb the current plain string metric for built-in metric keys into the format used by adhoc metric) - Port the logic in adhocMetric on the client and process_metrics in the backend to the new typed Metrics class - Omit hasCustomLabel and formFromData properties from the new metric interface as their value can be inferred from label and optionName - Expose from the Metrics class both metrics and their labels as public methods to match the all_metrics and metric_labels fields in the backend code - Provide defaut values for filters, metrics and groupby in the backend
48 lines
1.6 KiB
Python
48 lines
1.6 KiB
Python
# pylint: disable=R
|
|
from typing import Dict, List, Optional
|
|
|
|
from superset import app
|
|
from superset.utils import core as utils
|
|
|
|
# TODO: Type Metrics dictionary with TypedDict when it becomes a vanilla python type
|
|
# https://github.com/python/mypy/issues/5288
|
|
Metric = Dict
|
|
|
|
|
|
class QueryObject:
|
|
"""
|
|
The query object's schema matches the interfaces of DB connectors like sqla
|
|
and druid. The query objects are constructed on the client.
|
|
"""
|
|
def __init__(
|
|
self,
|
|
granularity: str,
|
|
groupby: List[str] = None,
|
|
metrics: List[Metric] = None,
|
|
filters: List[str] = None,
|
|
time_range: Optional[str] = None,
|
|
time_shift: Optional[str] = None,
|
|
is_timeseries: bool = False,
|
|
row_limit: int = app.config.get('ROW_LIMIT'),
|
|
limit: int = 0,
|
|
timeseries_limit_metric: Optional[Metric] = None,
|
|
order_desc: bool = True,
|
|
extras: Optional[Dict] = None,
|
|
):
|
|
self.granularity = granularity
|
|
self.from_dttm, self.to_dttm = utils.get_since_until(time_range, time_shift)
|
|
self.is_timeseries = is_timeseries
|
|
self.groupby = groupby or []
|
|
self.metrics = metrics or []
|
|
self.filter = filters or []
|
|
self.row_limit = row_limit
|
|
self.timeseries_limit = int(limit)
|
|
self.timeseries_limit_metric = timeseries_limit_metric
|
|
self.order_desc = order_desc
|
|
self.prequeries = []
|
|
self.is_prequery = False
|
|
self.extras = extras
|
|
|
|
def to_dict(self):
|
|
raise NotImplementedError()
|