This is an automated email from the ASF dual-hosted git repository.
pkdotson 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 a198dbb feat: add certifiedby & certification details fields to the
edit dataset columns fields (#16454)
a198dbb is described below
commit a198dbb19bcb41eb04080bcaf4c6a24e6a1d6b15
Author: Phillip Kelley-Dotson <[email protected]>
AuthorDate: Wed Sep 22 15:09:30 2021 -0700
feat: add certifiedby & certification details fields to the edit dataset
columns fields (#16454)
* add migration
* add backend and frontend for certified
* update migration with batch
* fix integration test and update Updating.md
* Update superset-frontend/src/datasource/DatasourceEditor.jsx
Co-authored-by: Geido <[email protected]>
* Update superset-frontend/src/datasource/DatasourceEditor.jsx
Co-authored-by: Geido <[email protected]>
* Update superset-frontend/src/datasource/DatasourceEditor.jsx
Co-authored-by: Geido <[email protected]>
* change method name
* add tooltip info
* add mixin
* merge heads
* address comments
* fix select label styles
* add extra field
* fix test?
* add extra field to put schema
Co-authored-by: Geido <[email protected]>
---
UPDATING.md | 73 ++++++++++++----------
.../src/datasource/DatasourceEditor.jsx | 53 ++++++++++++++--
.../src/datasource/DatasourceModal.tsx | 18 ++++--
.../explore/components/controls/SelectControl.jsx | 6 ++
.../src/views/CRUD/data/dataset/DatasetList.tsx | 16 +++++
.../src/views/CRUD/data/dataset/types.ts | 3 +-
superset/connectors/sqla/models.py | 41 +++++-------
superset/connectors/sqla/views.py | 9 +++
superset/datasets/api.py | 1 +
superset/datasets/schemas.py | 2 +
...1091c0ef16_add_extra_column_to_columns_model.py | 43 +++++++++++++
superset/models/helpers.py | 28 +++++++++
tests/integration_tests/datasets/commands_tests.py | 3 +
13 files changed, 227 insertions(+), 69 deletions(-)
diff --git a/UPDATING.md b/UPDATING.md
index e490d14..b967b82 100644
--- a/UPDATING.md
+++ b/UPDATING.md
@@ -30,7 +30,9 @@ assists people when migrating to a new version.
- [16711](https://github.com/apache/incubator-superset/pull/16711): The
`url_param` Jinja function will now by default escape the result. For instance,
the value `O'Brien` will now be changed to `O''Brien`. To disable this
behavior, call `url_param` with `escape_result` set to `False`:
`url_param("my_key", "my default", escape_result=False)`.
### Potential Downtime
+
### Deprecations
+
### Other
## 1.3.0
@@ -38,22 +40,25 @@ assists people when migrating to a new version.
### Breaking Changes
- [15909](https://github.com/apache/incubator-superset/pull/15909): a change
which
-drops a uniqueness criterion (which may or may not have existed) to the tables
table. This constraint was obsolete as it is handled by the ORM due to
differences in how MySQL, PostgreSQL, etc. handle uniqueness for NULL values.
+ drops a uniqueness criterion (which may or may not have existed) to the
tables table. This constraint was obsolete as it is handled by the ORM due to
differences in how MySQL, PostgreSQL, etc. handle uniqueness for NULL values.
### Potential Downtime
+
- [14234](https://github.com/apache/superset/pull/14234): Adds the
`limiting_factor` column to the `query` table. Give the migration includes a
DDL operation on a heavily trafficed table, potential service downtime may be
required.
+-[16454](https://github.com/apache/superset/pull/16454): Adds the `extra`
column to the `table_columns` table. Users using MySQL will either need to
schedule downtime or use the percona toolkit (or similar) to perform the
migration.
+
## 1.2.0
### Deprecations
- [13440](https://github.com/apache/superset/pull/13440): Dashboard/Charts
reports and old Alerts is deprecated. The following config keys are deprecated:
- - ENABLE_ALERTS
- - SCHEDULED_EMAIL_DEBUG_MODE
- - EMAIL_REPORTS_CRON_RESOLUTION
- - EMAIL_ASYNC_TIME_LIMIT_SEC
- - EMAIL_REPORT_BCC_ADDRESS
- - EMAIL_REPORTS_USER
+ - ENABLE_ALERTS
+ - SCHEDULED_EMAIL_DEBUG_MODE
+ - EMAIL_REPORTS_CRON_RESOLUTION
+ - EMAIL_ASYNC_TIME_LIMIT_SEC
+ - EMAIL_REPORT_BCC_ADDRESS
+ - EMAIL_REPORTS_USER
### Other
@@ -88,19 +93,21 @@ drops a uniqueness criterion (which may or may not have
existed) to the tables t
## 1.0.0
### Breaking Changes
+
- [11509](https://github.com/apache/superset/pull/12491): Dataset metadata
updates check user ownership, only owners or an Admin are allowed.
- Security simplification (SIP-19), the following permission domains were
simplified:
- - [12072](https://github.com/apache/superset/pull/12072): `Query` with
`can_read`, `can_write`
- - [12036](https://github.com/apache/superset/pull/12036): `Database` with
`can_read`, `can_write`.
- - [12012](https://github.com/apache/superset/pull/12036): `Dashboard` with
`can_read`, `can_write`.
- - [12061](https://github.com/apache/superset/pull/12061): `Log` with
`can_read`, `can_write`.
- - [12000](https://github.com/apache/superset/pull/12000): `Dataset` with
`can_read`, `can_write`.
- - [12014](https://github.com/apache/superset/pull/12014): `Annotation`
with `can_read`, `can_write`.
- - [11981](https://github.com/apache/superset/pull/11981): `Chart` with
`can_read`, `can_write`.
- - [11853](https://github.com/apache/superset/pull/11853): `ReportSchedule`
with `can_read`, `can_write`.
- - [11856](https://github.com/apache/superset/pull/11856): `CssTemplate`
with `can_read`, `can_write`.
- - [11764](https://github.com/apache/superset/pull/11764): `SavedQuery`
with `can_read`, `can_write`.
- Old permissions will be automatically migrated to these new permissions and
applied to all existing security Roles.
+
+ - [12072](https://github.com/apache/superset/pull/12072): `Query` with
`can_read`, `can_write`
+ - [12036](https://github.com/apache/superset/pull/12036): `Database` with
`can_read`, `can_write`.
+ - [12012](https://github.com/apache/superset/pull/12036): `Dashboard` with
`can_read`, `can_write`.
+ - [12061](https://github.com/apache/superset/pull/12061): `Log` with
`can_read`, `can_write`.
+ - [12000](https://github.com/apache/superset/pull/12000): `Dataset` with
`can_read`, `can_write`.
+ - [12014](https://github.com/apache/superset/pull/12014): `Annotation` with
`can_read`, `can_write`.
+ - [11981](https://github.com/apache/superset/pull/11981): `Chart` with
`can_read`, `can_write`.
+ - [11853](https://github.com/apache/superset/pull/11853): `ReportSchedule`
with `can_read`, `can_write`.
+ - [11856](https://github.com/apache/superset/pull/11856): `CssTemplate` with
`can_read`, `can_write`.
+ - [11764](https://github.com/apache/superset/pull/11764): `SavedQuery` with
`can_read`, `can_write`.
+ Old permissions will be automatically migrated to these new permissions
and applied to all existing security Roles.
- [11499](https://github.com/apache/superset/pull/11499): Breaking change:
`STORE_CACHE_KEYS_IN_METADATA_DB` config flag added (default=`False`) to write
`CacheKey` records to the metadata DB. `CacheKey` recording was enabled by
default previously.
@@ -115,42 +122,44 @@ drops a uniqueness criterion (which may or may not have
existed) to the tables t
- [11244](https://github.com/apache/superset/pull/11244): The
`REDUCE_DASHBOARD_BOOTSTRAP_PAYLOAD` feature flag has been removed after being
set to True for multiple months.
- [11172](https://github.com/apache/superset/pull/11172): Turning
-off language selectors by default as i18n is incomplete in most languages
-and requires more work. You can easily turn on the languages you want
-to expose in your environment in superset_config.py
+ off language selectors by default as i18n is incomplete in most languages
+ and requires more work. You can easily turn on the languages you want
+ to expose in your environment in superset_config.py
- [11172](https://github.com/apache/superset/pull/11172): Breaking change: SQL
templating is turned off by default. To turn it on set
`ENABLE_TEMPLATE_PROCESSING` to True on `FEATURE_FLAGS`
### Potential Downtime
+
- [11920](https://github.com/apache/superset/pull/11920): Undos the DB
migration from [11714](https://github.com/apache/superset/pull/11714) to
prevent adding new columns to the logs table. Deploying a sha between these two
PRs may result in locking your DB.
- [11714](https://github.com/apache/superset/pull/11714): Logs
-significantly more analytics events (roughly double?), and when
-using DBEventLogger (default) could result in stressing the metadata
-database more.
+ significantly more analytics events (roughly double?), and when
+ using DBEventLogger (default) could result in stressing the metadata
+ database more.
- [11098](https://github.com/apache/superset/pull/11098): includes a database
migration that adds a `uuid` column to most models, and updates
`Dashboard.position_json` to include chart UUIDs. Depending on number of
objects, the migration may take up to 5 minutes, requiring planning for
downtime.
### Deprecations
+
- [11155](https://github.com/apache/superset/pull/11155): The
`FAB_UPDATE_PERMS` config parameter is no longer required as the Superset
application correctly informs FAB under which context permissions should be
updated.
## 0.38.0
-* [10887](https://github.com/apache/superset/pull/10887): Breaking change: The
custom cache backend changed in order to support the Flask-Caching factory
method approach and thus must be registered as a custom type. See
[here](https://flask-caching.readthedocs.io/en/latest/#custom-cache-backends)
for specifics.
+- [10887](https://github.com/apache/superset/pull/10887): Breaking change: The
custom cache backend changed in order to support the Flask-Caching factory
method approach and thus must be registered as a custom type. See
[here](https://flask-caching.readthedocs.io/en/latest/#custom-cache-backends)
for specifics.
-* [10674](https://github.com/apache/superset/pull/10674): Breaking change:
PUBLIC_ROLE_LIKE_GAMMA was removed is favour of the new PUBLIC_ROLE_LIKE so it
can be set to whatever role you want.
+- [10674](https://github.com/apache/superset/pull/10674): Breaking change:
PUBLIC_ROLE_LIKE_GAMMA was removed is favour of the new PUBLIC_ROLE_LIKE so it
can be set to whatever role you want.
-* [10590](https://github.com/apache/superset/pull/10590): Breaking change:
this PR will convert iframe chart into dashboard markdown component, and remove
all `iframe`, `separator`, and `markup` slices (and support) from Superset. If
you have important data in those slices, please backup manually.
+- [10590](https://github.com/apache/superset/pull/10590): Breaking change:
this PR will convert iframe chart into dashboard markdown component, and remove
all `iframe`, `separator`, and `markup` slices (and support) from Superset. If
you have important data in those slices, please backup manually.
-* [10562](https://github.com/apache/superset/pull/10562):
EMAIL_REPORTS_WEBDRIVER is deprecated use WEBDRIVER_TYPE instead.
+- [10562](https://github.com/apache/superset/pull/10562):
EMAIL_REPORTS_WEBDRIVER is deprecated use WEBDRIVER_TYPE instead.
-* [10567](https://github.com/apache/superset/pull/10567): Default
WEBDRIVER_OPTION_ARGS are Chrome-specific. If you're using FF, should be
`--headless` only
+- [10567](https://github.com/apache/superset/pull/10567): Default
WEBDRIVER_OPTION_ARGS are Chrome-specific. If you're using FF, should be
`--headless` only
-* [10241](https://github.com/apache/superset/pull/10241): change on Alpha
role, users started to have access to "Annotation Layers", "Css Templates" and
"Import Dashboards".
+- [10241](https://github.com/apache/superset/pull/10241): change on Alpha
role, users started to have access to "Annotation Layers", "Css Templates" and
"Import Dashboards".
-* [10324](https://github.com/apache/superset/pull/10324): Facebook Prophet has
been introduced as an optional dependency to add support for timeseries
forecasting in the chart data API. To enable this feature, install Superset
with the optional dependency `prophet` or directly `pip install fbprophet`.
+- [10324](https://github.com/apache/superset/pull/10324): Facebook Prophet has
been introduced as an optional dependency to add support for timeseries
forecasting in the chart data API. To enable this feature, install Superset
with the optional dependency `prophet` or directly `pip install fbprophet`.
-* [10320](https://github.com/apache/superset/pull/10320): References to
blacklst/whitelist language have been replaced with more appropriate
alternatives. All configs refencing containing `WHITE`/`BLACK` have been
replaced with `ALLOW`/`DENY`. Affected config variables that need to be
updated: `TIME_GRAIN_BLACKLIST`, `VIZ_TYPE_BLACKLIST`,
`DRUID_DATA_SOURCE_BLACKLIST`.
+- [10320](https://github.com/apache/superset/pull/10320): References to
blacklst/whitelist language have been replaced with more appropriate
alternatives. All configs refencing containing `WHITE`/`BLACK` have been
replaced with `ALLOW`/`DENY`. Affected config variables that need to be
updated: `TIME_GRAIN_BLACKLIST`, `VIZ_TYPE_BLACKLIST`,
`DRUID_DATA_SOURCE_BLACKLIST`.
## 0.37.1
diff --git a/superset-frontend/src/datasource/DatasourceEditor.jsx
b/superset-frontend/src/datasource/DatasourceEditor.jsx
index 6d79a9e..a848176 100644
--- a/superset-frontend/src/datasource/DatasourceEditor.jsx
+++ b/superset-frontend/src/datasource/DatasourceEditor.jsx
@@ -110,6 +110,14 @@ const ColumnButtonWrapper = styled.div`
${({ theme }) => `margin-bottom: ${theme.gridUnit * 2}px`}
`;
+const StyledLabelWrapper = styled.div`
+ display: flex;
+ align-items: center;
+ span {
+ margin-right: ${({ theme }) => theme.gridUnit}px;
+ }
+`;
+
const checkboxGenerator = (d, onChange) => (
<CheckboxControl value={d} onChange={onChange} />
);
@@ -235,6 +243,28 @@ function ColumnCollectionTable({
/>
}
/>
+ <Field
+ fieldKey="certified_by"
+ label={t('Certified By')}
+ description={t('Person or group that has certified this metric')}
+ control={
+ <TextControl
+ controlId="certified"
+ placeholder={t('Certified by')}
+ />
+ }
+ />
+ <Field
+ fieldKey="certification_details"
+ label={t('Certification details')}
+ description={t('Details of the certification')}
+ control={
+ <TextControl
+ controlId="certificationDetails"
+ placeholder={t('Certification details')}
+ />
+ }
+ />
</Fieldset>
</FormContainer>
}
@@ -247,11 +277,27 @@ function ColumnCollectionTable({
}}
onChange={onChange}
itemRenderers={{
- column_name: (v, onItemChange) =>
+ column_name: (v, onItemChange, _, record) =>
editableColumnName ? (
- <EditableTitle canEdit title={v} onSaveTitle={onItemChange} />
+ <StyledLabelWrapper>
+ {record.is_certified && (
+ <CertifiedIcon
+ certifiedBy={record.certified_by}
+ details={record.certification_details}
+ />
+ )}
+ <EditableTitle canEdit title={v} onSaveTitle={onItemChange} />
+ </StyledLabelWrapper>
) : (
- v
+ <StyledLabelWrapper>
+ {record.is_certified && (
+ <CertifiedIcon
+ certifiedBy={record.certified_by}
+ details={record.certification_details}
+ />
+ )}
+ {v}
+ </StyledLabelWrapper>
),
type: d => (d ? <Label>{d}</Label> : null),
is_dttm: checkboxGenerator,
@@ -1089,7 +1135,6 @@ class DatasourceEditor extends React.PureComponent {
const { datasource, activeTabKey } = this.state;
const { metrics } = datasource;
const sortedMetrics = metrics?.length ? this.sortMetrics(metrics) : [];
-
return (
<DatasourceContainer>
{this.renderErrors()}
diff --git a/superset-frontend/src/datasource/DatasourceModal.tsx
b/superset-frontend/src/datasource/DatasourceModal.tsx
index 8f23b93..75d1708 100644
--- a/superset-frontend/src/datasource/DatasourceModal.tsx
+++ b/superset-frontend/src/datasource/DatasourceModal.tsx
@@ -64,17 +64,17 @@ interface DatasourceModalProps {
show: boolean;
}
-function buildMetricExtraJsonObject(metric: Record<string, unknown>) {
+function buildExtraJsonObject(item: Record<string, unknown>) {
const certification =
- metric?.certified_by || metric?.certification_details
+ item?.certified_by || item?.certification_details
? {
- certified_by: metric?.certified_by,
- details: metric?.certification_details,
+ certified_by: item?.certified_by,
+ details: item?.certification_details,
}
: undefined;
return JSON.stringify({
certification,
- warning_markdown: metric?.warning_markdown,
+ warning_markdown: item?.warning_markdown,
});
}
@@ -109,7 +109,13 @@ const DatasourceModal:
FunctionComponent<DatasourceModalProps> = ({
metrics: currentDatasource?.metrics?.map(
(metric: Record<string, unknown>) => ({
...metric,
- extra: buildMetricExtraJsonObject(metric),
+ extra: buildExtraJsonObject(metric),
+ }),
+ ),
+ columns: currentDatasource?.columns?.map(
+ (column: Record<string, unknown>) => ({
+ ...column,
+ extra: buildExtraJsonObject(column),
}),
),
type: currentDatasource.type || currentDatasource.datasource_type,
diff --git
a/superset-frontend/src/explore/components/controls/SelectControl.jsx
b/superset-frontend/src/explore/components/controls/SelectControl.jsx
index 6bfcece..f14c748 100644
--- a/superset-frontend/src/explore/components/controls/SelectControl.jsx
+++ b/superset-frontend/src/explore/components/controls/SelectControl.jsx
@@ -299,6 +299,12 @@ export default class SelectControl extends
React.PureComponent {
.type-label {
margin-right: ${theme.gridUnit * 2}px;
}
+ .Select__multi-value__label > span,
+ .Select__option > span,
+ .Select__single-value > span {
+ display: flex;
+ align-items: center;
+ }
`}
>
{this.props.showHeader && <ControlHeader {...this.props} />}
diff --git a/superset-frontend/src/views/CRUD/data/dataset/DatasetList.tsx
b/superset-frontend/src/views/CRUD/data/dataset/DatasetList.tsx
index bc21992..5b73d54 100644
--- a/superset-frontend/src/views/CRUD/data/dataset/DatasetList.tsx
+++ b/superset-frontend/src/views/CRUD/data/dataset/DatasetList.tsx
@@ -29,6 +29,7 @@ import {
createFetchDistinct,
createErrorHandler,
} from 'src/views/CRUD/utils';
+import { ColumnObject } from 'src/views/CRUD/data/dataset/types';
import { useListViewResource } from 'src/views/CRUD/hooks';
import ConfirmStatusChange from 'src/components/ConfirmStatusChange';
import DatasourceModal from 'src/datasource/DatasourceModal';
@@ -165,6 +166,21 @@ const DatasetList: FunctionComponent<DatasetListProps> = ({
})
.then(({ json = {} }) => {
const owners = json.result.owners.map((owner: any) => owner.id);
+ const addCertificationFields = json.result.columns.map(
+ (column: ColumnObject) => {
+ const {
+ certification: { details = '', certified_by = '' } = {},
+ } = JSON.parse(column.extra || '{}') || {};
+ return {
+ ...column,
+ certification_details: details || '',
+ certified_by: certified_by || '',
+ is_certified: details || certified_by,
+ };
+ },
+ );
+ // eslint-disable-next-line no-param-reassign
+ json.result.columns = [...addCertificationFields];
setDatasetCurrentlyEditing({ ...json.result, owners });
})
.catch(() => {
diff --git a/superset-frontend/src/views/CRUD/data/dataset/types.ts
b/superset-frontend/src/views/CRUD/data/dataset/types.ts
index abf78d4..f8fdc7b 100644
--- a/superset-frontend/src/views/CRUD/data/dataset/types.ts
+++ b/superset-frontend/src/views/CRUD/data/dataset/types.ts
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-type ColumnObject = {
+export type ColumnObject = {
id: number;
column_name: string;
type: string;
@@ -29,6 +29,7 @@ type ColumnObject = {
is_dttm: boolean;
python_date_format?: string;
uuid?: string;
+ extra?: string;
};
type MetricObject = {
diff --git a/superset/connectors/sqla/models.py
b/superset/connectors/sqla/models.py
index 66b6049..2b5c6c8 100644
--- a/superset/connectors/sqla/models.py
+++ b/superset/connectors/sqla/models.py
@@ -83,7 +83,7 @@ from superset.jinja_context import (
)
from superset.models.annotations import Annotation
from superset.models.core import Database
-from superset.models.helpers import AuditMixinNullable, QueryResult
+from superset.models.helpers import AuditMixinNullable, CertificationMixin,
QueryResult
from superset.sql_parse import ParsedQuery
from superset.typing import AdhocMetric, Metric, OrderBy, QueryObjectDict
from superset.utils import core as utils
@@ -173,7 +173,7 @@ class AnnotationDatasource(BaseDatasource):
raise NotImplementedError()
-class TableColumn(Model, BaseColumn):
+class TableColumn(Model, BaseColumn, CertificationMixin):
"""ORM object for table columns, each table can have multiple columns"""
@@ -188,6 +188,7 @@ class TableColumn(Model, BaseColumn):
is_dttm = Column(Boolean, default=False)
expression = Column(Text)
python_date_format = Column(String(255))
+ extra = Column(Text)
export_fields = [
"table_id",
@@ -201,6 +202,7 @@ class TableColumn(Model, BaseColumn):
"expression",
"description",
"python_date_format",
+ "extra",
]
update_from_object_fields = [s for s in export_fields if s not in
("table_id",)]
@@ -375,11 +377,20 @@ class TableColumn(Model, BaseColumn):
"type",
"type_generic",
"python_date_format",
+ "is_certified",
+ "certified_by",
+ "certification_details",
+ "warning_markdown",
)
- return {s: getattr(self, s) for s in attrs if hasattr(self, s)}
+ attr_dict = {s: getattr(self, s) for s in attrs if hasattr(self, s)}
-class SqlMetric(Model, BaseMetric):
+ attr_dict.update(super().data)
+
+ return attr_dict
+
+
+class SqlMetric(Model, BaseMetric, CertificationMixin):
"""ORM object for metrics, each table can have multiple metrics"""
@@ -427,28 +438,6 @@ class SqlMetric(Model, BaseMetric):
def get_perm(self) -> Optional[str]:
return self.perm
- def get_extra_dict(self) -> Dict[str, Any]:
- try:
- return json.loads(self.extra)
- except (TypeError, json.JSONDecodeError):
- return {}
-
- @property
- def is_certified(self) -> bool:
- return bool(self.get_extra_dict().get("certification"))
-
- @property
- def certified_by(self) -> Optional[str]:
- return self.get_extra_dict().get("certification",
{}).get("certified_by")
-
- @property
- def certification_details(self) -> Optional[str]:
- return self.get_extra_dict().get("certification", {}).get("details")
-
- @property
- def warning_markdown(self) -> Optional[str]:
- return self.get_extra_dict().get("warning_markdown")
-
@property
def data(self) -> Dict[str, Any]:
attrs = (
diff --git a/superset/connectors/sqla/views.py
b/superset/connectors/sqla/views.py
index 08abf54..fef8a2d 100644
--- a/superset/connectors/sqla/views.py
+++ b/superset/connectors/sqla/views.py
@@ -78,6 +78,7 @@ class TableColumnInlineView(CompactCRUDMixin,
SupersetModelView):
"expression",
"is_dttm",
"python_date_format",
+ "extra",
]
add_columns = edit_columns
list_columns = [
@@ -129,6 +130,14 @@ class TableColumnInlineView(CompactCRUDMixin,
SupersetModelView):
),
True,
),
+ "extra": utils.markdown(
+ "Extra data to specify column metadata. Currently supports "
+ 'certification data of the format: `{ "certification":
"certified_by": '
+ '"Taylor Swift", "details": "This column is the source of truth." '
+ "} }`. This should be modified from the edit datasource model in "
+ "Explore to ensure correct formatting.",
+ True,
+ ),
}
label_columns = {
"column_name": _("Column"),
diff --git a/superset/datasets/api.py b/superset/datasets/api.py
index 261a7d7..8a9d905 100644
--- a/superset/datasets/api.py
+++ b/superset/datasets/api.py
@@ -150,6 +150,7 @@ class DatasetRestApi(BaseSupersetModelRestApi):
"columns.groupby",
"columns.id",
"columns.is_active",
+ "columns.extra",
"columns.is_dttm",
"columns.python_date_format",
"columns.type",
diff --git a/superset/datasets/schemas.py b/superset/datasets/schemas.py
index a857efe..11f81fd 100644
--- a/superset/datasets/schemas.py
+++ b/superset/datasets/schemas.py
@@ -46,6 +46,7 @@ class DatasetColumnsPutSchema(Schema):
verbose_name = fields.String(allow_none=True, Length=(1, 1024))
description = fields.String(allow_none=True)
expression = fields.String(allow_none=True)
+ extra = fields.Dict(allow_none=True)
filterable = fields.Boolean()
groupby = fields.Boolean()
is_active = fields.Boolean()
@@ -127,6 +128,7 @@ class DatasetRelatedObjectsResponse(Schema):
class ImportV1ColumnSchema(Schema):
column_name = fields.String(required=True)
+ extra = fields.Dict(allow_none=True)
verbose_name = fields.String(allow_none=True)
is_dttm = fields.Boolean(default=False, allow_none=True)
is_active = fields.Boolean(default=True, allow_none=True)
diff --git
a/superset/migrations/versions/181091c0ef16_add_extra_column_to_columns_model.py
b/superset/migrations/versions/181091c0ef16_add_extra_column_to_columns_model.py
new file mode 100644
index 0000000..6adeccf
--- /dev/null
+++
b/superset/migrations/versions/181091c0ef16_add_extra_column_to_columns_model.py
@@ -0,0 +1,43 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+"""add_extra_column_to_columns_model
+
+Revision ID: 181091c0ef16
+Revises: 07071313dd52
+Create Date: 2021-08-24 23:27:30.403308
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "181091c0ef16"
+down_revision = "021b81fe4fbb"
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+from superset.utils.core import generic_find_constraint_name
+
+
+def upgrade():
+ with op.batch_alter_table("table_columns") as batch_op:
+ batch_op.add_column(sa.Column("extra", sa.Text(), nullable=True))
+
+
+def downgrade():
+ with op.batch_alter_table("table_columns") as batch_op:
+ batch_op.drop_column("extra")
diff --git a/superset/models/helpers.py b/superset/models/helpers.py
index e7a4bb8..580c906 100644
--- a/superset/models/helpers.py
+++ b/superset/models/helpers.py
@@ -476,3 +476,31 @@ class ExtraJSONMixin:
extra = self.extra
extra[key] = value
self.extra_json = json.dumps(extra)
+
+
+class CertificationMixin:
+ """Mixin to add extra certification fields"""
+
+ extra = sa.Column(sa.Text, default="{}")
+
+ def get_extra_dict(self) -> Dict[str, Any]:
+ try:
+ return json.loads(self.extra)
+ except (TypeError, json.JSONDecodeError):
+ return {}
+
+ @property
+ def is_certified(self) -> bool:
+ return bool(self.get_extra_dict().get("certification"))
+
+ @property
+ def certified_by(self) -> Optional[str]:
+ return self.get_extra_dict().get("certification",
{}).get("certified_by")
+
+ @property
+ def certification_details(self) -> Optional[str]:
+ return self.get_extra_dict().get("certification", {}).get("details")
+
+ @property
+ def warning_markdown(self) -> Optional[str]:
+ return self.get_extra_dict().get("warning_markdown")
diff --git a/tests/integration_tests/datasets/commands_tests.py
b/tests/integration_tests/datasets/commands_tests.py
index b7f61fa..1e8e902 100644
--- a/tests/integration_tests/datasets/commands_tests.py
+++ b/tests/integration_tests/datasets/commands_tests.py
@@ -92,6 +92,7 @@ class TestExportDatasetsCommand(SupersetTestCase):
"python_date_format": None,
"type": type_map["source"],
"verbose_name": None,
+ "extra": None,
},
{
"column_name": "target",
@@ -104,6 +105,7 @@ class TestExportDatasetsCommand(SupersetTestCase):
"python_date_format": None,
"type": type_map["target"],
"verbose_name": None,
+ "extra": None,
},
{
"column_name": "value",
@@ -116,6 +118,7 @@ class TestExportDatasetsCommand(SupersetTestCase):
"python_date_format": None,
"type": type_map["value"],
"verbose_name": None,
+ "extra": None,
},
],
"database_uuid": str(example_db.uuid),
