Skip to content

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

Convert dataref to ts (#71062)

Romeo Van Snicke13fd47144f4
diff --git a/frontend/src/metabase/actions/containers/ActionCreator/InlineDataReference.tsx b/frontend/src/metabase/actions/containers/ActionCreator/InlineDataReference.tsx
index 6dcab3b3540..a140b1ff26a 100644
--- a/frontend/src/metabase/actions/containers/ActionCreator/InlineDataReference.tsx
+++ b/frontend/src/metabase/actions/containers/ActionCreator/InlineDataReference.tsx
@@ -3,6 +3,7 @@ import { t } from "ttag";
import { Button } from "metabase/common/components/Button";
import { DataReference } from "metabase/query_builder/components/dataref/DataReference";
+import type { DataReferenceItem } from "metabase/query_builder/components/dataref/types";
import { Tooltip } from "metabase/ui";
export const DataReferenceInline = ({
@@ -12,10 +13,10 @@ export const DataReferenceInline = ({
onClose?: () => void;
onBack?: () => void;
}) => {
- const [dataRefStack, setDataRefStack] = useState<any[]>([]);
+ const [dataRefStack, setDataRefStack] = useState<DataReferenceItem[]>([]);
- const pushRefStack = (ref: any) => {
- setDataRefStack([...dataRefStack, ref]);
+ const pushRefStack = (item: DataReferenceItem) => {
+ setDataRefStack([...dataRefStack, item]);
};
const popRefStack = () => {
diff --git a/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.tsx b/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.tsx
index 9191c8b1cb3..883cea1d5e6 100644
--- a/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.tsx
+++ b/frontend/src/metabase/common/components/MetadataInfo/ColumnFingerprintInfo/ColumnFingerprintInfo.tsx
@@ -1,7 +1,7 @@
import * as Lib from "metabase-lib";
import type Field from "metabase-lib/v1/metadata/Field";
import { isDate, isID, isNumber } from "metabase-lib/v1/types/utils/isa";
-import type { DatasetColumn } from "metabase-types/api";
+import type { Field as ApiField, DatasetColumn } from "metabase-types/api";
import { DateTimeFingerprint } from "./DateTimeFingerprint";
import { GlobalFingerprint } from "./GlobalFingerprint";
@@ -14,7 +14,7 @@ type BaseProps = {
};
type TableColumnFingerprintInfoProps = BaseProps & {
- field: Field | DatasetColumn;
+ field: Field | DatasetColumn | ApiField;
};
/**
diff --git a/frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.tsx b/frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.tsx
index 478c8c812e1..a1c469fcd5c 100644
--- a/frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.tsx
+++ b/frontend/src/metabase/common/components/MetadataInfo/ColumnInfo/ColumnInfo.tsx
@@ -2,7 +2,7 @@ import { t } from "ttag";
import * as Lib from "metabase-lib";
import type Field from "metabase-lib/v1/metadata/Field";
-import type { DatasetColumn } from "metabase-types/api";
+import type { Field as ApiField, DatasetColumn } from "metabase-types/api";
import {
QueryColumnFingerprintInfo,
@@ -15,7 +15,7 @@ import { InfoContainer, Small } from "./ColumnInfo.styled";
export type TableColumnInfoProps = {
className?: string;
- field: Field | DatasetColumn;
+ field: Field | DatasetColumn | ApiField;
timezone?: string;
showAllFieldValues?: boolean;
showFingerprintInfo?: boolean;
diff --git a/frontend/src/metabase/query_builder/actions/native.ts b/frontend/src/metabase/query_builder/actions/native.ts
index d74eea81cab..f06fbb0c3d2 100644
--- a/frontend/src/metabase/query_builder/actions/native.ts
+++ b/frontend/src/metabase/query_builder/actions/native.ts
@@ -3,7 +3,6 @@ import { createAction } from "redux-actions";
import { Questions } from "metabase/entities/questions";
import { createThunkAction } from "metabase/lib/redux";
import { updateUserSetting } from "metabase/redux/settings";
-import { getMetadata } from "metabase/selectors/metadata";
import type NativeQuery from "metabase-lib/v1/queries/NativeQuery";
import type {
CardId,
@@ -55,7 +54,7 @@ export const OPEN_DATA_REFERENCE_AT_QUESTION =
"metabase/qb/OPEN_DATA_REFERENCE_AT_QUESTION";
export const openDataReferenceAtQuestion = createThunkAction(
OPEN_DATA_REFERENCE_AT_QUESTION,
- (id: CardId) => async (dispatch: Dispatch, getState: GetState) => {
+ (id: CardId) => async (dispatch: Dispatch) => {
const action = await dispatch(
Questions.actions.fetch(
{ id },
@@ -64,10 +63,9 @@ export const openDataReferenceAtQuestion = createThunkAction(
);
const question = Questions.HACK_getObjectFromAction(action);
if (question) {
- const database = getMetadata(getState()).database(question.database_id);
return [
- { type: "database", item: database },
- { type: "question", item: question },
+ { type: "database", id: question.database_id },
+ { type: "question", id: question.id },
];
}
},
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx
index 7cad9ff4dac..48ca45c53bf 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx
@@ -61,6 +61,9 @@ const defaultDatasetEditorProps = {
toggleSnippetSidebar: noop,
toggleTemplateTagsEditor: noop,
runDirtyQuestionQuery: noop,
+ dataReferenceStack: [],
+ pushDataReferenceStack: noop,
+ popDataReferenceStack: noop,
};
const renderDatasetEditor = async (card: Card | UnsavedCard) => {
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
index 70e6d54c303..4ed82e9d66a 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
@@ -76,6 +76,8 @@ import type {
} from "metabase-types/api";
import type { DatasetEditorTab, QueryBuilderMode } from "metabase-types/store";
+import type { DataReferenceItem } from "../dataref/types";
+
import DatasetEditorS from "./DatasetEditor.module.css";
import {
DatasetEditorSettingsSidebar,
@@ -129,6 +131,10 @@ export type DatasetEditorInnerProps = {
toggleDataReference: () => void;
toggleSnippetSidebar: () => void;
forwardedRef?: React.Ref<HTMLDivElement>;
+
+ dataReferenceStack: DataReferenceItem[];
+ pushDataReferenceStack: (item: DataReferenceItem) => void;
+ popDataReferenceStack: () => void;
};
const INITIAL_NOTEBOOK_EDITOR_HEIGHT = 500;
diff --git a/frontend/src/metabase/query_builder/components/dataref/DataReference.jsx b/frontend/src/metabase/query_builder/components/dataref/DataReference.jsx
deleted file mode 100644
index 12c412874cb..00000000000
--- a/frontend/src/metabase/query_builder/components/dataref/DataReference.jsx
+++ /dev/null
@@ -1,58 +0,0 @@
-/* eslint "react/prop-types": "warn" */
-import PropTypes from "prop-types";
-import { useCallback } from "react";
-
-import { DatabasePane } from "./DatabasePane";
-import { FieldPane } from "./FieldPane";
-import { MainPane } from "./MainPane";
-import { QuestionPane } from "./QuestionPane";
-import { SchemaPane } from "./SchemaPane";
-import { TablePane } from "./TablePane";
-
-const PANES = {
- database: DatabasePane, // lists schemas, tables and models of a database
- schema: SchemaPane, // lists tables of a schema
- table: TablePane, // lists fields of a table
- question: QuestionPane, // lists fields of a question
- field: FieldPane, // field details and metadata
-};
-
-const DataReferencePropTypes = {
- dataReferenceStack: PropTypes.array.isRequired,
- popDataReferenceStack: PropTypes.func.isRequired,
- pushDataReferenceStack: PropTypes.func.isRequired,
- onClose: PropTypes.func,
- onBack: PropTypes.func,
-};
-
-export const DataReference = ({
- dataReferenceStack,
- popDataReferenceStack,
- pushDataReferenceStack,
- onClose,
- onBack,
-}) => {
- const onItemClick = useCallback(
- (type, item) => pushDataReferenceStack({ type, item }),
- [pushDataReferenceStack],
- );
-
- if (dataReferenceStack.length) {
- const page = dataReferenceStack[dataReferenceStack.length - 1];
- const Pane = PANES[page.type];
- return (
- <Pane
- {...{ [page.type]: page.item }}
- onItemClick={onItemClick}
- onClose={onClose}
- onBack={popDataReferenceStack}
- />
- );
- } else {
- return (
- <MainPane onItemClick={onItemClick} onClose={onClose} onBack={onBack} />
- );
- }
-};
-
-DataReference.propTypes = DataReferencePropTypes;
diff --git a/frontend/src/metabase/query_builder/components/dataref/DataReference.tsx b/frontend/src/metabase/query_builder/components/dataref/DataReference.tsx
new file mode 100644
index 00000000000..06a47c02276
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/dataref/DataReference.tsx
@@ -0,0 +1,45 @@
+import type { ComponentType } from "react";
+
+import { MainPane } from "./MainPane";
+import {
+ type DataReferenceItem,
+ type DataReferencePaneProps,
+ PANES,
+} from "./types";
+
+export const DataReference = ({
+ dataReferenceStack,
+ popDataReferenceStack,
+ pushDataReferenceStack,
+ onClose,
+ onBack,
+}: {
+ dataReferenceStack: DataReferenceItem[];
+ popDataReferenceStack: () => void;
+ pushDataReferenceStack: (item: DataReferenceItem) => void;
+ onClose?: () => void;
+ onBack?: () => void;
+}) => {
+ if (dataReferenceStack.length) {
+ const page = dataReferenceStack[dataReferenceStack.length - 1];
+ const Pane = PANES[page.type] as ComponentType<
+ DataReferencePaneProps<typeof page>
+ >;
+ return (
+ <Pane
+ {...page}
+ onItemClick={pushDataReferenceStack}
+ onClose={onClose}
+ onBack={popDataReferenceStack}
+ />
+ );
+ } else {
+ return (
+ <MainPane
+ onItemClick={pushDataReferenceStack}
+ onClose={onClose}
+ onBack={onBack}
+ />
+ );
+ }
+};
diff --git a/frontend/src/metabase/query_builder/components/dataref/DatabasePane.tsx b/frontend/src/metabase/query_builder/components/dataref/DatabasePane.tsx
index a2ac5c79d4d..dd82bad8203 100644
--- a/frontend/src/metabase/query_builder/components/dataref/DatabasePane.tsx
+++ b/frontend/src/metabase/query_builder/components/dataref/DatabasePane.tsx
@@ -17,11 +17,13 @@ import type {
} from "metabase/common/components/tree/types";
import CS from "metabase/css/core/index.css";
import { SidebarContent } from "metabase/query_builder/components/SidebarContent";
-import type Database from "metabase-lib/v1/metadata/Database";
-import type {
- CollectionId,
- SchemaName,
- SearchResult,
+import {
+ type Card,
+ type CollectionId,
+ type SchemaName,
+ type SearchResult,
+ type Table,
+ isConcreteTableId,
} from "metabase-types/api";
import {
@@ -34,6 +36,11 @@ import {
NodeListTitleText,
} from "./NodeList";
import { ResourceTreeNode } from "./ResourceTreeNode";
+import type {
+ DataReferenceDatabaseItem,
+ DataReferencePaneProps,
+ OnItemClick,
+} from "./types";
const groupModelsByCollection = (models: SearchResult[]) => {
const grouped = _.groupBy(
@@ -77,21 +84,13 @@ const groupTablesBySchema = (tables: SearchResult[]) => {
);
};
-export interface TablesListProps {
+export type TablesListProps = {
schemas: string[];
tables: SearchResult[];
- onItemClick: (type: string, item: unknown) => void;
-}
+ onItemClick: OnItemClick;
+};
-const TablesList = ({
- schemas,
- tables,
- onItemClick,
-}: {
- schemas: string[];
- tables: SearchResult[];
- onItemClick: (type: string, item: unknown) => void;
-}) => {
+const TablesList = ({ schemas, tables, onItemClick }: TablesListProps) => {
const hasMultipleSchemas = schemas.length > 1;
if (hasMultipleSchemas) {
@@ -117,10 +116,15 @@ const TablesList = ({
</NodeListTitle>
<Tree
data={tablesBySchema}
- TreeNode={(props: TreeNodeProps<ITreeNodeItem>) => (
- <ResourceTreeNode
+ TreeNode={(props: TreeNodeProps<Table>) => (
+ <ResourceTreeNode<Table>
{...props}
- onItemClick={() => onItemClick("table", props.item.data)}
+ onItemClick={() => {
+ const { id } = props.item.data ?? {};
+ if (isConcreteTableId(id)) {
+ onItemClick({ type: "table", id });
+ }
+ }}
/>
)}
/>
@@ -145,7 +149,11 @@ const TablesList = ({
<li key={table.id}>
<NodeListItemLink
disabled={table.initial_sync_status !== "complete"}
- onClick={() => onItemClick("table", table)}
+ onClick={() => {
+ if (isConcreteTableId(table.id)) {
+ onItemClick({ type: "table", id: table.id });
+ }
+ }}
>
<NodeListItemIcon
disabled={table.initial_sync_status !== "complete"}
@@ -164,18 +172,12 @@ const TablesList = ({
);
};
-export interface CollectionsListProps {
+export type CollectionsListProps = {
models: SearchResult[];
- onItemClick: (type: string, item: unknown) => void;
-}
+ onItemClick: OnItemClick;
+};
-const CollectionsList = ({
- models,
- onItemClick,
-}: {
- models: SearchResult[];
- onItemClick: (type: string, item: unknown) => void;
-}) => {
+const CollectionsList = ({ models, onItemClick }: CollectionsListProps) => {
if (models.length === 0) {
return null;
}
@@ -202,10 +204,14 @@ const CollectionsList = ({
</NodeListTitle>
<Tree
data={modelsByCollection}
- TreeNode={(props: TreeNodeProps<ITreeNodeItem>) => (
- <ResourceTreeNode
+ TreeNode={(props: TreeNodeProps<Card>) => (
+ <ResourceTreeNode<Card>
{...props}
- onItemClick={() => onItemClick("question", props.item.data)}
+ onItemClick={() => {
+ if (props.item.data) {
+ onItemClick({ type: "question", id: props.item.data.id });
+ }
+ }}
displayId
/>
)}
@@ -214,21 +220,15 @@ const CollectionsList = ({
);
};
-export interface DatabasePaneProps {
- database: Database;
- onBack: () => void;
- onClose: () => void;
- onItemClick: (type: string, item: unknown) => void;
-}
+export type DatabasePaneProps =
+ DataReferencePaneProps<DataReferenceDatabaseItem>;
export const DatabasePane = ({
- database,
+ id: databaseId,
onBack,
onClose,
onItemClick,
}: DatabasePaneProps) => {
- const databaseId = database.id;
-
const {
data: databaseData,
isLoading: isLoadingDatabase,
diff --git a/frontend/src/metabase/query_builder/components/dataref/DatabasePane.unit.spec.tsx b/frontend/src/metabase/query_builder/components/dataref/DatabasePane.unit.spec.tsx
index 1a36c4810ab..938b23c199c 100644
--- a/frontend/src/metabase/query_builder/components/dataref/DatabasePane.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/dataref/DatabasePane.unit.spec.tsx
@@ -50,7 +50,8 @@ const completeTableSearchResult = createMockSearchResult({
});
const defaultProps: DatabasePaneProps = {
- database,
+ type: "database",
+ id: database.id,
onBack: jest.fn(),
onClose: jest.fn(),
onItemClick: jest.fn(),
@@ -161,7 +162,7 @@ describe("DatabasePane", () => {
initial_sync_status: "complete",
});
- setup({ database: singleSchemaDatabase });
+ setup({ id: singleSchemaDatabase.id });
setupDatabaseEndpoints(singleSchemaDb);
setupSearchEndpoints([table1]);
@@ -211,7 +212,7 @@ describe("DatabasePane", () => {
initial_sync_status: "complete",
});
- setup({ database: multiSchemaDatabase });
+ setup({ id: multiSchemaDatabase.id });
setupDatabaseEndpoints(multiSchemaDb);
setupSearchEndpoints([table1, table2]);
@@ -232,7 +233,7 @@ describe("DatabasePane", () => {
emptySchemasMetadata.database(emptySchemasDb.id),
);
- setup({ database: emptySchemasDatabase });
+ setup({ id: emptySchemasDatabase.id });
setupDatabaseEndpoints(emptySchemasDb);
setupSearchEndpoints([]);
@@ -314,7 +315,7 @@ describe("DatabasePane", () => {
initial_sync_status: "complete",
});
- setup({ database: multiSchemaDatabase });
+ setup({ id: multiSchemaDatabase.id });
setupDatabaseEndpoints(multiSchemaDb);
setupSearchEndpoints([table1, table2]);
@@ -430,7 +431,10 @@ describe("DatabasePane", () => {
const tableElement = screen.getByText("Table 1");
await userEvent.click(tableElement);
- expect(onItemClick).toHaveBeenCalledWith("table", table1);
+ expect(onItemClick).toHaveBeenCalledWith({
+ type: "table",
+ id: table1.id,
+ });
});
it("should call onItemClick with correct type ('question') and item for models", async () => {
@@ -457,7 +461,10 @@ describe("DatabasePane", () => {
const modelText = screen.getByText("Model 1");
await userEvent.click(modelText);
- expect(onItemClick).toHaveBeenCalledWith("question", model1);
+ expect(onItemClick).toHaveBeenCalledWith({
+ type: "question",
+ id: model1.id,
+ });
});
it("should call onBack callback when back button is clicked", async () => {
diff --git a/frontend/src/metabase/query_builder/components/dataref/FieldPane.tsx b/frontend/src/metabase/query_builder/components/dataref/FieldPane.tsx
index 651725f7e3b..82cb55ccfcf 100644
--- a/frontend/src/metabase/query_builder/components/dataref/FieldPane.tsx
+++ b/frontend/src/metabase/query_builder/components/dataref/FieldPane.tsx
@@ -1,25 +1,43 @@
+import {
+ skipToken,
+ useGetCardQueryMetadataQuery,
+ useGetFieldQuery,
+ useGetTableQuery,
+} from "metabase/api";
+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { TableColumnInfo } from "metabase/common/components/MetadataInfo/ColumnInfo";
import { SidebarContent } from "metabase/query_builder/components/SidebarContent";
-import type Field from "metabase-lib/v1/metadata/Field";
+import { getQuestionIdFromVirtualTableId } from "metabase-lib/v1/metadata/utils/saved-questions";
+import type { FieldId } from "metabase-types/api";
-interface FieldPaneProps {
- onBack: () => void;
- onClose: () => void;
- field: Field;
-}
+import type {
+ DataReferenceFieldItem,
+ DataReferencePaneProps,
+ UniqueFieldId,
+} from "./types";
+
+export const FieldPane = ({
+ onBack,
+ onClose,
+ id,
+}: DataReferencePaneProps<DataReferenceFieldItem>) => {
+ const { field, table, isLoading, error } = useGetFieldAndTable(id);
+
+ if (isLoading || error || field == null) {
+ return <LoadingAndErrorWrapper loading={isLoading} error={error} />;
+ }
-export const FieldPane = ({ onBack, onClose, field }: FieldPaneProps) => {
return (
<SidebarContent
title={field.name}
- icon={"field"}
+ icon="field"
onBack={onBack}
onClose={onClose}
>
<SidebarContent.Pane>
<TableColumnInfo
field={field}
- timezone={field.table?.database?.timezone}
+ timezone={table?.db?.timezone}
showAllFieldValues
showFingerprintInfo
/>
@@ -27,3 +45,67 @@ export const FieldPane = ({ onBack, onClose, field }: FieldPaneProps) => {
</SidebarContent>
);
};
+
+function useGetFieldAndTable(id: FieldId | UniqueFieldId) {
+ const fromFieldId = useGetFieldAndTableFromFieldId(
+ typeof id === "number" ? id : null,
+ );
+
+ const fromCardMetadata = useGetVirtualFieldFromCardMetadata(
+ typeof id === "string" ? id : null,
+ );
+
+ if (typeof id === "number") {
+ return fromFieldId;
+ } else {
+ return fromCardMetadata;
+ }
+}
+
+function useGetFieldAndTableFromFieldId(id: FieldId | null) {
+ const {
+ data: field,
+ isLoading: isLoadingField,
+ error: fieldError,
+ } = useGetFieldQuery(id != null ? { id } : skipToken);
+
+ const {
+ data: table,
+ isLoading: isLoadingTable,
+ error: tableError,
+ } = useGetTableQuery(
+ field?.table_id != null ? { id: field.table_id } : skipToken,
+ );
+
+ return {
+ field,
+ table,
+ isLoading: isLoadingField || isLoadingTable,
+ error: fieldError ?? tableError,
+ };
+}
+
+function useGetVirtualFieldFromCardMetadata(id: UniqueFieldId | null) {
+ const virtualTableId = id?.split(":")[0];
+ const cardId =
+ id != null ? getQuestionIdFromVirtualTableId(virtualTableId) : null;
+
+ const cardMetadata = useGetCardQueryMetadataQuery(
+ cardId != null ? cardId : skipToken,
+ );
+
+ const virtualTable = cardMetadata.data?.tables.find(
+ (table) => table.id === virtualTableId,
+ );
+
+ const field = virtualTable?.fields?.find(
+ (field) => `${field.table_id}:${field.name}` === id,
+ );
+
+ return {
+ field,
+ table: virtualTable,
+ isLoading: cardMetadata.isLoading,
+ error: cardMetadata.error,
+ };
+}
diff --git a/frontend/src/metabase/query_builder/components/dataref/MainPane.jsx b/frontend/src/metabase/query_builder/components/dataref/MainPane.jsx
deleted file mode 100644
index bf50d78ca5c..00000000000
--- a/frontend/src/metabase/query_builder/components/dataref/MainPane.jsx
+++ /dev/null
@@ -1,46 +0,0 @@
-/* eslint "react/prop-types": "warn" */
-import cx from "classnames";
-import PropTypes from "prop-types";
-import { t } from "ttag";
-
-import CS from "metabase/css/core/index.css";
-import { Databases } from "metabase/entities/databases";
-import { SidebarContent } from "metabase/query_builder/components/SidebarContent";
-
-import {
- NodeListItemIcon,
- NodeListItemLink,
- NodeListItemName,
-} from "./NodeList";
-
-const MainPaneInner = ({ databases, onClose, onItemClick, onBack }) => (
- <SidebarContent title={t`Data Reference`} onClose={onClose} onBack={onBack}>
- <SidebarContent.Pane>
- <p className={cx(CS.mt2, CS.mb3, CS.textSpaced)}>
- {t`Browse the contents of your databases, tables, and columns. Pick a database to get started.`}
- </p>
- <ul>
- {databases &&
- databases.map((database) => (
- <li key={database.id}>
- <NodeListItemLink
- onClick={() => onItemClick("database", database)}
- >
- <NodeListItemIcon name="database" />
- <NodeListItemName>{database.name}</NodeListItemName>
- </NodeListItemLink>
- </li>
- ))}
- </ul>
- </SidebarContent.Pane>
- </SidebarContent>
-);
-
-MainPaneInner.propTypes = {
- databases: PropTypes.array,
- onClose: PropTypes.func,
- onBack: PropTypes.func,
- onItemClick: PropTypes.func.isRequired,
-};
-
-export const MainPane = Databases.loadList()(MainPaneInner);
diff --git a/frontend/src/metabase/query_builder/components/dataref/MainPane.tsx b/frontend/src/metabase/query_builder/components/dataref/MainPane.tsx
new file mode 100644
index 00000000000..66f48c314cd
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/dataref/MainPane.tsx
@@ -0,0 +1,50 @@
+import cx from "classnames";
+import { t } from "ttag";
+
+import { useListDatabasesQuery } from "metabase/api";
+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
+import CS from "metabase/css/core/index.css";
+import { SidebarContent } from "metabase/query_builder/components/SidebarContent";
+
+import {
+ NodeListItemIcon,
+ NodeListItemLink,
+ NodeListItemName,
+} from "./NodeList";
+import type { DataReferencePaneProps } from "./types";
+
+export const MainPane = ({
+ onClose,
+ onItemClick,
+ onBack,
+}: DataReferencePaneProps) => {
+ const { data, isLoading, error } = useListDatabasesQuery();
+
+ if (isLoading || error) {
+ return <LoadingAndErrorWrapper loading={isLoading} error={error} />;
+ }
+
+ return (
+ <SidebarContent title={t`Data Reference`} onClose={onClose} onBack={onBack}>
+ <SidebarContent.Pane>
+ <p className={cx(CS.mt2, CS.mb3, CS.textSpaced)}>
+ {t`Browse the contents of your databases, tables, and columns. Pick a database to get started.`}
+ </p>
+ <ul>
+ {data?.data?.map((database) => (
+ <li key={database.id}>
+ <NodeListItemLink
+ onClick={() =>
+ onItemClick({ type: "database", id: database.id })
+ }
+ >
+ <NodeListItemIcon name="database" />
+ <NodeListItemName>{database.name}</NodeListItemName>
+ </NodeListItemLink>
+ </li>
+ ))}
+ </ul>
+ </SidebarContent.Pane>
+ </SidebarContent>
+ );
+};
diff --git a/frontend/src/metabase/query_builder/components/dataref/QuestionPane/QuestionPane.tsx b/frontend/src/metabase/query_builder/components/dataref/QuestionPane/QuestionPane.tsx
index 6af5d1fd1f6..4b18842b16c 100644
--- a/frontend/src/metabase/query_builder/components/dataref/QuestionPane/QuestionPane.tsx
+++ b/frontend/src/metabase/query_builder/components/dataref/QuestionPane/QuestionPane.tsx
@@ -20,24 +20,16 @@ import { Box, Flex, Icon, type IconName } from "metabase/ui";
import type Question from "metabase-lib/v1/Question";
import { getQuestionVirtualTableId } from "metabase-lib/v1/metadata/utils/saved-questions";
import * as ML_Urls from "metabase-lib/v1/urls";
-import type { CardId } from "metabase-types/api";
import { FieldList } from "../FieldList";
import { NodeListTitleText } from "../NodeList";
+import type {
+ DataReferencePaneProps,
+ DataReferenceQuestionItem,
+} from "../types";
import S from "./QuestionPane.module.css";
-type QuestionItem = {
- id: CardId;
-};
-
-type QuestionPaneProps = {
- question: QuestionItem;
- onItemClick: (type: string, item: unknown) => void;
- onBack: () => void;
- onClose: () => void;
-};
-
const getIcon = (question: Question): IconName => {
return match(question.type())
.returnType<IconName>()
@@ -48,11 +40,11 @@ const getIcon = (question: Question): IconName => {
};
export const QuestionPane = ({
- question: { id },
+ id,
onBack,
onItemClick,
onClose,
-}: QuestionPaneProps) => {
+}: DataReferencePaneProps<DataReferenceQuestionItem>) => {
const {
data: card,
isLoading: isLoadingCard,
@@ -147,7 +139,13 @@ export const QuestionPane = ({
{table.fields && (
<FieldList
fields={table.fields}
- onFieldClick={(f) => onItemClick("field", f)}
+ onFieldClick={(field) => {
+ onItemClick({
+ type: "field",
+ id:
+ typeof field.id === "number" ? field.id : field.getUniqueId(),
+ });
+ }}
/>
)}
</Box>
diff --git a/frontend/src/metabase/query_builder/components/dataref/ResourceTreeNode.tsx b/frontend/src/metabase/query_builder/components/dataref/ResourceTreeNode.tsx
index 2dd2a3d861a..67d57f944ef 100644
--- a/frontend/src/metabase/query_builder/components/dataref/ResourceTreeNode.tsx
+++ b/frontend/src/metabase/query_builder/components/dataref/ResourceTreeNode.tsx
@@ -1,7 +1,4 @@
-import type {
- ITreeNodeItem,
- TreeNodeProps,
-} from "metabase/common/components/tree/types";
+import type { TreeNodeProps } from "metabase/common/components/tree/types";
import type { IconName } from "metabase/ui";
import {
@@ -12,14 +9,14 @@ import {
} from "./NodeList";
import S from "./ResourceTreeNode.module.css";
-export const ResourceTreeNode = ({
+export const ResourceTreeNode = <TData = unknown,>({
item,
depth,
isExpanded,
displayId = false,
onToggleExpand,
onItemClick,
-}: TreeNodeProps<ITreeNodeItem> & {
+}: TreeNodeProps<TData> & {
displayId?: boolean;
onItemClick: () => void;
}) => {
diff --git a/frontend/src/metabase/query_builder/components/dataref/SchemaPane.tsx b/frontend/src/metabase/query_builder/components/dataref/SchemaPane.tsx
index 9b13b76c578..d179203f962 100644
--- a/frontend/src/metabase/query_builder/components/dataref/SchemaPane.tsx
+++ b/frontend/src/metabase/query_builder/components/dataref/SchemaPane.tsx
@@ -1,10 +1,9 @@
-import { useMemo } from "react";
import { msgid, ngettext } from "ttag";
-import { Schemas } from "metabase/entities/schemas";
+import { useListDatabaseSchemaTablesQuery } from "metabase/api";
+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { SidebarContent } from "metabase/query_builder/components/SidebarContent";
-import type Schema from "metabase-lib/v1/metadata/Schema";
-import type { State } from "metabase-types/store";
+import { isConcreteTableId } from "metabase-types/api";
import {
NodeListContainer,
@@ -15,27 +14,30 @@ import {
NodeListTitle,
NodeListTitleText,
} from "./NodeList";
+import type { DataReferencePaneProps, DataReferenceSchemaItem } from "./types";
-interface SchemaPaneProps {
- onBack: () => void;
- onClose: () => void;
- onItemClick: (type: string, item: unknown) => void;
- schema: Schema;
-}
+type SchemaPaneProps = DataReferencePaneProps<DataReferenceSchemaItem>;
-const SchemaPaneInner = ({
+export const SchemaPane = ({
onBack,
onClose,
onItemClick,
- schema,
+ schemaName,
+ databaseId,
}: SchemaPaneProps) => {
- const tables = useMemo(
- () => schema.getTables().sort((a, b) => a.name.localeCompare(b.name)),
- [schema],
- );
+ const {
+ data: tables = [],
+ isLoading,
+ error,
+ } = useListDatabaseSchemaTablesQuery({ id: databaseId, schema: schemaName });
+
+ if (isLoading || error) {
+ return <LoadingAndErrorWrapper loading={isLoading} error={error} />;
+ }
+
return (
<SidebarContent
- title={schema.name}
+ title={schemaName}
icon={"folder"}
onBack={onBack}
onClose={onClose}
@@ -53,21 +55,22 @@ const SchemaPaneInner = ({
</NodeListTitleText>
</NodeListTitle>
<ul>
- {tables.map((table) => (
- <li key={table.id}>
- <NodeListItemLink onClick={() => onItemClick("table", table)}>
- <NodeListItemIcon name="table" />
- <NodeListItemName>{table.name}</NodeListItemName>
- </NodeListItemLink>
- </li>
- ))}
+ {tables.map(
+ ({ id, name }) =>
+ isConcreteTableId(id) && (
+ <li key={id}>
+ <NodeListItemLink
+ onClick={() => onItemClick({ type: "table", id })}
+ >
+ <NodeListItemIcon name="table" />
+ <NodeListItemName>{name}</NodeListItemName>
+ </NodeListItemLink>
+ </li>
+ ),
+ )}
</ul>
</NodeListContainer>
</SidebarContent.Pane>
</SidebarContent>
);
};
-
-export const SchemaPane = Schemas.load({
- id: (_state: State, props: SchemaPaneProps) => props.schema.id,
-})(SchemaPaneInner);
diff --git a/frontend/src/metabase/query_builder/components/dataref/TablePane.tsx b/frontend/src/metabase/query_builder/components/dataref/TablePane.tsx
index aed8c519c14..0e90e3e0a96 100644
--- a/frontend/src/metabase/query_builder/components/dataref/TablePane.tsx
+++ b/frontend/src/metabase/query_builder/components/dataref/TablePane.tsx
@@ -11,7 +11,7 @@ import { useSelector } from "metabase/lib/redux";
import { SidebarContent } from "metabase/query_builder/components/SidebarContent";
import { ConnectedTableList } from "metabase/query_builder/components/dataref/ConnectedTableList";
import { getMetadata } from "metabase/selectors/metadata";
-import type { ConcreteTableId } from "metabase-types/api";
+import { isConcreteTableId } from "metabase-types/api";
import { FieldList } from "./FieldList";
import {
@@ -24,24 +24,14 @@ import {
NodeListTitleText,
} from "./NodeList";
import { TableInfoLoader } from "./TableInfoLoader";
-
-type TableItem = {
- id: ConcreteTableId;
-};
-
-type TablePaneProps = {
- table: TableItem;
- onBack: () => void;
- onClose: () => void;
- onItemClick: (type: string, item: unknown) => void;
-};
+import type { DataReferencePaneProps, DataReferenceTableItem } from "./types";
export function TablePane({
- table: { id },
+ id,
onItemClick,
onBack,
onClose,
-}: TablePaneProps) {
+}: DataReferencePaneProps<DataReferenceTableItem>) {
const { isLoading, error } = useGetTableQuery({ id });
const metadata = useSelector(getMetadata);
@@ -75,12 +65,24 @@ export function TablePane({
<>
<FieldList
fields={table.fields}
- onFieldClick={(f) => onItemClick("field", f)}
+ onFieldClick={(field) => {
+ onItemClick({
+ type: "field",
+ id:
+ typeof field.id === "number"
+ ? field.id
+ : field.getUniqueId(),
+ });
+ }}
/>
{table.connectedTables() && (
<ConnectedTableList
tables={table.connectedTables()}
- onTableClick={(t) => onItemClick("table", t)}
+ onTableClick={(table) => {
+ if (isConcreteTableId(table.id)) {
+ onItemClick({ type: "table", id: table.id });
+ }
+ }}
/>
)}
</>
@@ -101,7 +103,12 @@ export function TablePane({
{table.metrics?.map((metric) => (
<li key={metric.card().id}>
<NodeListItemLink
- onClick={() => onItemClick("question", metric.card())}
+ onClick={() =>
+ onItemClick({
+ type: "question",
+ id: metric.card().id,
+ })
+ }
>
<NodeListItemIcon name="metric" />
<NodeListItemName>
diff --git a/frontend/src/metabase/query_builder/components/dataref/types.ts b/frontend/src/metabase/query_builder/components/dataref/types.ts
new file mode 100644
index 00000000000..53a34a1853f
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/dataref/types.ts
@@ -0,0 +1,64 @@
+import type {
+ CardId,
+ ConcreteTableId,
+ DatabaseId,
+ FieldId,
+ SchemaName,
+ VirtualTableId,
+} from "metabase-types/api";
+
+import { DatabasePane } from "./DatabasePane";
+import { FieldPane } from "./FieldPane";
+import { QuestionPane } from "./QuestionPane";
+import { SchemaPane } from "./SchemaPane";
+import { TablePane } from "./TablePane";
+
+export const PANES = {
+ database: DatabasePane, // lists schemas, tables and models of a database
+ schema: SchemaPane, // lists tables of a schema
+ table: TablePane, // lists fields of a table
+ question: QuestionPane, // lists fields of a question
+ field: FieldPane, // field details and metadata
+};
+
+export type OnItemClick = (item: DataReferenceItem) => void;
+export type DataReferencePaneProps<TItem = unknown> = {
+ onClose?: () => void;
+ onBack?: () => void;
+ onItemClick: OnItemClick;
+} & TItem;
+
+export type DataReferenceItem =
+ | DataReferenceDatabaseItem
+ | DataReferenceSchemaItem
+ | DataReferenceTableItem
+ | DataReferenceQuestionItem
+ | DataReferenceFieldItem;
+
+export type DataReferenceDatabaseItem = {
+ type: "database";
+ id: DatabaseId;
+};
+
+export type DataReferenceSchemaItem = {
+ type: "schema";
+ schemaName: SchemaName;
+ databaseId: DatabaseId;
+};
+
+export type DataReferenceTableItem = {
+ type: "table";
+ id: ConcreteTableId;
+};
+
+export type DataReferenceQuestionItem = {
+ type: "question";
+ id: CardId;
+};
+
+export type UniqueFieldId = `${VirtualTableId}:${string}`;
+
+export type DataReferenceFieldItem = {
+ type: "field";
+ id: FieldId | UniqueFieldId;
+};
diff --git a/frontend/src/metabase/query_builder/components/view/View/NativeQueryRightSidebar/NativeQueryRightSidebar.tsx b/frontend/src/metabase/query_builder/components/view/View/NativeQueryRightSidebar/NativeQueryRightSidebar.tsx
index 6f689934837..24211ee99dc 100644
--- a/frontend/src/metabase/query_builder/components/view/View/NativeQueryRightSidebar/NativeQueryRightSidebar.tsx
+++ b/frontend/src/metabase/query_builder/components/view/View/NativeQueryRightSidebar/NativeQueryRightSidebar.tsx
@@ -3,6 +3,7 @@ import { match } from "ts-pattern";
import { PLUGIN_AI_ENTITY_ANALYSIS } from "metabase/plugins";
import type { EmbeddingParameterVisibility } from "metabase/public/lib/types";
import { DataReference } from "metabase/query_builder/components/dataref/DataReference";
+import type { DataReferenceItem } from "metabase/query_builder/components/dataref/types";
import { SnippetSidebar } from "metabase/query_builder/components/template_tags/SnippetSidebar";
import { TagEditorSidebar } from "metabase/query_builder/components/template_tags/TagEditorSidebar";
import { QuestionInfoSidebar } from "metabase/query_builder/components/view/sidebars/QuestionInfoSidebar";
@@ -51,6 +52,10 @@ interface NativeQueryRightSidebarProps {
getEmbeddedParameterVisibility: (
slug: string,
) => EmbeddingParameterVisibility;
+
+ dataReferenceStack: DataReferenceItem[];
+ pushDataReferenceStack: (item: DataReferenceItem) => void;
+ popDataReferenceStack: () => void;
}
export const NativeQueryRightSidebar = (
diff --git a/frontend/src/metabase/query_builder/selectors.js b/frontend/src/metabase/query_builder/selectors.js
index 291fe625a10..315d24f2040 100644
--- a/frontend/src/metabase/query_builder/selectors.js
+++ b/frontend/src/metabase/query_builder/selectors.js
@@ -1018,7 +1018,7 @@ export const getDataReferenceStack = createSelector(
uiControls.dataReferenceStack
? uiControls.dataReferenceStack
: dbId
- ? [{ type: "database", item: { id: dbId } }]
+ ? [{ type: "database", id: dbId }]
: [],
);
diff --git a/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx b/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
index 99321bdc87a..28c599ab163 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
@@ -77,7 +77,7 @@ function QueryDataReferenceSidebar({
useMount(() => {
const databaseId = question.databaseId();
if (dataReferenceStack.length === 0 && databaseId !== null) {
- pushDataReferenceStack({ type: "database", item: { id: databaseId } });
+ pushDataReferenceStack({ type: "database", id: databaseId });
}
});
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/NativeQueryModal.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/NativeQueryModal.tsx
index 5c7c1e20979..1772f7a0d8a 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/NativeQueryModal.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/shared/NativeQueryModal.tsx
@@ -14,6 +14,7 @@ import { isMac } from "metabase/lib/browser";
import { useDispatch, useSelector } from "metabase/lib/redux";
import { NativeQueryEditor } from "metabase/query_builder/components/NativeQueryEditor";
import { DataReference } from "metabase/query_builder/components/dataref/DataReference";
+import type { DataReferenceItem } from "metabase/query_builder/components/dataref/types";
import { createRawSeries } from "metabase/query_builder/utils";
import { getMetadata } from "metabase/selectors/metadata";
import { Box, Button, Flex, Loader, Modal, Stack, Text } from "metabase/ui";
@@ -26,11 +27,6 @@ import type { Card, DatabaseId, Dataset, RawSeries } from "metabase-types/api";
import S from "./NativeQueryModal.module.css";
-type DataReferenceStackItem = {
- type: string;
- item: unknown;
-};
-
interface NativeQueryModalProps {
card: Card;
isOpen: boolean;
@@ -124,7 +120,7 @@ export const NativeQueryModal = ({
useState(false);
const [isShowingDataReference, setIsShowingDataReference] = useState(false);
const [dataReferenceStack, setDataReferenceStack] = useState<
- DataReferenceStackItem[]
+ DataReferenceItem[]
>([]);
const [
@@ -357,7 +353,7 @@ export const NativeQueryModal = ({
const databaseId = modifiedQuestion.databaseId();
if (databaseId) {
setDataReferenceStack([
- { type: "database", item: { id: databaseId } },
+ { type: "database", id: databaseId },
]);
}
}
@@ -442,7 +438,7 @@ export const NativeQueryModal = ({
setDataReferenceStack(dataReferenceStack.slice(0, -1));
}
}}
- pushDataReferenceStack={(item: DataReferenceStackItem) => {
+ pushDataReferenceStack={(item: DataReferenceItem) => {
setDataReferenceStack([...dataReferenceStack, item]);
}}
/>