/**
* 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 { SupersetClient, t, styled } from '@superset-ui/core';
import React, { useState, useMemo } from 'react';
import rison from 'rison';
import { isFeatureEnabled, FeatureFlag } from 'src/featureFlags';
import { useListViewResource } from 'src/views/CRUD/hooks';
import { createErrorHandler } from 'src/views/CRUD/utils';
import withToasts from 'src/messageToasts/enhancers/withToasts';
import SubMenu, { SubMenuProps } from 'src/components/Menu/SubMenu';
import DeleteModal from 'src/components/DeleteModal';
import { Tooltip } from 'src/components/Tooltip';
import Icons from 'src/components/Icons';
import ListView, { FilterOperator, Filters } from 'src/components/ListView';
import { commonMenuData } from 'src/views/CRUD/data/common';
import ImportModelsModal from 'src/components/ImportModal/index';
import DatabaseModal from './DatabaseModal';
import { DatabaseObject } from './types';
const PAGE_SIZE = 25;
const PASSWORDS_NEEDED_MESSAGE = t(
'The passwords for the databases below are needed in order to ' +
'import them. Please note that the "Secure Extra" and "Certificate" ' +
'sections of the database configuration are not present in export ' +
'files, and should be added manually after the import if they are needed.',
);
const CONFIRM_OVERWRITE_MESSAGE = t(
'You are importing one or more databases that already exist. ' +
'Overwriting might cause you to lose some of your work. Are you ' +
'sure you want to overwrite?',
);
interface DatabaseDeleteObject extends DatabaseObject {
chart_count: number;
dashboard_count: number;
}
interface DatabaseListProps {
addDangerToast: (msg: string) => void;
addSuccessToast: (msg: string) => void;
}
const IconCheck = styled(Icons.Check)`
color: ${({ theme }) => theme.colors.grayscale.dark1};
`;
const IconCancelX = styled(Icons.CancelX)`
color: ${({ theme }) => theme.colors.grayscale.dark1};
`;
const Actions = styled.div`
color: ${({ theme }) => theme.colors.grayscale.base};
`;
function BooleanDisplay({ value }: { value: Boolean }) {
return value ? : ;
}
function DatabaseList({ addDangerToast, addSuccessToast }: DatabaseListProps) {
const {
state: {
loading,
resourceCount: databaseCount,
resourceCollection: databases,
},
hasPerm,
fetchData,
refreshData,
} = useListViewResource(
'database',
t('database'),
addDangerToast,
);
const [databaseModalOpen, setDatabaseModalOpen] = useState(false);
const [
databaseCurrentlyDeleting,
setDatabaseCurrentlyDeleting,
] = useState(null);
const [currentDatabase, setCurrentDatabase] = useState(
null,
);
const [importingDatabase, showImportModal] = useState(false);
const [passwordFields, setPasswordFields] = useState([]);
const openDatabaseImportModal = () => {
showImportModal(true);
};
const closeDatabaseImportModal = () => {
showImportModal(false);
};
const handleDatabaseImport = () => {
showImportModal(false);
refreshData();
};
const openDatabaseDeleteModal = (database: DatabaseObject) =>
SupersetClient.get({
endpoint: `/api/v1/database/${database.id}/related_objects/`,
})
.then(({ json = {} }) => {
setDatabaseCurrentlyDeleting({
...database,
chart_count: json.charts.count,
dashboard_count: json.dashboards.count,
});
})
.catch(
createErrorHandler(errMsg =>
t(
'An error occurred while fetching database related data: %s',
errMsg,
),
),
);
function handleDatabaseDelete({ id, database_name: dbName }: DatabaseObject) {
SupersetClient.delete({
endpoint: `/api/v1/database/${id}`,
}).then(
() => {
refreshData();
addSuccessToast(t('Deleted: %s', dbName));
// Close delete modal
setDatabaseCurrentlyDeleting(null);
},
createErrorHandler(errMsg =>
addDangerToast(t('There was an issue deleting %s: %s', dbName, errMsg)),
),
);
}
function handleDatabaseEdit(database: DatabaseObject) {
// Set database and open modal
setCurrentDatabase(database);
setDatabaseModalOpen(true);
}
const canCreate = hasPerm('can_write');
const canEdit = hasPerm('can_write');
const canDelete = hasPerm('can_write');
const canExport =
hasPerm('can_read') && isFeatureEnabled(FeatureFlag.VERSIONED_EXPORT);
const menuData: SubMenuProps = {
activeChild: 'Databases',
...commonMenuData,
};
if (canCreate) {
menuData.buttons = [
{
'data-test': 'btn-create-database',
name: (
<>
{t('Database')}{' '}
>
),
buttonStyle: 'primary',
onClick: () => {
// Ensure modal will be opened in add mode
setCurrentDatabase(null);
setDatabaseModalOpen(true);
},
},
];
if (isFeatureEnabled(FeatureFlag.VERSIONED_EXPORT)) {
menuData.buttons.push({
name: (
),
buttonStyle: 'link',
onClick: openDatabaseImportModal,
});
}
}
function handleDatabaseExport(database: DatabaseObject) {
return window.location.assign(
`/api/v1/database/export/?q=${rison.encode([database.id])}`,
);
}
const initialSort = [{ id: 'changed_on_delta_humanized', desc: true }];
const columns = useMemo(
() => [
{
accessor: 'database_name',
Header: t('Database'),
},
{
accessor: 'backend',
Header: t('Backend'),
size: 'lg',
disableSortBy: true, // TODO: api support for sorting by 'backend'
},
{
accessor: 'allow_run_async',
Header: (
),
Cell: ({
row: {
original: { allow_run_async: allowRunAsync },
},
}: any) => ,
size: 'sm',
},
{
accessor: 'allow_dml',
Header: (
),
Cell: ({
row: {
original: { allow_dml: allowDML },
},
}: any) => ,
size: 'sm',
},
{
accessor: 'allow_csv_upload',
Header: t('CSV upload'),
Cell: ({
row: {
original: { allow_csv_upload: allowCSVUpload },
},
}: any) => ,
size: 'md',
},
{
accessor: 'expose_in_sqllab',
Header: t('Expose in SQL Lab'),
Cell: ({
row: {
original: { expose_in_sqllab: exposeInSqllab },
},
}: any) => ,
size: 'md',
},
{
accessor: 'created_by',
disableSortBy: true,
Header: t('Created by'),
Cell: ({
row: {
original: { created_by: createdBy },
},
}: any) =>
createdBy ? `${createdBy.first_name} ${createdBy.last_name}` : '',
size: 'xl',
},
{
Cell: ({
row: {
original: { changed_on_delta_humanized: changedOn },
},
}: any) => changedOn,
Header: t('Last modified'),
accessor: 'changed_on_delta_humanized',
size: 'xl',
},
{
Cell: ({ row: { original } }: any) => {
const handleEdit = () => handleDatabaseEdit(original);
const handleDelete = () => openDatabaseDeleteModal(original);
const handleExport = () => handleDatabaseExport(original);
if (!canEdit && !canDelete && !canExport) {
return null;
}
return (
{canDelete && (
)}
{canExport && (
)}
{canEdit && (
)}
);
},
Header: t('Actions'),
id: 'actions',
hidden: !canEdit && !canDelete,
disableSortBy: true,
},
],
[canDelete, canEdit, canExport],
);
const filters: Filters = useMemo(
() => [
{
Header: t('Expose in SQL Lab'),
id: 'expose_in_sqllab',
input: 'select',
operator: FilterOperator.equals,
unfilteredLabel: 'All',
selects: [
{ label: 'Yes', value: true },
{ label: 'No', value: false },
],
},
{
Header: (
),
id: 'allow_run_async',
input: 'select',
operator: FilterOperator.equals,
unfilteredLabel: 'All',
selects: [
{ label: 'Yes', value: true },
{ label: 'No', value: false },
],
},
{
Header: t('Search'),
id: 'database_name',
input: 'search',
operator: FilterOperator.contains,
},
],
[],
);
return (
<>
setDatabaseModalOpen(false)}
onDatabaseAdd={() => {
refreshData();
}}
/>
{databaseCurrentlyDeleting && (
{
if (databaseCurrentlyDeleting) {
handleDatabaseDelete(databaseCurrentlyDeleting);
}
}}
onHide={() => setDatabaseCurrentlyDeleting(null)}
open
title={t('Delete Database?')}
/>
)}
className="database-list-view"
columns={columns}
count={databaseCount}
data={databases}
fetchData={fetchData}
filters={filters}
initialSort={initialSort}
loading={loading}
pageSize={PAGE_SIZE}
/>
>
);
}
export default withToasts(DatabaseList);