Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Add side-panel to Tables and Metrics in the Library (#69673)

Denis Berezin659d0a37b1d6
diff --git a/e2e/support/helpers/e2e-data-studio-helpers.ts b/e2e/support/helpers/e2e-data-studio-helpers.ts
index f9e14dbf4ad..086248e6819 100644
--- a/e2e/support/helpers/e2e-data-studio-helpers.ts
+++ b/e2e/support/helpers/e2e-data-studio-helpers.ts
@@ -111,6 +111,8 @@ export const DataStudio = {
dependenciesTab: () =>
DataStudio.Metrics.header().findByText("Dependencies"),
cachingTab: () => DataStudio.Metrics.header().findByText("Caching"),
+ overviewPageDescriptionSidebar: () =>
+ metricOverviewPage().findByTestId("metric-description-sidebar"),
},
Tables: {
overviewPage: () => cy.findByTestId("table-overview-page"),
@@ -150,6 +152,8 @@ export const DataStudio = {
.click(),
Overview: {
+ descriptionSidebar: () => cy.findByTestId("table-description-sidebar"),
+
descriptionText: () =>
cy
.findByTestId("table-description-section")
diff --git a/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts b/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
index bf5ac3bc011..f5dbef913b0 100644
--- a/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
@@ -70,11 +70,18 @@ describe("scenarios > data studio > library > metrics", () => {
cy.findByText("Sum of all order totals across the store").should(
"be.visible",
);
+ });
+
+ H.DataStudio.Metrics.overviewPageDescriptionSidebar().within(() => {
+ cy.findByText("Last edited by Bobby Tables").should("be.visible");
+
cy.findByText("Sample Database").should("be.visible");
- cy.findByText("PUBLIC").should("be.visible");
+
cy.findByText("Orders").should("be.visible");
- cy.findByText("Creator and last editor").should("be.visible");
- cy.findAllByText(/by Bobby Tables/).should("be.visible");
+ cy.findByText("Source table").should("be.visible");
+
+ cy.findByText("Dependencies").should("be.visible");
+ cy.findByText("Dependents").should("be.visible");
});
cy.log("Ensure chart is visible");
diff --git a/e2e/test/scenarios/data-studio/data-studio-tables.cy.spec.ts b/e2e/test/scenarios/data-studio/data-studio-tables.cy.spec.ts
index b721b940dac..3dcb4c71ab8 100644
--- a/e2e/test/scenarios/data-studio/data-studio-tables.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/data-studio-tables.cy.spec.ts
@@ -83,6 +83,33 @@ describe("scenarios > data studio > library > tables", () => {
.contains("Table description updated")
.should("be.visible");
});
+
+ it("should be able to view additional properties in sidebar", () => {
+ H.DataStudio.Tables.Overview.descriptionSidebar().within(() => {
+ cy.findByText("Entity type").should("be.visible");
+
+ cy.findByText("Last edited at").should("be.visible");
+
+ cy.findByText("Database").should("be.visible");
+ cy.findByText("Sample Database").should("be.visible");
+
+ cy.findByText("Source").should("be.visible");
+ cy.findByPlaceholderText("Select a data source").should(
+ "have.value",
+ "Ingested",
+ );
+
+ cy.findByText("Owner").should("be.visible");
+
+ cy.findByPlaceholderText("Pick someone, or type an email").should(
+ "have.value",
+ "No owner",
+ );
+ cy.findByText("Fields").should("be.visible");
+
+ cy.findByText("Dependents").should("be.visible");
+ });
+ });
});
describe("fields", () => {
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/DescriptionSection/DescriptionSection.module.css b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/DescriptionSection/DescriptionSection.module.css
new file mode 100644
index 00000000000..cf6fd02c163
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/DescriptionSection/DescriptionSection.module.css
@@ -0,0 +1,5 @@
+.metricLink {
+ :hover {
+ color: var(--mb-color-brand);
+ }
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/DescriptionSection/DescriptionSection.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/DescriptionSection/DescriptionSection.tsx
index cc89f88ab1c..bba99d61ec8 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/DescriptionSection/DescriptionSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/DescriptionSection/DescriptionSection.tsx
@@ -1,20 +1,49 @@
import { t } from "ttag";
-import { useUpdateCardMutation } from "metabase/api";
+import {
+ useGetDatabaseQuery,
+ useGetTableQuery,
+ useUpdateCardMutation,
+} from "metabase/api";
+import { DateTime } from "metabase/common/components/DateTime";
import { EditableText } from "metabase/common/components/EditableText";
+import { Link } from "metabase/common/components/Link/Link";
import { Markdown } from "metabase/common/components/Markdown";
+import * as Urls from "metabase/lib/urls";
+import { getUserName } from "metabase/lib/user";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { Box } from "metabase/ui";
-import type { Card, CardType } from "metabase-types/api";
+import { PLUGIN_DEPENDENCIES } from "metabase/plugins";
+import { Box, Card, Flex, Group, Icon, Stack, Text, rem } from "metabase/ui";
+import type { Card as CardApiType, CardType } from "metabase-types/api";
+
+import S from "./DescriptionSection.module.css";
type DescriptionSectionProps = {
- card: Card;
+ card: CardApiType;
};
export function DescriptionSection({ card }: DescriptionSectionProps) {
const [updateCard] = useUpdateCardMutation();
const { sendSuccessToast, sendErrorToast } = useMetadataToasts();
+ const isDependenciesEnabled = PLUGIN_DEPENDENCIES.isEnabled;
+
+ const { data: database } = useGetDatabaseQuery(
+ { id: card.database_id! },
+ { skip: !card.database_id },
+ );
+
+ const { data: table } = useGetTableQuery(
+ { id: card.table_id! },
+ { skip: !card.table_id },
+ );
+
+ const { dependentsCount, dependenciesCount } =
+ PLUGIN_DEPENDENCIES.useGetDependenciesCount({
+ id: Number(card.id),
+ type: "card",
+ });
+
const handleChange = async (newValue: string) => {
const newDescription = newValue.trim();
const { error } = await updateCard({
@@ -28,25 +57,123 @@ export function DescriptionSection({ card }: DescriptionSectionProps) {
}
};
- if (card.can_write) {
- return (
- <Box>
- <EditableText
- initialValue={card.description ?? ""}
- placeholder={t`No description`}
- isMarkdown
- onChange={handleChange}
- px={0}
- />
+ return (
+ <Stack gap={0} align="stretch" data-testid="metric-description-sidebar">
+ {/* Description */}
+ <Box data-testid="metric-description-section" p={rem(20)}>
+ {card.can_write ? (
+ <EditableText
+ initialValue={card.description ?? ""}
+ placeholder={t`No description`}
+ isMarkdown
+ isOptional
+ isMultiline
+ onChange={handleChange}
+ px={0}
+ />
+ ) : (
+ <Markdown>{card.description || t`No description`}</Markdown>
+ )}
</Box>
- );
- }
- if (card.description) {
- return <Markdown>{card.description}</Markdown>;
- }
+ {/* Metadata Sections */}
+ <Card mx="lg" bg="background-secondary" shadow="none" radius="1rem">
+ <Card.Section withBorder p="md">
+ <Group gap="sm" mb={4}>
+ <Icon name="pencil" c="brand" />
+ <Text size="md" fw={600} lh="1rem">
+ <DateTime value={card.updated_at} />
+ </Text>
+ </Group>
+ <Text size="sm" c="text-secondary" lh="1rem" ml="1.5rem">
+ {card["last-edit-info"]
+ ? t`Last edited by ${getUserName(card["last-edit-info"])}`
+ : t`Last edited at`}
+ </Text>
+ </Card.Section>
+ <Card.Section withBorder p="md">
+ <Group gap="sm" mb={4}>
+ <Icon name="database" c="brand" />
+
+ {database ? (
+ <Link to={Urls.dataStudioData({ databaseId: database.id })}>
+ <Text size="md" fw={600} lh="1rem">
+ {database.name}
+ </Text>
+ </Link>
+ ) : (
+ <Text size="md" fw={600} lh="1rem">
+ —
+ </Text>
+ )}
+ </Group>
+ <Text size="sm" c="text-secondary" lh="1rem" ml="1.5rem">
+ {t`Database`}
+ </Text>
+ </Card.Section>
+ <Card.Section withBorder p="md">
+ <Group gap="sm" mb={4}>
+ <Icon name="table" c={table ? "brand" : "icon-secondary"} />
+ <Text size="md" fw={600} lh="1rem">
+ {table?.display_name || table?.name || "—"}
+ </Text>
+ </Group>
+ <Text size="sm" c="text-secondary" lh="1rem" ml="1.5rem">
+ {t`Source table`}
+ </Text>
+ </Card.Section>
+ </Card>
+
+ {/* Statistics */}
+ {isDependenciesEnabled && (
+ <Card mx="lg" my="lg" shadow="none">
+ <Card.Section withBorder py={rem(12)} px="md">
+ <Flex justify="space-between" align="center">
+ <Text size="md" c="text-secondary">
+ {t`Dependencies`}
+ </Text>
+ {dependenciesCount > 0 ? (
+ <Link
+ to={Urls.dataStudioMetricDependencies(card.id)}
+ className={S.metricLink}
+ >
+ <Text size="xl" fw={600}>
+ {dependenciesCount}
+ </Text>
+ </Link>
+ ) : (
+ <Text size="xl" fw={600}>
+ {dependenciesCount}
+ </Text>
+ )}
+ </Flex>
+ </Card.Section>
+ <Card.Section withBorder py={rem(12)} px="md">
+ <Flex justify="space-between" align="center">
+ <Text size="md" c="text-secondary">
+ {t`Dependents`}
+ </Text>
- return <Box c="text-secondary" lh="h4">{t`No description`}</Box>;
+ {dependentsCount > 0 ? (
+ <Link
+ to={Urls.dataStudioMetricDependencies(card.id)}
+ className={S.metricLink}
+ >
+ <Text size="xl" fw={600}>
+ {dependentsCount}
+ </Text>
+ </Link>
+ ) : (
+ <Text size="xl" fw={600}>
+ {dependentsCount}
+ </Text>
+ )}
+ </Flex>
+ </Card.Section>
+ </Card>
+ )}
+ </Stack>
+ );
}
function getSuccessMessage(cardType: CardType) {
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/MetricOverview.module.css b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/MetricOverview.module.css
index 0c93fdb0ca8..d683f06cd89 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/MetricOverview.module.css
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/MetricOverview.module.css
@@ -2,6 +2,11 @@
overflow: auto;
}
-.sidebar {
- flex-shrink: 0;
+.descriptionSection {
+ background-color: var(--mb-color-background-primary);
+ border: 1px solid var(--mb-color-border);
+ border-left: none;
+ border-top-right-radius: var(--default-border-radius);
+ border-bottom-right-radius: var(--default-border-radius);
+ overflow: auto;
}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/MetricOverview.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/MetricOverview.tsx
index ee1cfa68a27..873aa0798a6 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/MetricOverview.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/MetricOverview.tsx
@@ -1,11 +1,9 @@
-import { EntityCreationInfo } from "metabase/common/components/EntityCreationInfo";
import { OverviewVisualization } from "metabase/data-studio/common/components/OverviewVisualization";
import { Flex, Stack } from "metabase/ui";
import type { Card } from "metabase-types/api";
import { DescriptionSection } from "./DescriptionSection";
import S from "./MetricOverview.module.css";
-import { QuerySourceSection } from "./QuerySourceSection";
type MetricOverviewProps = {
card: Card;
@@ -17,15 +15,8 @@ export function MetricOverview({ card }: MetricOverviewProps) {
<Flex direction="column" flex={1} mah={700}>
<OverviewVisualization card={card} />
</Flex>
- <Stack w={300} ml="lg" gap="lg" className={S.sidebar}>
+ <Stack flex="0 0 360px" className={S.descriptionSection} mah={700}>
<DescriptionSection card={card} />
- <QuerySourceSection card={card} />
- <EntityCreationInfo
- createdAt={card.created_at}
- creator={card.creator}
- lastEditedAt={card["last-edit-info"]?.timestamp}
- lastEditor={card["last-edit-info"]}
- />
</Stack>
</Flex>
);
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/QuerySourceSection/QuerySourceInfo.module.css b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/QuerySourceSection/QuerySourceInfo.module.css
deleted file mode 100644
index 9183caa2576..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/QuerySourceSection/QuerySourceInfo.module.css
+++ /dev/null
@@ -1,6 +0,0 @@
-.link {
- &:hover {
- text-decoration: none;
- color: var(--mb-color-brand);
- }
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/QuerySourceSection/QuerySourceSection.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/QuerySourceSection/QuerySourceSection.tsx
deleted file mode 100644
index 1db0dea4c8c..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/QuerySourceSection/QuerySourceSection.tsx
+++ /dev/null
@@ -1,174 +0,0 @@
-import { Fragment, useMemo } from "react";
-import { Link } from "react-router";
-import { t } from "ttag";
-
-import { useGetCardQuery, useGetTableQuery } from "metabase/api";
-import { useSelector } from "metabase/lib/redux";
-import * as Urls from "metabase/lib/urls";
-import { getMetadata } from "metabase/selectors/metadata";
-import { Group, Stack, Title } from "metabase/ui";
-import * as Lib from "metabase-lib";
-import type { Card, CardId, TableId } from "metabase-types/api";
-
-import S from "./QuerySourceInfo.module.css";
-
-type QuerySourceSectionProps = {
- card: Card;
-};
-
-export function QuerySourceSection({ card }: QuerySourceSectionProps) {
- const metadata = useSelector(getMetadata);
- const { query, queryInfo } = useMemo(() => {
- const query = Lib.fromJsQueryAndMetadata(metadata, card.dataset_query);
- const queryInfo = Lib.queryDisplayInfo(query);
- return { query, queryInfo };
- }, [metadata, card]);
-
- const pickerInfo = useMemo(() => {
- const tableOrCardId = Lib.sourceTableOrCardId(query);
- const tableOrCard =
- tableOrCardId != null
- ? Lib.tableOrCardMetadata(query, tableOrCardId)
- : null;
- return tableOrCard != null ? Lib.pickerInfo(query, tableOrCard) : null;
- }, [query]);
-
- if (!queryInfo.isEditable || pickerInfo == null) {
- return null;
- }
-
- return (
- <Stack gap="sm">
- <Title order={6}>{t`Based on`}</Title>
- {pickerInfo.cardId == null ? (
- <TableSourcePath tableId={pickerInfo.tableId} />
- ) : (
- <CardSourcePath cardId={pickerInfo.cardId} />
- )}
- </Stack>
- );
-}
-
-type TableSourcePathProps = {
- tableId: TableId;
-};
-
-function TableSourcePath({ tableId }: TableSourcePathProps) {
- const { data: table } = useGetTableQuery({ id: tableId });
-
- const parts = useMemo(() => {
- if (!table || !table.db) {
- return null;
- }
-
- const pathParts: SourcePathPart[] = [];
- pathParts.push({
- name: table.db.name,
- url: table.db.is_audit
- ? undefined
- : Urls.dataStudioData({ databaseId: table.db_id }),
- });
-
- if (table.schema) {
- pathParts.push({
- name: table.schema,
- url: table.db.is_audit
- ? undefined
- : Urls.dataStudioData({
- databaseId: table.db_id,
- schemaName: table.schema,
- }),
- });
- }
-
- pathParts.push({
- name: table.display_name,
- url: table.db.is_audit
- ? undefined
- : Urls.dataStudioData({
- databaseId: table.db_id,
- schemaName: table.schema,
- tableId: table.id,
- }),
- });
-
- return pathParts;
- }, [table]);
-
- if (!parts) {
- return null;
- }
-
- return <SourcePath parts={parts} />;
-}
-
-type CardSourcePathProps = {
- cardId: CardId;
-};
-
-function CardSourcePath({ cardId }: CardSourcePathProps) {
- const { data: card } = useGetCardQuery({ id: cardId });
-
- const parts = useMemo(() => {
- if (card == null) {
- return null;
- }
-
- const pathParts: SourcePathPart[] = [
- { name: card.name, url: Urls.question(card) },
- ];
-
- const collection = card.collection;
- if (collection != null) {
- pathParts.unshift({
- name: collection.name,
- url: Urls.collection(collection),
- });
-
- if (collection.effective_ancestors != null) {
- pathParts.unshift(
- ...collection.effective_ancestors.map((parent) => ({
- name: parent.name,
- url: Urls.collection(parent),
- })),
- );
- }
- }
-
- return pathParts;
- }, [card]);
-
- if (!parts) {
- return null;
- }
-
- return <SourcePath parts={parts} />;
-}
-
-type SourcePathPart = {
- name: string;
- url?: string;
-};
-
-type SourcePathProps = {
- parts: SourcePathPart[];
-};
-
-function SourcePath({ parts }: SourcePathProps) {
- return (
- <Group gap="xs">
- {parts.map((part, index) => (
- <Fragment key={index}>
- {index > 0 && " / "}
- {part.url ? (
- <Link className={S.link} to={part.url}>
- {part.name}
- </Link>
- ) : (
- <span>{part.name}</span>
- )}
- </Fragment>
- ))}
- </Group>
- );
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/QuerySourceSection/index.ts b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/QuerySourceSection/index.ts
deleted file mode 100644
index ec8ad52f0d2..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/MetricOverviewPage/MetricOverview/QuerySourceSection/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from "./QuerySourceSection";
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/DescriptionSection/DescriptionSection.module.css b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/DescriptionSection/DescriptionSection.module.css
new file mode 100644
index 00000000000..5bbde9cd9da
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/DescriptionSection/DescriptionSection.module.css
@@ -0,0 +1,67 @@
+.gridLabelInput {
+ .label {
+ font-weight: normal;
+ color: var(--mb-color-text-secondary);
+ }
+
+ .input {
+ width: 11rem;
+ border-radius: 1.25rem;
+
+ &.unset {
+ color: var(--mb-color-text-secondary);
+ }
+ }
+
+ .sectionLabel {
+ &[data-position="right"] {
+ color: var(--mb-color-text-primary);
+ }
+
+ &[data-position="left"] {
+ color: var(--mb-color-brand);
+ }
+ }
+}
+
+.textStyleWrapper {
+ flex-grow: 1;
+}
+
+.textStyleInput {
+ padding: 0;
+ border: 0;
+ background: transparent;
+ height: 1rem;
+ min-height: 1rem;
+ cursor: pointer;
+
+ &[data-expanded="true"] {
+ cursor: text;
+ }
+}
+
+.selectedInput {
+ font-weight: bold;
+}
+
+.textStyleSection {
+ width: 1rem;
+ height: 1rem;
+ cursor: pointer;
+
+ &[data-position="left"] {
+ display: none;
+ }
+
+ svg {
+ width: 0.75rem !important;
+ height: 0.75rem !important;
+ }
+}
+
+.metricLink {
+ :hover {
+ color: var(--mb-color-brand);
+ }
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/DescriptionSection/DescriptionSection.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/DescriptionSection/DescriptionSection.tsx
index a6860ad07a8..53efac06763 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/DescriptionSection/DescriptionSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/DescriptionSection/DescriptionSection.tsx
@@ -1,10 +1,34 @@
+import cx from "classnames";
import { t } from "ttag";
import { useUpdateTableMutation } from "metabase/api";
+import { DateTime } from "metabase/common/components/DateTime";
import { EditableText } from "metabase/common/components/EditableText";
+import { Link } from "metabase/common/components/Link/Link";
+import { useNumberFormatter } from "metabase/common/hooks/use-number-formatter";
+import { isNullOrUndefined } from "metabase/lib/types";
+import * as Urls from "metabase/lib/urls";
+import {
+ DataSourceInput,
+ EntityTypeInput,
+ UserInput,
+} from "metabase/metadata/components";
import { useMetadataToasts } from "metabase/metadata/hooks";
-import { Box } from "metabase/ui";
-import type { Table } from "metabase-types/api";
+import { PLUGIN_DEPENDENCIES } from "metabase/plugins";
+import {
+ Box,
+ Card,
+ Divider,
+ Flex,
+ Group,
+ Icon,
+ Stack,
+ Text,
+ rem,
+} from "metabase/ui";
+import type { Table, TableDataSource, UserId } from "metabase-types/api";
+
+import S from "./DescriptionSection.module.css";
type DescriptionSectionProps = {
table: Table;
@@ -12,7 +36,16 @@ type DescriptionSectionProps = {
export function DescriptionSection({ table }: DescriptionSectionProps) {
const [updateTable] = useUpdateTableMutation();
- const { sendSuccessToast, sendErrorToast } = useMetadataToasts();
+ const { sendErrorToast, sendSuccessToast, sendUndoToast } =
+ useMetadataToasts();
+
+ const formatNumber = useNumberFormatter();
+ const isDependenciesEnabled = PLUGIN_DEPENDENCIES.isEnabled;
+
+ const { dependentsCount } = PLUGIN_DEPENDENCIES.useGetDependenciesCount({
+ id: Number(table.id),
+ type: "table",
+ });
const handleChange = async (newValue: string) => {
const newDescription = newValue.trim();
@@ -27,14 +60,276 @@ export function DescriptionSection({ table }: DescriptionSectionProps) {
}
};
+ const handleDataSourceChange = async (
+ dataSource: TableDataSource | "unknown" | null,
+ ) => {
+ if (dataSource == null) {
+ return; // should never happen as the input is not clearable here
+ }
+
+ const { error } = await updateTable({
+ id: table.id,
+ data_source: dataSource === "unknown" ? null : dataSource,
+ });
+
+ if (error) {
+ sendErrorToast(t`Failed to update table data source`);
+ } else {
+ sendSuccessToast(t`Table data source updated`, async () => {
+ const { error } = await updateTable({
+ id: table.id,
+ data_source: table.data_source,
+ });
+ sendUndoToast(error);
+ });
+ }
+ };
+
+ const handleEntityTypeChange = async (entityType: Table["entity_type"]) => {
+ const { error } = await updateTable({
+ id: table.id,
+ entity_type: entityType,
+ });
+
+ if (error) {
+ sendErrorToast(t`Failed to update entity type`);
+ } else {
+ sendSuccessToast(t`Entity type updated`, async () => {
+ const { error } = await updateTable({
+ id: table.id,
+ entity_type: table.entity_type,
+ });
+ sendUndoToast(error);
+ });
+ }
+ };
+
+ const handleOwnerEmailChange = async (email: string | null) => {
+ const { error } = await updateTable({
+ id: table.id,
+ owner_email: email,
+ owner_user_id: null,
+ });
+
+ if (error) {
+ sendErrorToast(t`Failed to update table owner`);
+ } else {
+ sendSuccessToast(t`Table owner updated`, async () => {
+ const { error } = await updateTable({
+ id: table.id,
+ owner_email: table.owner_email,
+ owner_user_id: table.owner_user_id,
+ });
+ sendUndoToast(error);
+ });
+ }
+ };
+
+ const handleOwnerUserIdChange = async (userId: UserId | "unknown" | null) => {
+ if (userId == null) {
+ return; // should never happen as the input is not clearable here
+ }
+
+ const { error } = await updateTable({
+ id: table.id,
+ owner_email: null,
+ owner_user_id: userId === "unknown" ? null : userId,
+ });
+
+ if (error) {
+ sendErrorToast(t`Failed to update table owner`);
+ } else {
+ sendSuccessToast(t`Table owner updated`, async () => {
+ const { error } = await updateTable({
+ id: table.id,
+ owner_email: table.owner_email,
+ owner_user_id: table.owner_user_id,
+ });
+ sendUndoToast(error);
+ });
+ }
+ };
+
+ const isOwnerSpecified = table.owner_email || table.owner_user_id;
+
return (
- <Box data-testid="table-description-section">
- <EditableText
- initialValue={table.description ?? ""}
- placeholder={t`No description`}
- isMarkdown
- onChange={handleChange}
- />
- </Box>
+ <Stack gap={0} align="stretch" data-testid="table-description-sidebar">
+ {/* Entity Type Selector */}
+ <Flex justify="space-between" align="center" px="lg" py="md">
+ <Text size="md" c="text-secondary">
+ {t`Entity type`}
+ </Text>
+ <EntityTypeInput
+ value={table.entity_type ?? "entity/GenericTable"}
+ label={null}
+ onChange={handleEntityTypeChange}
+ classNames={{
+ input: S.input,
+ label: S.label,
+ section: table.entity_type ? S.sectionLabel : "",
+ }}
+ className={S.gridLabelInput}
+ />
+ </Flex>
+
+ <Divider />
+
+ {/* Description */}
+ <Box data-testid="table-description-section" p={rem(20)}>
+ <EditableText
+ initialValue={table.description ?? ""}
+ placeholder={t`No description`}
+ isMarkdown
+ isOptional
+ isMultiline
+ onChange={handleChange}
+ />
+ </Box>
+
+ {/* Metadata Sections */}
+ <Card mx="lg" bg="background-secondary" shadow="none" radius="1rem">
+ <Card.Section withBorder p="md">
+ <Group gap="sm" mb={4}>
+ <Icon name="pencil" c="brand" />
+ <Text size="md" fw={600} lh="1rem">
+ <DateTime value={table.updated_at} />
+ </Text>
+ </Group>
+ <Text size="sm" c="text-secondary" lh="1rem" ml="1.5rem">
+ {t`Last edited at`}
+ </Text>
+ </Card.Section>
+ <Card.Section withBorder p="md">
+ <Group gap="sm" mb={4}>
+ <Icon name="database" c="brand" />
+ {table.db ? (
+ <Link to={Urls.dataStudioData({ databaseId: table.db.id })}>
+ <Text size="md" fw={600} lh="1rem">
+ {table.db.name}
+ </Text>
+ </Link>
+ ) : (
+ <Text size="md" fw={600} lh="1rem">
+ —
+ </Text>
+ )}
+ </Group>
+ <Text size="sm" c="text-secondary" lh="1rem" ml="1.5rem">
+ {t`Database`}
+ </Text>
+ </Card.Section>
+ <Card.Section withBorder p="md">
+ <Group gap="sm" mb={4}>
+ <Icon
+ name="refresh_downstream"
+ c={table.data_source ? "brand" : "icon-secondary"}
+ />
+
+ <DataSourceInput
+ disabled={table.data_source === "metabase-transform"}
+ value={table.data_source ?? "unknown"}
+ label={null}
+ classNames={{
+ root: S.textStyleWrapper,
+ input: cx(
+ S.textStyleInput,
+ table.data_source && S.selectedInput,
+ ),
+ section: S.textStyleSection,
+ }}
+ showUnknown={!table.data_source}
+ onChange={handleDataSourceChange}
+ />
+ </Group>
+ <Text size="sm" c="text-secondary" lh="1rem" ml="1.5rem">
+ {t`Source`}
+ </Text>
+ </Card.Section>
+ <Card.Section withBorder p="md">
+ <Group gap="sm" mb={4}>
+ <Icon
+ name="person"
+ c={isOwnerSpecified ? "brand" : "icon-secondary"}
+ />
+
+ <UserInput
+ email={table.owner_email}
+ userId={isOwnerSpecified ? table.owner_user_id : "unknown"}
+ onEmailChange={handleOwnerEmailChange}
+ onUserIdChange={handleOwnerUserIdChange}
+ unknownUserLabel={t`No owner`}
+ classNames={{
+ root: S.textStyleWrapper,
+ input: cx(
+ S.textStyleInput,
+ isOwnerSpecified && S.selectedInput,
+ ),
+ section: S.textStyleSection,
+ }}
+ />
+ </Group>
+ <Text size="sm" c="text-secondary" lh="1rem" ml="1.5rem">
+ {t`Owner`}
+ </Text>
+ </Card.Section>
+ </Card>
+
+ {/* Statistics */}
+ <Card mx="lg" my="lg" shadow="none">
+ <Card.Section withBorder py={rem(12)} px="md">
+ <Flex justify="space-between" align="center">
+ <Text size="md" c="text-secondary">
+ {t`Fields`}
+ </Text>
+ <Link
+ to={Urls.dataStudioTableFields(table.id)}
+ className={S.metricLink}
+ >
+ <Text size="xl" fw={600}>
+ {table.fields?.length ?? 0}
+ </Text>
+ </Link>
+ </Flex>
+ </Card.Section>
+
+ {!isNullOrUndefined(table.estimated_row_count) && (
+ <Card.Section withBorder py={rem(12)} px="md">
+ <Flex justify="space-between" align="center">
+ <Text size="md" c="text-secondary">
+ {t`Rows`}
+ </Text>
+ <Text size="xl" fw={600}>
+ {formatNumber(table.estimated_row_count)}
+ </Text>
+ </Flex>
+ </Card.Section>
+ )}
+
+ {isDependenciesEnabled && (
+ <Card.Section withBorder py={rem(12)} px="md">
+ <Flex justify="space-between" align="center">
+ <Text size="md" c="text-secondary">
+ {t`Dependents`}
+ </Text>
+
+ {dependentsCount > 0 ? (
+ <Link
+ to={Urls.dataStudioTableDependencies(table.id)}
+ className={S.metricLink}
+ >
+ <Text size="xl" fw={600}>
+ {dependentsCount}
+ </Text>
+ </Link>
+ ) : (
+ <Text size="xl" fw={600}>
+ {dependentsCount}
+ </Text>
+ )}
+ </Flex>
+ </Card.Section>
+ )}
+ </Card>
+ </Stack>
);
}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.module.css b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.module.css
new file mode 100644
index 00000000000..f7de4f59bc9
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.module.css
@@ -0,0 +1,8 @@
+.descriptionSection {
+ background-color: var(--mb-color-background-primary);
+ border: 1px solid var(--mb-color-border);
+ border-left: none;
+ border-top-right-radius: var(--default-border-radius);
+ border-bottom-right-radius: var(--default-border-radius);
+ overflow: auto;
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.tsx
index b6bb35293a6..20f20e3edc4 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/tables/pages/TableOverviewPage/TableOverview/TableOverview.tsx
@@ -10,6 +10,7 @@ import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type { Table } from "metabase-types/api";
import { DescriptionSection } from "./DescriptionSection";
+import S from "./TableOverview.module.css";
type TableOverviewProps = {
table: Table;
@@ -19,11 +20,11 @@ export function TableOverview({ table }: TableOverviewProps) {
const metadata = useSelector(getMetadata);
const card = useMemo(() => getCard(table, metadata), [table, metadata]);
return (
- <Flex flex={1} gap="lg">
+ <Flex flex={1} gap={0}>
<Flex direction="column" flex={1} mah={700}>
{card && <OverviewVisualization card={card} />}
</Flex>
- <Stack flex="0 0 300px">
+ <Stack flex="0 0 360px" className={S.descriptionSection} mah={700}>
<DescriptionSection table={table} />
</Stack>
</Flex>
diff --git a/frontend/src/metabase/data-studio/common/components/OverviewVisualization/OverviewVisualization.module.css b/frontend/src/metabase/data-studio/common/components/OverviewVisualization/OverviewVisualization.module.css
index 11011b2e2eb..6cdacd02774 100644
--- a/frontend/src/metabase/data-studio/common/components/OverviewVisualization/OverviewVisualization.module.css
+++ b/frontend/src/metabase/data-studio/common/components/OverviewVisualization/OverviewVisualization.module.css
@@ -5,7 +5,8 @@
.visualization {
background-color: var(--mb-color-background-primary);
border: 1px solid var(--mb-color-border);
- border-radius: var(--default-border-radius);
+ border-top-left-radius: var(--default-border-radius);
+ border-bottom-left-radius: var(--default-border-radius);
overflow: hidden;
flex: 1;
}
diff --git a/frontend/src/metabase/metadata/components/DataSourceInput.tsx b/frontend/src/metabase/metadata/components/DataSourceInput.tsx
index 7ec1a474d29..c23026dad69 100644
--- a/frontend/src/metabase/metadata/components/DataSourceInput.tsx
+++ b/frontend/src/metabase/metadata/components/DataSourceInput.tsx
@@ -5,6 +5,7 @@ import type { TableDataSource } from "metabase-types/api";
interface Props extends Omit<SelectProps, "data" | "value" | "onChange"> {
showMetabaseTransform?: boolean;
+ showUnknown?: boolean;
value: TableDataSource | "unknown" | null;
onChange: (value: TableDataSource | "unknown" | null) => void;
}
@@ -12,6 +13,7 @@ interface Props extends Omit<SelectProps, "data" | "value" | "onChange"> {
export const DataSourceInput = ({
comboboxProps,
showMetabaseTransform,
+ showUnknown = true,
value,
onChange,
onFocus,
@@ -29,7 +31,11 @@ export const DataSourceInput = ({
position: "bottom-start",
...comboboxProps,
}}
- data={getData(showMetabaseTransform || value === "metabase-transform")}
+ data={getData({
+ showUnknown,
+ showMetabaseTransform:
+ showMetabaseTransform || value === "metabase-transform",
+ })}
label={t`Source`}
placeholder={t`Select a data source`}
value={value}
@@ -39,9 +45,17 @@ export const DataSourceInput = ({
);
};
-function getData(showMetabaseTransform?: boolean) {
+function getData({
+ showUnknown,
+ showMetabaseTransform,
+}: {
+ showUnknown?: boolean;
+ showMetabaseTransform?: boolean;
+}) {
return [
- { value: "unknown" as const, label: t`Unspecified` },
+ showUnknown
+ ? { value: "unknown" as const, label: t`Unspecified` }
+ : undefined,
{ value: "ingested" as const, label: t`Ingested` },
showMetabaseTransform
? // eslint-disable-next-line metabase/no-literal-metabase-strings -- shown in Data Studio only