Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add database and schema names to dataset option #25569

Merged
merged 7 commits into from
Oct 19, 2023
Merged

feat: add database and schema names to dataset option #25569

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cd4ecf8
add dataset label to chart creation page and dashboard filter modal
Oct 8, 2023
79755f6
fix initial dataset value and font size
Oct 12, 2023
820acad
move dataset label to src/features/datasets
Oct 16, 2023
8587b65
add datasetLabel implementation
Oct 16, 2023
afdb3e2
change NewLable to DatasetLabel
Oct 16, 2023
88aacc5
change DatasetLabel to DatasetSelectLabel
Oct 19, 2023
309aa72
fix isValidValue
Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
115 changes: 115 additions & 0 deletions .../dashboard/components/nativeFilters/FiltersConfigModal/FiltersConfigForm/DatasetLabel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/**
* 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 React from 'react';
import { Tooltip } from 'src/components/Tooltip';
import { styled } from '@superset-ui/core';

type Database = {
database_name: string;
};

type Dataset = {
id: number;
table_name: string;
schema: string;
database: Database;
};

const TooltipContent = styled.div`
${({ theme }) => `
.tooltip-header {
font-size: ${theme.typography.sizes.m}px;
font-weight: ${theme.typography.weights.bold};
}

.tooltip-description {
margin-top: ${theme.gridUnit * 2}px;
display: -webkit-box;
-webkit-line-clamp: 20;
-webkit-box-orient: vertical;
overflow: hidden;
text-overflow: ellipsis;
}
`}
`;

const StyledLabel = styled.span`
${({ theme }) => `
left: ${theme.gridUnit * 3}px;
right: ${theme.gridUnit * 3}px;
overflow: hidden;
text-overflow: ellipsis;
display: block;
`}
`;

const StyledLabelDetail = styled.span`
${({
theme: {
typography: { sizes, weights },
},
}) => `
overflow: hidden;
display: inline-block;
text-overflow: ellipsis;
font-size: ${sizes.m}px;
font-weight: ${weights.light};
max-width: 50%;
`}
`;

const StyledLabelContainer = styled.div`
${({ theme }) => `
left: ${theme.gridUnit * 3}px;
right: ${theme.gridUnit * 3}px;
overflow: hidden;
text-overflow: ellipsis;
display: block;
`}
`;

export const newLabel = (item: Dataset) => (
<Tooltip
mouseEnterDelay={1}
michael-s-molina marked this conversation as resolved.
Show resolved Hide resolved
placement="right"
title={
<TooltipContent>
<div className="tooltip-header">{item.table_name}</div>
<div className="tooltip-description">
<div>Database: {item.database.database_name}</div>
soniagtm marked this conversation as resolved.
Show resolved Hide resolved
<div>
Schema:{' '}
soniagtm marked this conversation as resolved.
Show resolved Hide resolved
{item.schema &&
!['null', 'none'].includes(item.schema.toLowerCase())
? item.schema
: 'Not defined'}
soniagtm marked this conversation as resolved.
Show resolved Hide resolved
</div>
</div>
</TooltipContent>
}
>
<StyledLabelContainer>
<StyledLabel>{item.table_name}</StyledLabel>
<StyledLabelDetail>{item.database.database_name}</StyledLabelDetail>
{item.schema && !['null', 'none'].includes(item.schema.toLowerCase()) && (
<StyledLabelDetail>&nbsp;- {item.schema}</StyledLabelDetail>
)}
</StyledLabelContainer>
</Tooltip>
);
37 changes: 27 additions & 10 deletions ...dashboard/components/nativeFilters/FiltersConfigModal/FiltersConfigForm/DatasetSelect.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,27 @@
* specific language governing permissions and limitations
* under the License.
*/
import React, { useCallback, useMemo } from 'react';
import React, { useCallback, useMemo, ReactNode } from 'react';
import rison from 'rison';
import { t } from '@superset-ui/core';
import { t, JsonResponse } from '@superset-ui/core';
import { AsyncSelect } from 'src/components';
import {
ClientErrorObject,
getClientErrorObject,
} from 'src/utils/getClientErrorObject';
import { cachedSupersetGet } from 'src/utils/cachedSupersetGet';
import { datasetToSelectOption } from './utils';
import { newLabel } from './DatasetLabel';

