Skip to content

Commit

Permalink
feat: per-db add metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
betodealmeida committed Aug 5, 2022
1 parent eec6e57 commit 787c513
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 10 deletions.
13 changes: 4 additions & 9 deletions superset/connectors/sqla/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -1932,7 +1932,10 @@ def fetch_metadata(self, commit: bool = True) -> MetadataResult:
:return: Tuple with lists of added, removed and modified column names.
"""
new_columns = self.external_metadata()
metrics = []
metrics = [
SqlMetric(**metric)
for metric in self.database.get_metrics(self.table_name, self.schema)
]
any_date_col = None
db_engine_spec = self.db_engine_spec

Expand Down Expand Up @@ -1989,14 +1992,6 @@ def fetch_metadata(self, commit: bool = True) -> MetadataResult:
columns.extend([col for col in old_columns if col.expression])
self.columns = columns

metrics.append(
SqlMetric(
metric_name="count",
verbose_name="COUNT(*)",
metric_type="count",
expression="COUNT(*)",
)
)
if not self.main_dttm_col:
self.main_dttm_col = any_date_col
self.add_missing_metrics(metrics)
Expand Down
35 changes: 35 additions & 0 deletions superset/db_engine_specs/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,21 @@ class LimitMethod: # pylint: disable=too-few-public-methods
FORCE_LIMIT = "force_limit"


class MetricType(TypedDict, total=False):
"""
Type for metrics return by `get_metrics`.
"""

metric_name: str
expression: str
verbose_name: Optional[str]
metric_type: Optional[str]
description: Optional[str]
d3format: Optional[str]
warning_text: Optional[str]
extra: Optional[str]


class BaseEngineSpec: # pylint: disable=too-many-public-methods
"""Abstract class for database engine specific configurations
Expand Down Expand Up @@ -1054,6 +1069,26 @@ def get_columns(
"""
return inspector.get_columns(table_name, schema)

@classmethod
def get_metrics( # pylint: disable=unused-argument
cls,
database: "Database",
inspector: Inspector,
table_name: str,
schema: Optional[str],
) -> List[MetricType]:
"""
Get all metrics from a given schema and table.
"""
return [
{
"metric_name": "count",
"verbose_name": "COUNT(*)",
"metric_type": "count",
"expression": "COUNT(*)",
}
]

@classmethod
def where_latest_partition( # pylint: disable=too-many-arguments,unused-argument
cls,
Expand Down
9 changes: 8 additions & 1 deletion superset/models/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@

from superset import app, db_engine_specs, is_feature_enabled
from superset.databases.utils import make_url_safe
from superset.db_engine_specs.base import TimeGrain
from superset.db_engine_specs.base import MetricType, TimeGrain
from superset.extensions import cache_manager, encrypted_field_factory, security_manager
from superset.models.helpers import AuditMixinNullable, ImportExportMixin
from superset.models.tags import FavStarUpdater
Expand Down Expand Up @@ -693,6 +693,13 @@ def get_columns(
) -> List[Dict[str, Any]]:
return self.db_engine_spec.get_columns(self.inspector, table_name, schema)

def get_metrics(
self,
table_name: str,
schema: Optional[str] = None,
) -> List[MetricType]:
return self.db_engine_spec.get_metrics(self, self.inspector, table_name, schema)

def get_indexes(
self, table_name: str, schema: Optional[str] = None
) -> List[Dict[str, Any]]:
Expand Down

0 comments on commit 787c513

Please sign in to comment.