![]({useBaseUrl("/img/pypi.png")
-This page describes how to install Superset using the `apache-superset` package [published on PyPI](https://pypi.org/project/apache-superset/). +This page describes how to install Superset using the `apache_superset` package [published on PyPI](https://pypi.org/project/apache_superset/). ## OS Dependencies @@ -124,10 +124,10 @@ command line. ### Installing and Initializing Superset -First, start by installing `apache-superset`: +First, start by installing `apache_superset`: ```bash -pip install apache-superset +pip install apache_superset ``` Then, define mandatory configurations, SECRET_KEY and FLASK_APP: diff --git a/docs/docs/installation/upgrading-superset.mdx b/docs/docs/installation/upgrading-superset.mdx index 459223385c6..38e03822dd4 100644 --- a/docs/docs/installation/upgrading-superset.mdx +++ b/docs/docs/installation/upgrading-superset.mdx @@ -32,7 +32,7 @@ docker compose up To upgrade superset in a native installation, run the following commands: ```bash -pip install apache-superset --upgrade +pip install apache_superset --upgrade ``` ## Upgrading the Metadata Database diff --git a/pyproject.toml b/pyproject.toml index 2885418397a..55364db11f2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -20,7 +20,7 @@ requires = ["setuptools>=40.9.0", "wheel"] build-backend = "setuptools.build_meta" [project] -name = "apache-superset" +name = "apache_superset" description = "A modern, enterprise-ready business intelligence web application" readme = "README.md" dynamic = ["version", "scripts", "entry-points"] diff --git a/requirements/development.txt b/requirements/development.txt index 8e563829a52..04daa92de1c 100644 --- a/requirements/development.txt +++ b/requirements/development.txt @@ -319,7 +319,7 @@ greenlet==3.1.1 # gevent # shillelagh # sqlalchemy -grpcio==1.68.0 +grpcio==1.71.0 # via # apache-superset # google-api-core diff --git a/setup.py b/setup.py index b89288f7605..9b834cc2417 100644 --- a/setup.py +++ b/setup.py @@ -52,6 +52,7 @@ with open(VERSION_INFO_FILE, "w") as version_file: version_string = version_string.replace("-dev", ".dev0") setup( + name="apache_superset", version=version_string, packages=find_packages(), include_package_data=True, diff --git a/superset-frontend/packages/superset-ui-chart-controls/src/operators/aggregateOperator.ts b/superset-frontend/packages/superset-ui-chart-controls/src/operators/aggregateOperator.ts new file mode 100644 index 00000000000..aa3c518ad92 --- /dev/null +++ b/superset-frontend/packages/superset-ui-chart-controls/src/operators/aggregateOperator.ts @@ -0,0 +1,58 @@ +/** + * 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 limitationsxw + * under the License. + */ +import { + getMetricLabel, + ensureIsArray, + PostProcessingAggregation, + QueryFormData, + Aggregates, +} from '@superset-ui/core'; +import { PostProcessingFactory } from './types'; + +export const aggregationOperator: PostProcessingFactory< + PostProcessingAggregation +> = (formData: QueryFormData, queryObject) => { + const { aggregation = 'LAST_VALUE' } = formData; + + if (aggregation === 'LAST_VALUE') { + return undefined; + } + + const metrics = ensureIsArray(queryObject.metrics); + if (metrics.length === 0) { + return undefined; + } + + const aggregates: Aggregates = {}; + metrics.forEach(metric => { + const metricLabel = getMetricLabel(metric); + aggregates[metricLabel] = { + operator: aggregation, + column: metricLabel, + }; + }); + + return { + operation: 'aggregate', + options: { + groupby: [], + aggregates, + }, + }; +}; diff --git a/superset-frontend/packages/superset-ui-chart-controls/src/operators/index.ts b/superset-frontend/packages/superset-ui-chart-controls/src/operators/index.ts index cac7088a775..0f6a01ee127 100644 --- a/superset-frontend/packages/superset-ui-chart-controls/src/operators/index.ts +++ b/superset-frontend/packages/superset-ui-chart-controls/src/operators/index.ts @@ -21,6 +21,7 @@ export { rollingWindowOperator } from './rollingWindowOperator'; export { timeCompareOperator } from './timeCompareOperator'; export { timeComparePivotOperator } from './timeComparePivotOperator'; export { sortOperator } from './sortOperator'; +export { aggregationOperator } from './aggregateOperator'; export { histogramOperator } from './histogramOperator'; export { pivotOperator } from './pivotOperator'; export { resampleOperator } from './resampleOperator'; diff --git a/superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/customControls.tsx b/superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/customControls.tsx index d25273c08e9..bdd6d1b82cc 100644 --- a/superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/customControls.tsx +++ b/superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/customControls.tsx @@ -61,6 +61,32 @@ const xAxisSortVisibility = ({ controls }: { controls: ControlStateMapping }) => ensureIsArray(controls?.groupby?.value).length === 0 && ensureIsArray(controls?.metrics?.value).length === 1; +// TODO: Expand this aggregation options list to include all backend-supported aggregations. +// TODO: Migrate existing chart types (Pivot Table, etc.) to use this shared control. +export const aggregationControl = { + name: 'aggregation', + config: { + type: 'SelectControl', + label: t('Aggregation Method'), + default: 'LAST_VALUE', + clearable: false, + renderTrigger: false, + choices: [ + ['LAST_VALUE', t('Last Value')], + ['sum', t('Total (Sum)')], + ['mean', t('Average (Mean)')], + ['min', t('Minimum')], + ['max', t('Maximum')], + ['median', t('Median')], + ], + description: t('Select an aggregation method to apply to the metric.'), + provideFormDataToProps: true, + mapStateToProps: ({ form_data }: ControlPanelState) => ({ + value: form_data.aggregation || 'LAST_VALUE', + }), + }, +}; + const xAxisMultiSortVisibility = ({ controls, }: { diff --git a/superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/index.ts b/superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/index.ts index 8ff85439bfa..0deb6b39862 100644 --- a/superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/index.ts +++ b/superset-frontend/packages/superset-ui-chart-controls/src/shared-controls/index.ts @@ -19,6 +19,7 @@ export { default as sharedControls } from './sharedControls'; // React control components export { default as sharedControlComponents } from './components'; +export { aggregationControl } from './customControls'; export * from './components'; export * from './customControls'; export * from './mixins'; diff --git a/superset-frontend/packages/superset-ui-chart-controls/src/utils/D3Formatting.ts b/superset-frontend/packages/superset-ui-chart-controls/src/utils/D3Formatting.ts index 8295c60d9cd..3ff8fb9c1e2 100644 --- a/superset-frontend/packages/superset-ui-chart-controls/src/utils/D3Formatting.ts +++ b/superset-frontend/packages/superset-ui-chart-controls/src/utils/D3Formatting.ts @@ -78,6 +78,7 @@ export const D3_TIME_FORMAT_OPTIONS: [string, string][] = [ [SMART_DATE_ID, t('Adaptive formatting')], ['%d/%m/%Y', '%d/%m/%Y | 14/01/2019'], ['%m/%d/%Y', '%m/%d/%Y | 01/14/2019'], + ['%d.%m.%Y', '%d.%m.%Y | 14.01.2019'], ['%Y-%m-%d', '%Y-%m-%d | 2019-01-14'], ['%Y-%m-%d %H:%M:%S', '%Y-%m-%d %H:%M:%S | 2019-01-14 01:32:10'], ['%d-%m-%Y %H:%M:%S', '%d-%m-%Y %H:%M:%S | 14-01-2019 01:32:10'], diff --git a/superset-frontend/packages/superset-ui-chart-controls/test/operators/aggregateOperator.test.ts b/superset-frontend/packages/superset-ui-chart-controls/test/operators/aggregateOperator.test.ts new file mode 100644 index 00000000000..52e3e454078 --- /dev/null +++ b/superset-frontend/packages/superset-ui-chart-controls/test/operators/aggregateOperator.test.ts @@ -0,0 +1,121 @@ +/** + * 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. + */ +import { QueryObject, SqlaFormData, VizType } from '@superset-ui/core'; +import { aggregationOperator } from '@superset-ui/chart-controls'; + +describe('aggregationOperator', () => { + const formData: SqlaFormData = { + metrics: [ + 'count(*)', + { label: 'sum(val)', expressionType: 'SQL', sqlExpression: 'sum(val)' }, + ], + time_range: '2015 : 2016', + granularity: 'month', + datasource: 'foo', + viz_type: VizType.Table, + }; + + const queryObject: QueryObject = { + metrics: [ + 'count(*)', + { label: 'sum(val)', expressionType: 'SQL', sqlExpression: 'sum(val)' }, + ], + time_range: '2015 : 2016', + granularity: 'month', + }; + + test('should return undefined for LAST_VALUE aggregation', () => { + const formDataWithLastValue = { + ...formData, + aggregation: 'LAST_VALUE', + }; + + expect( + aggregationOperator(formDataWithLastValue, queryObject), + ).toBeUndefined(); + }); + + test('should return undefined when metrics is empty', () => { + const queryObjectWithoutMetrics = { + ...queryObject, + metrics: [], + }; + + const formDataWithSum = { + ...formData, + aggregation: 'sum', + }; + + expect( + aggregationOperator(formDataWithSum, queryObjectWithoutMetrics), + ).toBeUndefined(); + }); + + test('should apply sum aggregation to all metrics', () => { + const formDataWithSum = { + ...formData, + aggregation: 'sum', + }; + + expect(aggregationOperator(formDataWithSum, queryObject)).toEqual({ + operation: 'aggregate', + options: { + groupby: [], + aggregates: { + 'count(*)': { + operator: 'sum', + column: 'count(*)', + }, + 'sum(val)': { + operator: 'sum', + column: 'sum(val)', + }, + }, + }, + }); + }); + + test('should apply mean aggregation to all metrics', () => { + const formDataWithMean = { + ...formData, + aggregation: 'mean', + }; + + expect(aggregationOperator(formDataWithMean, queryObject)).toEqual({ + operation: 'aggregate', + options: { + groupby: [], + aggregates: { + 'count(*)': { + operator: 'mean', + column: 'count(*)', + }, + 'sum(val)': { + operator: 'mean', + column: 'sum(val)', + }, + }, + }, + }); + }); + + test('should use default aggregation when not specified', () => { + expect(aggregationOperator(formData, queryObject)).toBeUndefined(); + }); +}); diff --git a/superset-frontend/packages/superset-ui-chart-controls/test/operators/timeCompareOperator.test.ts b/superset-frontend/packages/superset-ui-chart-controls/test/operators/timeCompareOperator.test.ts index c7861af2ee5..437d3064bf5 100644 --- a/superset-frontend/packages/superset-ui-chart-controls/test/operators/timeCompareOperator.test.ts +++ b/superset-frontend/packages/superset-ui-chart-controls/test/operators/timeCompareOperator.test.ts @@ -54,7 +54,7 @@ const queryObject: QueryObject = { }, }, { - operation: 'aggregation', + operation: 'aggregate', options: { groupby: ['col1'], aggregates: {}, diff --git a/superset-frontend/packages/superset-ui-core/src/query/types/PostProcessing.ts b/superset-frontend/packages/superset-ui-core/src/query/types/PostProcessing.ts index a70d0111f2e..79bcabdaff1 100644 --- a/superset-frontend/packages/superset-ui-core/src/query/types/PostProcessing.ts +++ b/superset-frontend/packages/superset-ui-core/src/query/types/PostProcessing.ts @@ -67,7 +67,7 @@ export interface Aggregates { export type DefaultPostProcessing = undefined; interface _PostProcessingAggregation { - operation: 'aggregation'; + operation: 'aggregate'; options: { groupby: string[]; aggregates: Aggregates; @@ -271,7 +271,7 @@ export type PostProcessingRule = export function isPostProcessingAggregation( rule?: PostProcessingRule, ): rule is PostProcessingAggregation { - return rule?.operation === 'aggregation'; + return rule?.operation === 'aggregate'; } export function isPostProcessingBoxplot( diff --git a/superset-frontend/packages/superset-ui-core/test/query/types/PostProcessing.test.ts b/superset-frontend/packages/superset-ui-core/test/query/types/PostProcessing.test.ts index 05c385fb4e6..4e4ff949cbd 100644 --- a/superset-frontend/packages/superset-ui-core/test/query/types/PostProcessing.test.ts +++ b/superset-frontend/packages/superset-ui-core/test/query/types/PostProcessing.test.ts @@ -61,7 +61,7 @@ const AGGREGATES_OPTION: Aggregates = { }; const AGGREGATE_RULE: PostProcessingAggregation = { - operation: 'aggregation', + operation: 'aggregate', options: { groupby: ['foo'], aggregates: AGGREGATES_OPTION, diff --git a/superset-frontend/packages/superset-ui-core/test/time-comparison/getComparisonInfo.test.ts b/superset-frontend/packages/superset-ui-core/test/time-comparison/getComparisonInfo.test.ts index 9540badf334..ffaa58f48f7 100644 --- a/superset-frontend/packages/superset-ui-core/test/time-comparison/getComparisonInfo.test.ts +++ b/superset-frontend/packages/superset-ui-core/test/time-comparison/getComparisonInfo.test.ts @@ -63,6 +63,11 @@ const form_data = { header_font_size: 60, subheader_font_size: 26, comparison_color_enabled: true, + column_config: { + name: { + visible: true, + }, + }, extra_form_data: {}, force: false, result_format: 'json', @@ -142,7 +147,7 @@ describe('getComparisonInfo', () => { expect(resultFormData.adhoc_filters?.[0]).toEqual(expectedFilters[0]); }); - it('If adhoc_filter is undefrined the code wont break', () => { + it('If adhoc_filter is undefined the code wont break', () => { const resultFormData = getComparisonInfo( { ...form_data, @@ -175,4 +180,21 @@ describe('getComparisonInfo', () => { expect(resultFormData.adhoc_filters?.length).toEqual(1); expect(resultFormData.adhoc_filters).toEqual(expectedFilters); }); + + it('Updates comparison display values when toggled', () => { + const resultFormData = getComparisonInfo( + { + ...form_data, + column_config: { + name: { + visible: false, + }, + }, + }, + ComparisonTimeRangeType.Year, + {}, + ); + + expect(resultFormData.column_config.name.visible).toEqual(false); + }); }); diff --git a/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/PopKPI.tsx b/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/PopKPI.tsx index d4e5b2de0fe..63fef6432a5 100644 --- a/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/PopKPI.tsx +++ b/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/PopKPI.tsx @@ -198,16 +198,19 @@ export default function PopKPI(props: PopKPIProps) { symbol: '#', value: prevNumber, tooltipText: t('Data for %s', comparisonRange || 'previous range'), + columnKey: 'Previous value', }, { symbol: '△', value: valueDifference, tooltipText: t('Value difference between the time periods'), + columnKey: 'Delta', }, { symbol: '%', value: percentDifferenceFormattedString, tooltipText: t('Percentage difference between the time periods'), + columnKey: 'Percent change', }, ], [ @@ -218,6 +221,10 @@ export default function PopKPI(props: PopKPIProps) { ], ); + const visibleSymbols = SYMBOLS_WITH_VALUES.filter( + symbol => props.columnConfig?.[symbol.columnKey]?.visible !== false, + ); + const { isOverflowing, symbolContainerRef, wrapperRef } = useOverflowDetection(flexGap); @@ -242,51 +249,53 @@ export default function PopKPI(props: PopKPIProps) { )} -
- {SYMBOLS_WITH_VALUES.map((symbol_with_value, index) => (
-
- 0 && (
+ 0 ? backgroundColor : defaultBackgroundColor
+ }
+ textColor={index > 0 ? textColor : defaultTextColor}
+ >
+ {symbol_with_value.symbol}
+
+ {symbol_with_value.value}
+
+
+ ))}
+
+ )}
);
diff --git a/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/controlPanel.ts b/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/controlPanel.ts
index ce934c43360..bb285a70b0c 100644
--- a/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/controlPanel.ts
+++ b/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/controlPanel.ts
@@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
-import { t } from '@superset-ui/core';
+import { t, GenericDataType } from '@superset-ui/core';
import {
ControlPanelConfig,
getStandardizedControls,
@@ -106,6 +106,42 @@ const config: ControlPanelConfig = {
},
},
],
+ [
+ {
+ name: 'column_config',
+ config: {
+ type: 'ColumnConfigControl',
+ label: t('Customize columns'),
+ description: t('Further customize how to display each column'),
+ width: 400,
+ height: 320,
+ renderTrigger: true,
+ configFormLayout: {
+ [GenericDataType.Numeric]: [
+ {
+ tab: t('General'),
+ children: [['visible']],
+ },
+ ],
+ },
+ shouldMapStateToProps() {
+ return true;
+ },
+ mapStateToProps(explore, _, chart) {
+ return {
+ columnsPropsObject: {
+ colnames: ['Previous value', 'Delta', 'Percent change'],
+ coltypes: [
+ GenericDataType.Numeric,
+ GenericDataType.Numeric,
+ GenericDataType.Numeric,
+ ],
+ },
+ };
+ },
+ },
+ },
+ ],
],
},
sections.timeComparisonControls({
diff --git a/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/transformProps.ts b/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/transformProps.ts
index b434fbbc58e..9adf3e1fba7 100644
--- a/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/transformProps.ts
+++ b/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/transformProps.ts
@@ -89,6 +89,7 @@ export default function transformProps(chartProps: ChartProps) {
comparisonColorScheme,
comparisonColorEnabled,
percentDifferenceFormat,
+ columnConfig,
} = formData;
const { data: dataA = [] } = queriesData[0];
const data = dataA;
@@ -193,5 +194,6 @@ export default function transformProps(chartProps: ChartProps) {
startDateOffset,
shift: timeComparison,
dashboardTimeRange: formData?.extraFormData?.time_range,
+ columnConfig,
};
}
diff --git a/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/types.ts b/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/types.ts
index a2dbb1f29a2..8036447aa83 100644
--- a/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/types.ts
+++ b/superset-frontend/plugins/plugin-chart-echarts/src/BigNumber/BigNumberPeriodOverPeriod/types.ts
@@ -34,6 +34,10 @@ export interface PopKPIStylesProps {
comparisonColorEnabled: boolean;
}
+export type TableColumnConfig = {
+ visible?: boolean;
+};
+
interface PopKPICustomizeProps {
headerText: string;
}
@@ -67,6 +71,7 @@ export type PopKPIProps = PopKPIStylesProps &
startDateOffset?: string;
shift: string;
dashboardTimeRange?: string;
+ columnConfig?: Record
+ {visibleSymbols.map((symbol_with_value, index) => (
+
- 0 ? backgroundColor : defaultBackgroundColor
- }
- textColor={index > 0 ? textColor : defaultTextColor}
+
- {symbol_with_value.symbol}
-
- {symbol_with_value.value}
-
-
- ))}
-
+