The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
import cx from "classnames";
import type { ReactNode } from "react";
import { t } from "ttag";
import {
AccordionList,
type Section,
} from "metabase/common/components/AccordionList";
import { ExternalLink } from "metabase/common/components/ExternalLink";
import {
HoverParent,
TableInfoIcon,
} from "metabase/common/components/MetadataInfo/TableInfoIcon/TableInfoIcon";
import { useDocsUrl } from "metabase/common/hooks";
import { useTranslateContent } from "metabase/content-translation/hooks";
import CS from "metabase/css/core/index.css";
import type {
DataSelectorDatabase,
DataSelectorSchema,
DataSelectorTable,
} from "metabase/querying/common/components/DataSelector";
import { Box, DelayGroup, Flex, Icon, rem } from "metabase/ui";
import { isSyncCompleted } from "metabase/utils/syncing";
import { isNotNull } from "metabase/utils/types";
import { getSchemaDisplayName } from "metabase-lib/v1/metadata/utils/schema";
import { DataSelectorSectionHeader } from "../DataSelectorSectionHeader";
import { CONTAINER_WIDTH } from "../constants";
type DataSelectorTablePickerProps = {
hasFiltering?: boolean;
hasInitialFocus?: boolean;
hasNextStep?: boolean;
isLoading?: boolean;
minTablesToShowSearch?: number;
schemas: DataSelectorSchema[];
selectedDatabase?: DataSelectorDatabase | null;
selectedSchema?: DataSelectorSchema | null;
selectedTable?: DataSelectorTable | null;
tables: DataSelectorTable[];
onBack?: (() => void) | null;
onChangeTable: (table: DataSelectorTable) => void;
};
type Item = {
name: string;
table: DataSelectorTable;
database: DataSelectorDatabase;
};
type HeaderProps = Pick<
DataSelectorTablePickerProps,
"schemas" | "selectedSchema" | "onBack"
> & {
// narrowed by the caller's early return; the header always has a database
selectedDatabase: DataSelectorDatabase;
};
export const DataSelectorTablePicker = ({
schemas,
tables,
selectedDatabase,
selectedSchema,
selectedTable,
onChangeTable,
hasNextStep,
onBack,
isLoading,
hasFiltering,
minTablesToShowSearch = 10,
hasInitialFocus,
}: DataSelectorTablePickerProps) => {
const tc = useTranslateContent();
// In case DataSelector props get reset
if (!selectedDatabase) {
if (onBack) {
onBack();
}
return null;
}
const isSavedQuestionList = selectedDatabase.is_saved_questions;
const header = (
<Header
onBack={onBack}
schemas={schemas}
selectedDatabase={selectedDatabase}
selectedSchema={selectedSchema}
/>
);
if (tables.length > 0 || isLoading) {
const sections: Section<Item>[] = [
{
name: header,
items: tables.filter(isNotNull).map((table) => ({
name: tc(table.display_name),
table: table,
database: selectedDatabase,
})),
loading: tables.length === 0 && isLoading,
type: "back",
},
];
const checkIfItemIsClickable = ({ table }: { table: DataSelectorTable }) =>
table && isSyncCompleted(table);
const checkIfItemIsSelected = ({ table }: { table: DataSelectorTable }) =>
table && selectedTable ? table.id === selectedTable.id : false;
const renderItemIcon = ({ table }: { table: DataSelectorTable }) =>
table ? <TableInfoIcon table={table} position="top-start" /> : null;
const renderItemWrapper = (content: ReactNode) => (
<HoverParent>{content}</HoverParent>
);
const showSpinner = (itemOrSection: Item | Section<Item>) =>
"table" in itemOrSection && !isSyncCompleted(itemOrSection.table);
const handleChange = ({ table }: { table: DataSelectorTable }) =>
onChangeTable(table);
const isSearchable = hasFiltering && tables.length >= minTablesToShowSearch;
return (
<DelayGroup>
<Box w={rem(300)} style={{ overflowY: "auto" }}>
<AccordionList<Item>
id="TablePicker"
key="tablePicker"
className={CS.textBrand}
hasInitialFocus={hasInitialFocus}
sections={sections}
maxHeight={Infinity}
width="100%"
searchable={isSearchable}
onChange={handleChange}
showSpinner={showSpinner}
itemIsSelected={checkIfItemIsSelected}
itemIsClickable={checkIfItemIsClickable}
renderItemIcon={renderItemIcon}
renderItemWrapper={renderItemWrapper}
showItemArrows={hasNextStep}
/>
{isSavedQuestionList && (
<LinkToDocsOnReferencingSavedQuestionsInQueries />
)}
</Box>
</DelayGroup>
);
} else {
return (
<Box component="section" w={CONTAINER_WIDTH}>
<DataSelectorSectionHeader header={header} />
<Box p="4rem" ta="center">{t`No tables found in this database.`}</Box>
</Box>
);
}
};
const LinkToDocsOnReferencingSavedQuestionsInQueries = () => {
// eslint-disable-next-line metabase/no-unconditional-metabase-links-render -- It's hard to tell if this is still used in the app. Please see https://metaboat.slack.com/archives/C505ZNNH4/p1703243785315819
const { url: docsUrl } = useDocsUrl(
"questions/native-editor/referencing-saved-questions-in-queries",
);
return (
<Box
p="lg"
ta="center"
bg={"background_page-secondary"}
style={{
borderTop: "1px solid var(--mb-color-border-neutral)",
}}
>
{t`Is a question missing?`}
<ExternalLink
href={docsUrl}
target="_blank"
className={cx(CS.block, CS.link)}
>
{t`Learn more about nested queries`}
</ExternalLink>
</Box>
);
};
const Header = ({
onBack,
schemas,
selectedDatabase,
selectedSchema,
}: HeaderProps) => {
const tc = useTranslateContent();
return (
<Flex align="center" wrap="wrap">
<Flex
align="center"
style={{ cursor: "pointer" }}
onClick={onBack ?? undefined}
>
{onBack && <Icon name="chevronleft" size={18} />}
<Box component="span" ml="sm" data-testid="source-database">
{tc(selectedDatabase.name)}
</Box>
</Flex>
{selectedSchema?.name && schemas.length > 1 && (
<>
<Box component="span" mx="sm" c="text-secondary">
/
</Box>
<Box component="span" data-testid="source-schema" c="text-secondary">
{tc(getSchemaDisplayName(selectedSchema.name))}
</Box>
</>
)}
</Flex>
);
};