type Database = {
database_name: string;
};

type Dataset = {
michael-s-molina marked this conversation as resolved.
Show resolved Hide resolved
id: number;
table_name: string;
schema: string;
database: Database;
};

interface DatasetSelectProps {
onChange: (value: { label: string; value: number }) => void;
Expand All @@ -49,24 +60,29 @@ const DatasetSelect = ({ onChange, value }: DatasetSelectProps) => {
page: number,
pageSize: number,
) => {
const searchColumn = 'table_name';
const query = rison.encode({
filters: [{ col: searchColumn, opr: 'ct', value: search }],
columns: ['id', 'table_name', 'database.database_name', 'schema'],
filters: [{ col: 'table_name', opr: 'ct', value: search }],
page,
page_size: pageSize,
order_column: searchColumn,
order_column: 'table_name',
order_direction: 'asc',
});
return cachedSupersetGet({
endpoint: `/api/v1/dataset/?q=${query}`,
})
.then(response => {
const data: {
.then((response: JsonResponse) => {
const list: {
customLabel: ReactNode;
label: string;
value: string | number;
}[] = response.json.result.map(datasetToSelectOption);
}[] = response.json.result.map((item: Dataset) => ({
customLabel: newLabel(item),
label: item.table_name,
value: item.id,
}));
return {
data,
data: list,
totalCount: response.json.count,
};
})
Expand All @@ -83,6 +99,7 @@ const DatasetSelect = ({ onChange, value }: DatasetSelectProps) => {
options={loadDatasetOptions}
onChange={onChange}
notFoundContent={t('No compatible datasets found')}
placeholder={t('Select a dataset')}
/>
);
};
Expand Down
16 changes: 16 additions & 0 deletions ...board/components/nativeFilters/FiltersConfigModal/FiltersConfigForm/FiltersConfigForm.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ import {
} from './utils';
import { FILTER_SUPPORTED_TYPES, INPUT_WIDTH } from './constants';
import DependencyList from './DependencyList';
import { newLabel } from './DatasetLabel';

const TabPane = styled(Tabs.TabPane)`
padding: ${({ theme }) => theme.gridUnit * 4}px 0px;
Expand Down Expand Up @@ -689,6 +690,21 @@ const FiltersConfigForm = (
// modify the response to fit structure expected by AdhocFilterControl
dataset.type = dataset.datasource_type;
dataset.filter_select = true;
setNativeFilterFieldValues(form, filterId, {
dataset: {
value: dataset.id,
label: newLabel({
id: dataset.id,
table_name: dataset.table_name,
schema: dataset.schema,
database: {
database_name: dataset.database.database_name,
},
}),
},
defaultDataMask: null,
column: null,
});
setDatasetDetails(dataset);
})
.catch((response: SupersetApiError) => {
Expand Down
12 changes: 0 additions & 12 deletions ...tend/src/dashboard/components/nativeFilters/FiltersConfigModal/FiltersConfigForm/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,18 +66,6 @@ export const getControlItems = (
[],
) as CustomControlItem[]) ?? [];

type DatasetSelectValue = {
value: number;
label: string;
};

export const datasetToSelectOption = (
item: Dataset & { table_name: string },
): DatasetSelectValue => ({
value: item.id,
label: item.table_name,
});

// TODO: add column_types field to Dataset
// We return true if column_types is undefined or empty as a precaution against backend failing to return column_types
export const hasTemporalColumns = (
Expand Down
85 changes: 67 additions & 18 deletions superset-frontend/src/pages/ChartCreation/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,16 @@ import { findPermission } from 'src/utils/findPermission';
import { UserWithPermissionsAndRoles } from 'src/types/bootstrapTypes';
import getBootstrapData from 'src/utils/getBootstrapData';

type Database = {
database_name: string;
};

type Dataset = {
id: number;
table_name: string;
description: string;
datasource_type: string;
schema: string;
michael-s-molina marked this conversation as resolved.
Show resolved Hide resolved
database: Database;
};

export interface ChartCreationProps extends RouteComponentProps {
Expand Down Expand Up @@ -169,20 +174,18 @@ const StyledContainer = styled.div`
&&&& .ant-select-selection-placeholder {
padding-left: ${theme.gridUnit * 3}px;
}

&&&& .ant-select-selection-item {
padding-left: ${theme.gridUnit * 3}px;
}
`}
`;

const TooltipContent = styled.div<{ hasDescription: boolean }>`
${({ theme, hasDescription }) => `
const TooltipContent = styled.div`
${({ theme }) => `
.tooltip-header {
font-size: ${
hasDescription ? theme.typography.sizes.l : theme.typography.sizes.s
}px;
font-weight: ${
hasDescription
? theme.typography.weights.bold
: theme.typography.weights.normal
};
font-size: ${theme.typography.sizes.m}px;
font-weight: ${theme.typography.weights.bold};
}

.tooltip-description {
Expand All @@ -198,7 +201,31 @@ const TooltipContent = styled.div<{ hasDescription: boolean }>`

const StyledLabel = styled.span`
${({ theme }) => `
position: absolute;
display: block;
left: ${theme.gridUnit * 3}px;
right: ${theme.gridUnit * 3}px;
overflow: hidden;
text-overflow: ellipsis;
`}
`;

const StyledLabelDetail = styled.span`
${({
theme: {
typography: { sizes, weights },
},
}) => `
overflow: hidden;
display: inline-block;
text-overflow: ellipsis;
font-size: ${sizes.m}px;
font-weight: ${weights.light};
max-width: 50%;
`}
`;

const StyledLabelContainer = styled.div`
${({ theme }) => `
left: ${theme.gridUnit * 3}px;
right: ${theme.gridUnit * 3}px;
overflow: hidden;
Expand Down Expand Up @@ -299,22 +326,44 @@ export class ChartCreation extends React.PureComponent<
mouseEnterDelay={1}
michael-s-molina marked this conversation as resolved.
Show resolved Hide resolved
placement="right"
title={
<TooltipContent hasDescription={!!item.description}>
<TooltipContent>
<div className="tooltip-header">{item.table_name}</div>
{item.description && (
<div className="tooltip-description">{item.description}</div>
)}
<div className="tooltip-description">
<div>Database: {item.database.database_name}</div>
<div>
Schema:{' '}
{item.schema &&
!['null', 'none'].includes(item.schema.toLowerCase())
? item.schema
: 'Not defined'}
</div>
</div>
</TooltipContent>
}
>
<StyledLabel>{item.table_name}</StyledLabel>
<StyledLabelContainer>
<StyledLabel>{item.table_name}</StyledLabel>
<StyledLabel>
<StyledLabelDetail>{item.database.database_name}</StyledLabelDetail>
{item.schema &&
!['null', 'none'].includes(item.schema.toLowerCase()) && (
<StyledLabelDetail>&nbsp;- {item.schema}</StyledLabelDetail>
)}
</StyledLabel>
</StyledLabelContainer>
</Tooltip>
);
}

loadDatasources(search: string, page: number, pageSize: number) {
const query = rison.encode({
columns: ['id', 'table_name', 'description', 'datasource_type'],
columns: [
'id',
'table_name',
'datasource_type',
'database.database_name',
'schema',
],
filters: [{ col: 'table_name', opr: 'ct', value: search }],
page,
page_size: pageSize,
Expand Down