Skip to content

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

Convert MBQL transforms to SQL (#63565)

Romeo Van Snickd867a09072c6
diff --git a/e2e/test/scenarios/admin/transforms.cy.spec.ts b/e2e/test/scenarios/admin/transforms.cy.spec.ts
index c4948c0e47e..a378b9cb5d8 100644
--- a/e2e/test/scenarios/admin/transforms.cy.spec.ts
+++ b/e2e/test/scenarios/admin/transforms.cy.spec.ts
@@ -246,6 +246,40 @@ H.describeWithSnowplowEE("scenarios > admin > transforms", () => {
testCardSource({ type: "model", label: "Models" });
});
+ it("should be possible to convert an MBQL transform to a SQL transform", () => {
+ const EXPECTED_QUERY = `SELECT
+ "Schema Q"."Animals"."name" AS "name",
+ "Schema Q"."Animals"."score" AS "score"
+FROM
+ "Schema Q"."Animals"
+LIMIT
+ 5`;
+
+ createMbqlTransform({ visitTransform: true });
+ getTransformPage().findByText("Edit query").click();
+
+ getQueryEditor().icon("sql").click();
+ H.sidebar().should("be.visible");
+ H.NativeEditor.value().should("eq", EXPECTED_QUERY);
+
+ H.sidebar().findByText("Convert this transform to SQL").click();
+ H.sidebar().should("be.visible");
+
+ H.NativeEditor.value().should("eq", EXPECTED_QUERY);
+ getQueryEditor().button("Save changes").click();
+
+ cy.log("run the transform and make sure its table can be queried");
+ runTransformAndWaitForSuccess();
+ H.expectUnstructuredSnowplowEvent({
+ event: "transform_trigger_manual_run",
+ triggered_from: "transform-page",
+ });
+
+ getTableLink().click();
+ H.queryBuilderHeader().findByText(DB_NAME).should("be.visible");
+ H.assertQueryBuilderRowCount(3);
+ });
+
it("should not allow to overwrite an existing table when creating a transform", () => {
cy.log("open the new transform page");
visitTransformListPage();
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/EditorBody.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/EditorBody.tsx
index 18c4d78d964..bc1a807162d 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/EditorBody.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/EditorBody.tsx
@@ -19,8 +19,9 @@ import type {
RecentItem,
} from "metabase-types/api";
+import { ResizeHandle } from "../ResizeHandle";
+
import S from "./EditorBody.module.css";
-import { ResizableBoxHandle } from "./ResizableBoxHandle";
const EDITOR_HEIGHT = 400;
@@ -141,7 +142,7 @@ export function EditorBody({
className={S.root}
axis="y"
height={EDITOR_HEIGHT}
- handle={<ResizableBoxHandle />}
+ handle={<ResizeHandle />}
resizeHandles={["s"]}
onResizeStart={() => setIsResizing(true)}
onResizeStop={() => setIsResizing(false)}
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/ResizableBoxHandle/ResizableBoxHandle.module.css b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/ResizableBoxHandle/ResizableBoxHandle.module.css
deleted file mode 100644
index ac90231539b..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/ResizableBoxHandle/ResizableBoxHandle.module.css
+++ /dev/null
@@ -1,3 +0,0 @@
-.root {
- cursor: row-resize;
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/ResizableBoxHandle/ResizableBoxHandle.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/ResizableBoxHandle/ResizableBoxHandle.tsx
deleted file mode 100644
index 8020e0504fc..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/ResizableBoxHandle/ResizableBoxHandle.tsx
+++ /dev/null
@@ -1,27 +0,0 @@
-import { type HTMLAttributes, type Ref, forwardRef } from "react";
-import _ from "underscore";
-
-import { Box, Flex, rem } from "metabase/ui";
-
-import S from "./ResizableBoxHandle.module.css";
-
-export const ResizableBoxHandle = forwardRef(function ResizableBoxHandle(
- props: HTMLAttributes<HTMLDivElement>,
- ref: Ref<HTMLDivElement>,
-) {
- return (
- <Flex
- ref={ref}
- className={S.root}
- align="center"
- justify="center"
- w="100%"
- h="sm"
- pos="absolute"
- bottom={rem(-4)}
- {..._.omit(props, "handleAxis")}
- >
- <Box w="6.25rem" h="xs" bg="border" />
- </Flex>
- );
-});
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/ResizableBoxHandle/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/ResizableBoxHandle/index.ts
deleted file mode 100644
index 3141dc8e2ba..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/ResizableBoxHandle/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from "./ResizableBoxHandle";
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.module.css b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.module.css
new file mode 100644
index 00000000000..993e6069551
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.module.css
@@ -0,0 +1,10 @@
+.nativeSidebarToggle {
+ position: absolute;
+ top: var(--mantine-spacing-lg);
+ right: var(--mantine-spacing-md);
+}
+
+.nativeSidebar {
+ border-left: 1px solid var(--mb-color-border);
+ margin-inline-start: 0.25rem;
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
new file mode 100644
index 00000000000..c3183426604
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
@@ -0,0 +1,67 @@
+import { ResizableBox } from "react-resizable";
+import { useWindowSize } from "react-use";
+import { t } from "ttag";
+
+import { NotebookNativePreview } from "metabase/querying/notebook/components/NotebookNativePreview";
+import { ActionIcon, Icon, Tooltip } from "metabase/ui";
+import type Question from "metabase-lib/v1/Question";
+
+import { ResizeHandle } from "../ResizeHandle";
+
+import S from "./NativeQuerySidebar.module.css";
+
+export function NativeQuerySidebarToggle({
+ isShowingNativeQueryPreview,
+ onToggleNativeQueryPreview,
+}: {
+ isNative?: boolean;
+ isShowingNativeQueryPreview: boolean;
+ onToggleNativeQueryPreview: () => void;
+}) {
+ return (
+ <Tooltip label={isShowingNativeQueryPreview ? t`Hide SQL` : t`View SQL`}>
+ <ActionIcon
+ key="view-sql"
+ onClick={onToggleNativeQueryPreview}
+ size="lg"
+ className={S.nativeSidebarToggle}
+ color="text"
+ variant="subtle"
+ >
+ <Icon name="sql" color="text" />
+ </ActionIcon>
+ </Tooltip>
+ );
+}
+
+export function NativeQuerySidebar({
+ question,
+ onConvertToNativeClick,
+}: {
+ question: Question;
+ onConvertToNativeClick: (newQuestion: Question) => void;
+}) {
+ const { width: windowWidth } = useWindowSize();
+
+ const minSidebarWidth = 428;
+ const minNotebookWidth = 640;
+ const maxSidebarWidth = windowWidth - minNotebookWidth;
+
+ return (
+ <ResizableBox
+ width={minSidebarWidth}
+ minConstraints={[minSidebarWidth, 0]}
+ maxConstraints={[maxSidebarWidth, 0]}
+ axis="x"
+ resizeHandles={["w"]}
+ handle={<ResizeHandle />}
+ className={S.nativeSidebar}
+ >
+ <NotebookNativePreview
+ question={question}
+ onConvertClick={onConvertToNativeClick}
+ buttonTitle={t`Convert this transform to SQL`}
+ />
+ </ResizableBox>
+ );
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/NativeQuerySidebar/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/NativeQuerySidebar/index.ts
new file mode 100644
index 00000000000..dbcddf6da4f
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/NativeQuerySidebar/index.ts
@@ -0,0 +1 @@
+export * from "./NativeQuerySidebar";
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/QueryEditor.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/QueryEditor.tsx
index 7274d91de50..5655a1486c0 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/QueryEditor.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/QueryEditor.tsx
@@ -1,4 +1,4 @@
-import { useDisclosure, useHotkeys } from "@mantine/hooks";
+import { useDisclosure, useHotkeys, useToggle } from "@mantine/hooks";
import { useState } from "react";
import { useListDatabasesQuery } from "metabase/api";
@@ -16,6 +16,10 @@ import { EditorBody } from "./EditorBody";
import { EditorHeader } from "./EditorHeader";
import { EditorSidebar } from "./EditorSidebar";
import { EditorVisualization } from "./EditorVisualization";
+import {
+ NativeQuerySidebar,
+ NativeQuerySidebarToggle,
+} from "./NativeQuerySidebar";
import S from "./QueryEditor.module.css";
import { useInsertSnippetHandler, useSelectedText } from "./util";
@@ -47,6 +51,7 @@ export function QueryEditor({
} = useQueryResults(question);
const canSave = Lib.canSave(question.query(), question.type());
const { isNative } = Lib.queryDisplayInfo(question.query());
+ const [isShowingNativeQueryPreview, toggleNativeQueryPreview] = useToggle();
const handleChange = async (newQuestion: Question) => {
setQuestion(newQuestion);
@@ -125,8 +130,8 @@ export function QueryEditor({
onSave={handleSave}
onCancel={onCancel}
/>
- <Flex h="100%" w="100%">
- <Stack flex="2 1 100%">
+ <Flex h="100%" w="100%" mih="0">
+ <Stack flex="2 1 100%" pos="relative">
<EditorBody
question={question}
isNative={isNative}
@@ -157,7 +162,25 @@ export function QueryEditor({
onRunQuery={runQuery}
onCancelQuery={() => undefined}
/>
+
+ {!isNative && (
+ <NativeQuerySidebarToggle
+ isShowingNativeQueryPreview={isShowingNativeQueryPreview}
+ onToggleNativeQueryPreview={toggleNativeQueryPreview}
+ />
+ )}
</Stack>
+
+ {!isNative && isShowingNativeQueryPreview && (
+ <NativeQuerySidebar
+ question={question}
+ onConvertToNativeClick={(newQuestion) => {
+ toggleNativeQueryPreview(false);
+ setQuestion(newQuestion);
+ }}
+ />
+ )}
+
<EditorSidebar
question={question}
isNative={isNative}
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/ResizeHandle/ResizeHandle.module.css b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/ResizeHandle/ResizeHandle.module.css
new file mode 100644
index 00000000000..b286725a6d2
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/ResizeHandle/ResizeHandle.module.css
@@ -0,0 +1,7 @@
+.horizontal {
+ cursor: row-resize;
+}
+
+.vertical {
+ cursor: col-resize;
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/ResizeHandle/ResizeHandle.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/ResizeHandle/ResizeHandle.tsx
new file mode 100644
index 00000000000..a5957e4880b
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/ResizeHandle/ResizeHandle.tsx
@@ -0,0 +1,54 @@
+import { type HTMLAttributes, type Ref, forwardRef } from "react";
+
+import { Box, Flex, rem } from "metabase/ui";
+
+import S from "./ResizeHandle.module.css";
+
+type Props = HTMLAttributes<HTMLDivElement> & {
+ handleAxis?: "n" | "e" | "s" | "w";
+};
+
+const THICKNESS = "6.25rem";
+
+export const ResizeHandle = forwardRef(function ResizableBoxHandle(
+ props: Props,
+ ref: Ref<HTMLDivElement>,
+) {
+ const { handleAxis, ...rest } = props;
+
+ if (handleAxis === "e" || handleAxis === "w") {
+ return (
+ <Flex
+ ref={ref}
+ className={S.vertical}
+ align="center"
+ justify="center"
+ pos="absolute"
+ w="sm"
+ h="100%"
+ top={0}
+ left={rem(-4)}
+ {...rest}
+ >
+ <Box w="xs" h={THICKNESS} bg="border" />
+ </Flex>
+ );
+ } else if (handleAxis === "s" || handleAxis === "n") {
+ return (
+ <Flex
+ ref={ref}
+ className={S.horizontal}
+ align="center"
+ justify="center"
+ pos="absolute"
+ w="100%"
+ h="sm"
+ bottom={rem(-4)}
+ {...rest}
+ >
+ <Box w={THICKNESS} h="xs" bg="border" />
+ </Flex>
+ );
+ }
+ return null;
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/ResizeHandle/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/ResizeHandle/index.ts
new file mode 100644
index 00000000000..114b47e5a47
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/ResizeHandle/index.ts
@@ -0,0 +1 @@
+export * from "./ResizeHandle";
diff --git a/frontend/src/metabase/common/components/EditBar/EditBar.tsx b/frontend/src/metabase/common/components/EditBar/EditBar.tsx
index 12b3ba45805..2449c78f20c 100644
--- a/frontend/src/metabase/common/components/EditBar/EditBar.tsx
+++ b/frontend/src/metabase/common/components/EditBar/EditBar.tsx
@@ -1,11 +1,13 @@
+import type { ReactNode } from "react";
+
import { Group } from "metabase/ui";
import { ButtonsContainer, EditIcon, Root, Title } from "./EditBar.styled";
type Props = {
title: string;
- center?: JSX.Element;
- buttons: JSX.Element[];
+ center?: ReactNode;
+ buttons: ReactNode;
admin?: boolean;
className?: string;
"data-testid"?: string;
diff --git a/frontend/src/metabase/query_builder/components/view/View/NotebookContainer/NotebookContainer.tsx b/frontend/src/metabase/query_builder/components/view/View/NotebookContainer/NotebookContainer.tsx
index f2cd1582323..257096b40d2 100644
--- a/frontend/src/metabase/query_builder/components/view/View/NotebookContainer/NotebookContainer.tsx
+++ b/frontend/src/metabase/query_builder/components/view/View/NotebookContainer/NotebookContainer.tsx
@@ -18,11 +18,12 @@ import {
Notebook,
type NotebookProps,
} from "metabase/querying/notebook/components/Notebook";
-import { NotebookNativePreview } from "metabase/querying/notebook/components/NotebookNativePreview";
import { Box, Flex, rem } from "metabase/ui";
import { canShowNativePreview } from "../../ViewHeader/utils";
+import { NotebookNativePreview } from "./NotebookNativePreview";
+
// There must exist some transition time, no matter how short,
// because we need to trigger the 'onTransitionEnd' in the component
const delayBeforeNotRenderingNotebook = 10;
diff --git a/frontend/src/metabase/query_builder/components/view/View/NotebookContainer/NotebookNativePreview.tsx b/frontend/src/metabase/query_builder/components/view/View/NotebookContainer/NotebookNativePreview.tsx
new file mode 100644
index 00000000000..529fa9f9ff2
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/view/View/NotebookContainer/NotebookNativePreview.tsx
@@ -0,0 +1,30 @@
+import { useCallback } from "react";
+
+import { useDispatch, useSelector } from "metabase/lib/redux";
+import { checkNotNull } from "metabase/lib/types";
+import { setUIControls, updateQuestion } from "metabase/query_builder/actions";
+import { getQuestion } from "metabase/query_builder/selectors";
+import { NotebookNativePreview as ControlledNotebookNativePreview } from "metabase/querying/notebook/components/NotebookNativePreview";
+import type Question from "metabase-lib/v1/Question";
+
+export const NotebookNativePreview = () => {
+ const dispatch = useDispatch();
+ const question = checkNotNull(useSelector(getQuestion));
+
+ const handleConvertClick = useCallback(
+ (newQuestion: Question) => {
+ dispatch(
+ updateQuestion(newQuestion, { shouldUpdateUrl: true, run: true }),
+ );
+ dispatch(setUIControls({ isNativeEditorOpen: true }));
+ },
+ [dispatch],
+ );
+
+ return (
+ <ControlledNotebookNativePreview
+ question={question}
+ onConvertClick={handleConvertClick}
+ />
+ );
+};
diff --git a/frontend/src/metabase/querying/notebook/components/NotebookNativePreview/NotebookNativePreview.tsx b/frontend/src/metabase/querying/notebook/components/NotebookNativePreview/NotebookNativePreview.tsx
index ad00053177d..efd52c54ce1 100644
--- a/frontend/src/metabase/querying/notebook/components/NotebookNativePreview/NotebookNativePreview.tsx
+++ b/frontend/src/metabase/querying/notebook/components/NotebookNativePreview/NotebookNativePreview.tsx
@@ -5,13 +5,10 @@ import { useGetNativeDatasetQuery } from "metabase/api";
import { DelayedLoadingSpinner } from "metabase/common/components/EntityPicker/components/LoadingSpinner";
import { color } from "metabase/lib/colors";
import { getEngineNativeType } from "metabase/lib/engine";
-import { useDispatch, useSelector } from "metabase/lib/redux";
-import { checkNotNull } from "metabase/lib/types";
-import { setUIControls, updateQuestion } from "metabase/query_builder/actions";
import { CodeMirrorEditor as Editor } from "metabase/query_builder/components/NativeQueryEditor/CodeMirrorEditor";
-import { getQuestion } from "metabase/query_builder/selectors";
import { Box, Button, Flex, Icon, rem } from "metabase/ui";
import * as Lib from "metabase-lib";
+import type Question from "metabase-lib/v1/Question";
import { createNativeQuestion } from "./utils";
@@ -33,10 +30,15 @@ const BUTTON_TITLE = {
},
};
-export const NotebookNativePreview = (): JSX.Element => {
- const dispatch = useDispatch();
- const question = checkNotNull(useSelector(getQuestion));
-
+export const NotebookNativePreview = ({
+ question,
+ onConvertClick,
+ buttonTitle,
+}: {
+ question: Question;
+ onConvertClick: (newQuestion: Question) => void;
+ buttonTitle?: string;
+}) => {
const database = question.database();
const engine = database?.engine;
const engineType = getEngineNativeType(engine);
@@ -54,20 +56,17 @@ export const NotebookNativePreview = (): JSX.Element => {
const newQuestion = createNativeQuestion(question, data);
const newQuery = newQuestion?.query();
- const handleConvertClick = useCallback(() => {
- if (newQuestion != null) {
- dispatch(
- updateQuestion(newQuestion, { shouldUpdateUrl: true, run: true }),
- );
- dispatch(setUIControls({ isNativeEditorOpen: true }));
- }
- }, [newQuestion, dispatch]);
-
const getErrorMessage = (error: unknown) =>
typeof error === "string" ? error : undefined;
const borderStyle = "1px solid var(--mb-color-border)";
+ const handleConvertClick = useCallback(() => {
+ if (newQuestion) {
+ onConvertClick(newQuestion);
+ }
+ }, [newQuestion, onConvertClick]);
+
return (
<Box
component="aside"
@@ -116,7 +115,7 @@ export const NotebookNativePreview = (): JSX.Element => {
onClick={handleConvertClick}
disabled={!showQuery}
>
- {BUTTON_TITLE[engineType]}
+ {buttonTitle ?? BUTTON_TITLE[engineType]}
</Button>
</Box>
</Box>