Skip to content

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

Add table template tags (#68922)

William17a3afa85e4d
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index a1bad371174..667de922cc4 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -1181,6 +1181,7 @@
metabase.query-processor.init
metabase.query-processor.interface
metabase.query-processor.metadata
+ metabase.query-processor.middleware.add-remaps
metabase.query-processor.middleware.annotate
metabase.query-processor.middleware.cache-backend.db
metabase.query-processor.middleware.constraints
diff --git a/e2e/test/scenarios/native/table-tags.cy.spec.ts b/e2e/test/scenarios/native/table-tags.cy.spec.ts
new file mode 100644
index 00000000000..af80fdf7d60
--- /dev/null
+++ b/e2e/test/scenarios/native/table-tags.cy.spec.ts
@@ -0,0 +1,43 @@
+const { H } = cy;
+
+describe("scenarios > native > table tags", () => {
+ beforeEach(() => {
+ H.restore();
+ cy.signInAsAdmin();
+ });
+
+ it("should run the query with a mapped table", () => {
+ H.startNewNativeQuestion();
+ H.NativeEditor.type("select * from {{table}}");
+ cy.findByTestId("variable-type-select").click();
+ H.popover().findByText("Table").click();
+ H.popover().findByText("Products").click();
+ H.runNativeQuery();
+ H.assertQueryBuilderRowCount(200);
+ });
+
+ it("should run the query with a table tag inside a snippet", () => {
+ H.startNewNativeQuestion();
+
+ cy.log("create a snippet containing a table tag");
+ cy.findByTestId("native-query-top-bar").icon("snippet").click();
+ cy.findByTestId("sidebar-right").findByText("Create snippet").click();
+ H.modal().within(() => {
+ cy.findByLabelText("Enter some SQL here so you can reuse it later").type(
+ "select * from {{table}}",
+ { parseSpecialCharSequences: false },
+ );
+ cy.findByLabelText("Give your snippet a name").type("TableSnippet");
+ cy.button("Save").click();
+ });
+
+ cy.log("map the table variable to the Products table");
+ cy.findByTestId("variable-type-select").click();
+ H.popover().findByText("Table").click();
+ H.popover().findByText("Products").click();
+
+ cy.log("run the query and verify results");
+ H.runNativeQuery();
+ H.assertQueryBuilderRowCount(200);
+ });
+});
diff --git a/frontend/src/metabase-lib/v1/parameters/utils/click-behavior.ts b/frontend/src/metabase-lib/v1/parameters/utils/click-behavior.ts
index 303fe911e91..bc5bd96e28c 100644
--- a/frontend/src/metabase-lib/v1/parameters/utils/click-behavior.ts
+++ b/frontend/src/metabase-lib/v1/parameters/utils/click-behavior.ts
@@ -237,6 +237,7 @@ function getTargetsForVariables(legacyNativeQuery: NativeQuery): Target[] {
dimension: undefined,
snippet: undefined,
"temporal-unit": undefined,
+ table: undefined,
text: TYPE.Text,
number: TYPE.Number,
date: TYPE.Temporal,
diff --git a/frontend/src/metabase-lib/v1/parameters/utils/template-tags.ts b/frontend/src/metabase-lib/v1/parameters/utils/template-tags.ts
index 56411a84256..4d54ec1e092 100644
--- a/frontend/src/metabase-lib/v1/parameters/utils/template-tags.ts
+++ b/frontend/src/metabase-lib/v1/parameters/utils/template-tags.ts
@@ -80,6 +80,7 @@ export function getTemplateTagParameters(
(tag) =>
tag.type != null &&
tag.type !== "card" &&
+ tag.type !== "table" &&
tag.type !== "snippet" &&
((tag.type !== "dimension" && tag.type !== "temporal-unit") ||
tag.dimension != null ||
diff --git a/frontend/src/metabase-lib/v1/queries/NativeQuery.ts b/frontend/src/metabase-lib/v1/queries/NativeQuery.ts
index 54f62a0be7f..2d67290fe0a 100644
--- a/frontend/src/metabase-lib/v1/queries/NativeQuery.ts
+++ b/frontend/src/metabase-lib/v1/queries/NativeQuery.ts
@@ -275,6 +275,7 @@ export default class NativeQuery {
"date",
"boolean",
"temporal-unit",
+ "table",
].includes(t.type),
);
}
diff --git a/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/constants.ts b/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/constants.ts
index fa590539200..e1e7de96fe7 100644
--- a/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/constants.ts
+++ b/frontend/src/metabase-lib/v1/variables/TemplateTagVariable/constants.ts
@@ -12,4 +12,5 @@ export const VARIABLE_ICONS: Record<TemplateTagType, IconName | null> = {
"temporal-unit": "clock",
card: null,
snippet: null,
+ table: null,
};
diff --git a/frontend/src/metabase-types/api/dataset.ts b/frontend/src/metabase-types/api/dataset.ts
index 34748f36a61..caf847653c7 100644
--- a/frontend/src/metabase-types/api/dataset.ts
+++ b/frontend/src/metabase-types/api/dataset.ts
@@ -211,7 +211,8 @@ export type TemplateTagType =
| "boolean"
| "temporal-unit"
| "dimension"
- | "snippet";
+ | "snippet"
+ | "table";
export interface TemplateTag {
id: TemplateTagId;
@@ -235,6 +236,9 @@ export interface TemplateTag {
// Field filter specific
"widget-type"?: string;
options?: ParameterOptions;
+
+ // Table specific
+ "table-id"?: TableId;
}
export type TemplateTags = Record<TemplateTagName, TemplateTag>;
diff --git a/frontend/src/metabase/parameters/components/ParameterValueWidget.tsx b/frontend/src/metabase/parameters/components/ParameterValueWidget.tsx
index 5593563d3f4..00d11c1fcaa 100644
--- a/frontend/src/metabase/parameters/components/ParameterValueWidget.tsx
+++ b/frontend/src/metabase/parameters/components/ParameterValueWidget.tsx
@@ -1,7 +1,6 @@
import { useDisclosure } from "@mantine/hooks";
import cx from "classnames";
import { type ReactNode, useMemo, useState } from "react";
-import { t } from "ttag";
import { Sortable } from "metabase/common/components/Sortable";
import CS from "metabase/css/core/index.css";
@@ -200,6 +199,8 @@ export const ParameterValueWidget = ({
) : null;
}, [hasValue, isEditing, isFocused, noPopover, parameterTypeIcon]);
+ const translatedPlaceholder = tc(placeholder);
+
if (noPopover) {
return (
<Sortable
@@ -223,7 +224,7 @@ export const ParameterValueWidget = ({
value={value}
setValue={setValue}
isEditing={isEditing}
- placeholder={placeholder}
+ placeholder={translatedPlaceholder}
focusChanged={setIsFocused}
isFullscreen={isFullscreen}
commitImmediately={commitImmediately}
@@ -238,14 +239,6 @@ export const ParameterValueWidget = ({
);
}
- const translatedPlaceholder = tc(placeholder);
-
- const placeholderText = isEditing
- ? isDateParameter(parameter)
- ? t`Select a default value…`
- : t`Enter a default value…`
- : translatedPlaceholder || t`Select…`;
-
return (
<Popover
opened={isOpen}
@@ -294,7 +287,7 @@ export const ParameterValueWidget = ({
value={value}
cardId={cardId}
dashboardId={dashboardId}
- placeholder={placeholderText}
+ placeholder={translatedPlaceholder}
isPopoverOpen={isOpen}
/>
</div>
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx
index c6e3d3e11a3..19ab351353e 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx
@@ -28,6 +28,7 @@ import type {
Parameter,
ParameterValuesConfig,
RowValue,
+ TableId,
TemplateTag,
TemplateTagId,
TemplateTagType,
@@ -44,6 +45,8 @@ import {
FieldMappingSelect,
FilterWidgetLabelInput,
FilterWidgetTypeSelect,
+ TableMappingSelect,
+ VariableTypeSelect,
} from "./TagEditorParamParts";
import { FieldAliasInput } from "./TagEditorParamParts/FieldAliasInput";
import { ParameterMultiSelectInput } from "./TagEditorParamParts/ParameterMultiSelectInput";
@@ -51,7 +54,6 @@ import {
ContainerLabel,
InputContainer,
} from "./TagEditorParamParts/TagEditorParam";
-import { VariableTypeSelect } from "./TagEditorParamParts/VariableTypeSelect";
interface StateProps {
metadata: Metadata;
@@ -162,6 +164,7 @@ class TagEditorParamInner extends Component<
dimension: undefined,
alias: undefined,
"widget-type": type === "dimension" ? "none" : undefined,
+ "table-id": undefined,
});
setParameterValue(tag.id, null);
@@ -268,6 +271,13 @@ class TagEditorParamInner extends Component<
}
};
+ setTableId = (tableId: TableId | undefined) => {
+ const { tag, setTemplateTag } = this.props;
+ if (tag["table-id"] !== tableId) {
+ setTemplateTag({ ...tag, "table-id": tableId });
+ }
+ };
+
setAlias = (alias: string | undefined) => {
const { tag, setTemplateTag } = this.props;
if (tag.alias !== alias) {
@@ -305,6 +315,7 @@ class TagEditorParamInner extends Component<
const isDimension = tag.type === "dimension";
const isTemporalUnit = tag.type === "temporal-unit";
+ const isTable = tag.type === "table";
const field = Array.isArray(tag.dimension)
? metadata.field(tag.dimension[1])
: null;
@@ -332,6 +343,15 @@ class TagEditorParamInner extends Component<
/>
)}
+ {isTable && (
+ <TableMappingSelect
+ tag={tag}
+ database={database}
+ databases={databases}
+ onChange={this.setTableId}
+ />
+ )}
+
{(isDimension || isTemporalUnit) && field != null && (
<FieldAliasInput tag={tag} onChange={this.setAlias} />
)}
@@ -345,7 +365,7 @@ class TagEditorParamInner extends Component<
/>
)}
- {(!isDimension || widgetOptions.length > 0) && (
+ {((!isDimension && !isTable) || widgetOptions.length > 0) && (
<FilterWidgetLabelInput
tag={tag}
onChange={(value) =>
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.unit.spec.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.unit.spec.tsx
index 889b6c0cfb6..9951ab509e4 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.unit.spec.tsx
@@ -19,6 +19,7 @@ import {
import {
ORDERS,
PEOPLE,
+ PRODUCTS_ID,
REVIEWS,
createSampleDatabase,
} from "metabase-types/api/mocks/presets";
@@ -145,6 +146,23 @@ describe("TagEditorParam", () => {
"widget-type": undefined,
});
});
+
+ it("should reset type-specific properties when the type is changed", async () => {
+ const tag = createMockTemplateTag({
+ type: "table",
+ "table-id": 1,
+ });
+ const { setTemplateTag } = setup({ tag });
+
+ await userEvent.click(screen.getByTestId("variable-type-select"));
+ await userEvent.click(screen.getByText("Number"));
+
+ expect(setTemplateTag).toHaveBeenCalledWith({
+ ...tag,
+ type: "number",
+ "table-id": undefined,
+ });
+ });
});
describe("tag dimension", () => {
@@ -252,6 +270,21 @@ describe("TagEditorParam", () => {
}, 40000);
});
+ describe("table id", () => {
+ it("should be able to set the table id", async () => {
+ const tag = createMockTemplateTag({
+ type: "table",
+ "table-id": undefined,
+ });
+ const { setTemplateTag } = setup({ tag });
+ await userEvent.click(await screen.findByText("Products"));
+ expect(setTemplateTag).toHaveBeenCalledWith({
+ ...tag,
+ "table-id": PRODUCTS_ID,
+ });
+ });
+ });
+
describe("field alias", () => {
it.each<TemplateTagType>(["dimension", "temporal-unit"])(
"should be possible to set a field alias for %s variables",
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/DefaultRequiredValueControl.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/DefaultRequiredValueControl.tsx
index 0781bc74bfb..6e3cadd3b37 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/DefaultRequiredValueControl.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/DefaultRequiredValueControl.tsx
@@ -3,6 +3,7 @@ import { t } from "ttag";
import { RequiredParamToggle } from "metabase/parameters/components/RequiredParamToggle";
import { Flex, Text } from "metabase/ui";
+import { isDateParameter } from "metabase-lib/v1/parameters/utils/parameter-type";
import type { Parameter, TemplateTag } from "metabase-types/api";
import {
@@ -30,6 +31,10 @@ export function DefaultRequiredValueControl({
[parameter],
);
+ const placeholder = isDateParameter(parameter)
+ ? t`Select a default value…`
+ : t`Enter a default value…`;
+
return (
<div>
<ContainerLabel id={`default-value-label-${tag.id}`}>
@@ -47,6 +52,7 @@ export function DefaultRequiredValueControl({
isEditing
commitImmediately
mimicMantine
+ placeholder={placeholder}
/>
</div>
)}
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/FieldAliasInput.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/FieldAliasInput.tsx
index 03b026e7bc3..a78dfd7d6e3 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/FieldAliasInput.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/FieldAliasInput.tsx
@@ -33,7 +33,7 @@ export function FieldAliasInput({ tag, onChange }: FieldAliasInputProps) {
<ContainerLabel>
<Group gap="xs">
{t`Table and field alias`}
- <FieldAlisHelpInfo />
+ <FieldAliasHelpInfo />
</Group>
</ContainerLabel>
<TextInputBlurChange
@@ -46,7 +46,7 @@ export function FieldAliasInput({ tag, onChange }: FieldAliasInputProps) {
);
}
-function FieldAlisHelpInfo() {
+function FieldAliasHelpInfo() {
return (
<HoverCard>
<HoverCard.Target>
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx
new file mode 100644
index 00000000000..04e79f7fa4f
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/TableMappingSelect.tsx
@@ -0,0 +1,46 @@
+import { t } from "ttag";
+
+import { SchemaAndTableDataSelector } from "metabase/query_builder/components/DataSelector";
+import { Group } from "metabase/ui";
+import type Database from "metabase-lib/v1/metadata/Database";
+import type { TableId, TemplateTag } from "metabase-types/api";
+
+import { ContainerLabel, ErrorSpan, InputContainer } from "./TagEditorParam";
+
+type TableMappingSelectProps = {
+ tag: TemplateTag;
+ database?: Database | null;
+ databases: Database[];
+ onChange: (tableId: TableId) => void;
+};
+
+export function TableMappingSelect({
+ tag,
+ database,
+ databases,
+ onChange,
+}: TableMappingSelectProps) {
+ const tableId = tag["table-id"];
+ const isEmpty = tableId == null;
+
+ return (
+ <InputContainer>
+ <ContainerLabel>
+ <Group gap="xs">
+ {t`Table to map to`}
+ {isEmpty && <ErrorSpan>{t`(required)`}</ErrorSpan>}
+ </Group>
+ </ContainerLabel>
+ <SchemaAndTableDataSelector
+ databases={databases}
+ selectedDatabase={database || null}
+ selectedDatabaseId={database?.id || null}
+ selectedTable={tableId}
+ selectedTableId={tableId}
+ setSourceTableFn={onChange}
+ isInitiallyOpen={tableId == null}
+ isMantine
+ />
+ </InputContainer>
+ );
+}
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/VariableTypeSelect.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/VariableTypeSelect.tsx
index 8b0796d93ba..0fab5a54542 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/VariableTypeSelect.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/VariableTypeSelect.tsx
@@ -42,6 +42,12 @@ const OPTIONS: Array<{ value: TemplateTagType; label: string }> = [
return t`Time grouping`;
},
},
+ {
+ value: "table",
+ get label() {
+ return t`Table`;
+ },
+ },
];
export function VariableTypeSelect(props: {
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/index.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/index.tsx
index 65c94e41230..685c81ce1b6 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/index.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParamParts/index.tsx
@@ -3,3 +3,4 @@ export { FilterWidgetTypeSelect } from "./FilterWidgetTypeSelect";
export { FieldMappingSelect } from "./FieldMappingSelect";
export { VariableTypeSelect } from "./VariableTypeSelect";
export { FilterWidgetLabelInput } from "./FilterWidgetLabelInput";
+export { TableMappingSelect } from "./TableMappingSelect";
diff --git a/modules/drivers/bigquery-cloud-sdk/src/metabase/driver/bigquery_cloud_sdk.clj b/modules/drivers/bigquery-cloud-sdk/src/metabase/driver/bigquery_cloud_sdk.clj
index 20c470a0d47..e9502835c1c 100644
--- a/modules/drivers/bigquery-cloud-sdk/src/metabase/driver/bigquery_cloud_sdk.clj
+++ b/modules/drivers/bigquery-cloud-sdk/src/metabase/driver/bigquery_cloud_sdk.clj
@@ -1061,12 +1061,13 @@
query :- :metabase.lib.schema/native-only-query]
(let [db-tables (driver-api/tables query)
transforms (t2/select [:model/Transform :id :target])]
- (into #{} (comp
- (map :component)
- (map #(assoc % :table (driver.sql.normalize/normalize-name driver (:table %))))
- (map #(let [parts (str/split (:table %) #"\.")]
- {:schema (first parts) :table (second parts)}))
- (keep #(driver.sql/find-table-or-transform driver db-tables transforms %)))
+ (into (driver-api/native-query-table-references query)
+ (comp
+ (map :component)
+ (map #(assoc % :table (driver.sql.normalize/normalize-name driver (:table %))))
+ (map #(let [parts (str/split (:table %) #"\.")]
+ {:schema (first parts) :table (second parts)}))
+ (keep #(driver.sql/find-table-or-transform driver db-tables transforms %)))
(-> query
driver-api/raw-native-query
(driver.u/parsed-query driver)
diff --git a/src/metabase/driver.clj b/src/metabase/driver.clj
index 7e57347e684..155a90d7672 100644
--- a/src/metabase/driver.clj
+++ b/src/metabase/driver.clj
@@ -904,7 +904,11 @@
:describe-is-generated
;; Does this driver support the workspace feature
- :workspace})
+ :workspace
+
+ ;; Does this driver support table references in native queries -- for example, "select * from {{table}}" where
+ ;; `{{table}}` gets replaced by a reference to a table.
+ :parameters/table-reference})
(defmulti database-supports?
"Does this driver and specific instance of a database support a certain `feature`?
diff --git a/src/metabase/driver/common/parameters.clj b/src/metabase/driver/common/parameters.clj
index 959f0b76165..10f74080711 100644
--- a/src/metabase/driver/common/parameters.clj
+++ b/src/metabase/driver/common/parameters.clj
@@ -58,6 +58,20 @@
[x]
(instance? ReferencedCardQuery x))
+;; A "ReferencedTableQuery" parameter expands to a query selecting from a specific table, potentially with a filter on a
+;; specific column.
+;;
+;; `table-id` is the id of the table being referenced
+(p.types/defrecord+ ReferencedTableQuery [table-id]
+ pretty/PrettyPrintable
+ (pretty [this]
+ (list (pretty/qualify-symbol-for-*ns* `map->ReferencedTableQuery) (into {} this))))
+
+(defn ReferencedTableQuery?
+ "Is `x` an instance of the `ReferencedTableQuery` record type?"
+ [x]
+ (instance? ReferencedTableQuery x))
+
;; A `ReferencedQuerySnippet` expands to the partial query snippet stored in the `NativeQuerySnippet` table in the
;; application DB.
;;
diff --git a/src/metabase/driver/common/parameters/values.clj b/src/metabase/driver/common/parameters/values.clj
index 2b7ca4f245e..41022142e77 100644
--- a/src/metabase/driver/common/parameters/values.clj
+++ b/src/metabase/driver/common/parameters/values.clj
@@ -49,6 +49,7 @@
(def ^:private FieldFilter (lib.schema.common/instance-of-class metabase.driver.common.parameters.FieldFilter))
(def ^:private ReferencedQuerySnippet (lib.schema.common/instance-of-class metabase.driver.common.parameters.ReferencedQuerySnippet))
(def ^:private ReferencedCardQuery (lib.schema.common/instance-of-class metabase.driver.common.parameters.ReferencedCardQuery))
+(def ^:private ReferencedTableQuery (lib.schema.common/instance-of-class metabase.driver.common.parameters.ReferencedTableQuery))
(defmulti ^:private parse-tag
"Parse a tag by its `:type`, returning an appropriate record type such as
@@ -256,6 +257,10 @@
:type qp.error-type/invalid-parameter}
e))))))
+(mu/defmethod parse-tag :table :- ReferencedTableQuery
+ [{:keys [table-id]} _params]
+ (params/map->ReferencedTableQuery {:table-id table-id}))
+
(mu/defmethod parse-tag :snippet :- ReferencedQuerySnippet
[{:keys [snippet-name snippet-id], :as tag} :- ::mbql.s/TemplateTag
_params]
diff --git a/src/metabase/driver/sql.clj b/src/metabase/driver/sql.clj
index a962c4a1d29..990008aace7 100644
--- a/src/metabase/driver/sql.clj
+++ b/src/metabase/driver/sql.clj
@@ -52,7 +52,8 @@
:expressions/today
:distinct-where
:database-routing
- :dependencies/native]]
+ :dependencies/native
+ :parameters/table-reference]]
(defmethod driver/database-supports? [:sql feature] [_driver _feature _db] true))
(defmethod driver/database-supports? [:sql :persist-models-enabled]
@@ -269,8 +270,9 @@
query :- :metabase.lib.schema/native-only-query]
(let [db-tables (driver-api/tables query)
db-transforms (driver-api/transforms query)]
- (into #{} (keep #(find-table-or-transform driver db-tables db-transforms %)
- (parsed-table-refs driver query)))))
+ (into (driver-api/native-query-table-references query)
+ (keep #(find-table-or-transform driver db-tables db-transforms %)
+ (parsed-table-refs driver query)))))
;;; +----------------------------------------------------------------------------------------------------------------+
;;; | Dependencies |
diff --git a/src/metabase/driver/sql/parameters/substitute.clj b/src/metabase/driver/sql/parameters/substitute.clj
index 71ff69c7a7b..b879c3a119a 100644
--- a/src/metabase/driver/sql/parameters/substitute.clj
+++ b/src/metabase/driver/sql/parameters/substitute.clj
@@ -23,7 +23,7 @@
(sql.params.substitution/->replacement-snippet-info driver/*driver* v)]
[(str sql replacement-snippet) (concat args prepared-statement-args) missing])))
-(defn- substitute-card-query [[sql args missing] v]
+(defn- substitute-simple-query [[sql args missing] v]
(let [{:keys [replacement-snippet prepared-statement-args]}
(sql.params.substitution/->replacement-snippet-info driver/*driver* v)]
[(str sql replacement-snippet) (concat args prepared-statement-args) missing]))
@@ -44,8 +44,9 @@
(params/TemporalUnit? v))
(substitute-field-param [sql args missing] in-optional? k v)
- (params/ReferencedCardQuery? v)
- (substitute-card-query [sql args missing] v)
+ (or (params/ReferencedCardQuery? v)
+ (params/ReferencedTableQuery? v))
+ (substitute-simple-query [sql args missing] v)
(params/ReferencedQuerySnippet? v)
(substitute-native-query-snippet param->value [sql args missing] in-optional? v)
diff --git a/src/metabase/driver/sql/parameters/substitution.clj b/src/metabase/driver/sql/parameters/substitution.clj
index 090fb97ee58..3dc0d2c78c0 100644
--- a/src/metabase/driver/sql/parameters/substitution.clj
+++ b/src/metabase/driver/sql/parameters/substitution.clj
@@ -30,6 +30,7 @@
DateTimeRange
FieldFilter
ReferencedCardQuery
+ ReferencedTableQuery
ReferencedQuerySnippet
TemporalUnit)))
@@ -408,3 +409,13 @@
(field->clause field (when (not= value params/no-value)
{:temporal-unit (keyword value)}))))]
(replace-alias driver field alias replacement-snippet-info)))
+
+(defmethod ->replacement-snippet-info [:sql ReferencedTableQuery]
+ [driver {:keys [table-id]}]
+ (let [mp (driver-api/metadata-provider)
+ alias (->> (driver-api/table mp table-id)
+ (sql.qp/->honeysql driver)
+ (sql.qp/format-honeysql driver)
+ first)]
+ {:prepared-statement-args []
+ :replacement-snippet alias}))
diff --git a/src/metabase/driver_api/core.clj b/src/metabase/driver_api/core.clj
index c51754fa646..24f960362db 100644
--- a/src/metabase/driver_api/core.clj
+++ b/src/metabase/driver_api/core.clj
@@ -115,6 +115,7 @@
lib/match-and-normalize-tag-name
lib/missing-column-error
lib/missing-table-alias-error
+ lib/native-query-table-references
lib/normalize
lib/order-by-clause
lib/query-from-legacy-inner-query
diff --git a/src/metabase/legacy_mbql/schema.cljc b/src/metabase/legacy_mbql/schema.cljc
index d6824dff81d..55178b6b26d 100644
--- a/src/metabase/legacy_mbql/schema.cljc
+++ b/src/metabase/legacy_mbql/schema.cljc
@@ -1489,7 +1489,7 @@
(mr/def ::TemplateTagType
"Schema for valid values of template tag `:type`."
- [:enum {:decode/normalize keyword} :snippet :card :dimension :number :text :date])
+ [:enum {:decode/normalize keyword} :snippet :card :dimension :number :text :date :table])
(mr/def ::TemplateTag.Common
"Things required by all template tag types."
@@ -1536,6 +1536,21 @@
[:type [:= {:decode/normalize helpers/normalize-keyword} :card]]
[:card-id ::lib.schema.id/card]]])
+;; Example:
+;;
+;; {:id "fc5e14d9-7d14-67af-66b2-b2a6e25afeaf"
+;; :name "#1635"
+;; :display-name "#1635"
+;; :type :table
+;; :table-id 2}
+(mr/def ::TemplateTag.SourceTable
+ "Schema for a source query template tag."
+ [:merge
+ ::TemplateTag.Common
+ [:map
+ [:type [:= {:decode/normalize helpers/normalize-keyword} :table]]
+ [:table-id ::lib.schema.id/table]]])
+
(mr/def ::TemplateTag.Value.Common
"Stuff shared between the Field filter and raw value template tag schemas."
[:merge
@@ -1656,6 +1671,7 @@
[:dimension [:ref ::TemplateTag.FieldFilter]]
[:snippet [:ref ::TemplateTag.Snippet]]
[:card [:ref ::TemplateTag.SourceQuery]]
+ [:table [:ref ::TemplateTag.SourceTable]]
[:temporal-unit [:ref ::TemplateTag.TemporalUnit]]
[::mc/default [:ref ::TemplateTag.RawValue]]])
diff --git a/src/metabase/lib/core.cljc b/src/metabase/lib/core.cljc
index 6c5fab9c2a5..ee691e5cd2f 100644
--- a/src/metabase/lib/core.cljc
+++ b/src/metabase/lib/core.cljc
@@ -387,6 +387,7 @@
required-native-extras
native-query-card-ids
native-query-snippet-ids
+ native-query-table-references
template-tags-referenced-cards
template-tags
with-different-database
diff --git a/src/metabase/lib/native.cljc b/src/metabase/lib/native.cljc
index 401d855311c..7f03f21193f 100644
--- a/src/metabase/lib/native.cljc
+++ b/src/metabase/lib/native.cljc
@@ -314,7 +314,7 @@
(mu/defn- validate-template-tag :- [:sequential [:map [:error/message :string] [:tag-name :string]]]
"Validate a single template tag, returning a list of errors."
- [_query {tag-type :type tag-name :name, :keys [display-name dimension]}]
+ [_query {tag-type :type tag-name :name, :keys [display-name dimension table-id]}]
(cond-> []
(empty? display-name)
(conj {:error/message (i18n/tru "Missing widget label: {0}" tag-name)
@@ -322,6 +322,10 @@
(and (#{:dimension :temporal-unit} tag-type) (nil? dimension))
(conj {:error/message (i18n/tru "The variable \"{0}\" needs to be mapped to a field." tag-name)
+ :tag-name tag-name})
+
+ (and (#{:table} tag-type) (nil? table-id))
+ (conj {:error/message (i18n/tru "The variable \"{0}\" needs to be mapped to a table." tag-name)
:tag-name tag-name})))
(mu/defn validate-template-tags :- [:sequential [:map [:error/message :string] [:tag-name :string]]]
@@ -451,3 +455,13 @@
(if (and template-tags-map raw-native-query-string)
(boolean (fully-parameterized-text? raw-native-query-string template-tags-map))
true)))
+
+(mu/defn native-query-table-references :- [:set [:map [:table ::lib.schema.id/table]]]
+ "Given a native query, find any table tags and convert them to {:table id} objects"
+ [query]
+ (let [tags (->> (lib.walk.util/all-template-tags query)
+ (filter #(= (:type %) :table)))]
+ (into #{}
+ (map (fn [{:keys [table-id]}]
+ {:table table-id}))
+ tags)))
diff --git a/src/metabase/lib/schema/template_tag.cljc b/src/metabase/lib/schema/template_tag.cljc
index 9a372c0fc15..198a982b102 100644
--- a/src/metabase/lib/schema/template_tag.cljc
+++ b/src/metabase/lib/schema/template_tag.cljc
@@ -16,7 +16,7 @@
"Schema for valid values of template tag `:type`."
[:enum
{:decode/normalize common/normalize-keyword}
- :snippet :card :dimension :number :text :date :boolean :temporal-unit])
+ :snippet :card :dimension :number :text :date :boolean :temporal-unit :table])
(mr/def ::name
[:ref
@@ -128,6 +128,22 @@
[:card-id ::id/card]]]
[:ref ::disallow-dimension]])
+;; Example:
+;;
+;; {:id "fc5e14d9-7d14-67af-66b2-b2a6e25afeaf"
+;; :name "orders"
+;; :display-name "Orders"
+;; :type :table
+;; :table-id 2}
+(mr/def ::source-table
+ [:and
+ [:merge
+ [:ref ::common]
+ [:map
+ [:type [:= :table]]
+ [:table-id ::id/table]]]
+ [:ref ::disallow-dimension]])
+
(def raw-value-template-tag-types
"Set of valid values of `:type` for raw value template tags."
#{:number :text :date :boolean})
@@ -164,6 +180,7 @@
[:dimension [:ref ::field-filter]]
[:snippet [:ref ::snippet]]
[:card [:ref ::source-query]]
+ [:table [:ref ::source-table]]
;; :number, :text, :date
[::mc/default [:ref ::raw-value]]]])
diff --git a/src/metabase/query_processor/middleware/add_remaps.clj b/src/metabase/query_processor/middleware/add_remaps.clj
index b804c286b88..ddbe7b1a19d 100644
--- a/src/metabase/query_processor/middleware/add_remaps.clj
+++ b/src/metabase/query_processor/middleware/add_remaps.clj
@@ -628,3 +628,8 @@
internal-cols-info (internal-columns-info mlv2-cols)
metadata (add-remapped-to-and-from-metadata metadata external-remaps internal-cols-info)]
(remap-results-xform internal-cols-info (rff metadata))))))
+
+(defn disable-remaps
+ "Sets the value of the disable-remaps? option in this query."
+ [query]
+ (assoc-in query [:middleware :disable-remaps?] true))
diff --git a/src/metabase/transforms/util.clj b/src/metabase/transforms/util.clj
index 5afaad54ba6..548a845d562 100644
--- a/src/metabase/transforms/util.clj
+++ b/src/metabase/transforms/util.clj
@@ -19,6 +19,7 @@
[metabase.models.transforms.transform-run :as transform-run]
[metabase.query-processor :as qp]
[metabase.query-processor.compile :as qp.compile]
+ [metabase.query-processor.middleware.add-remaps :as remap]
[metabase.query-processor.parameters.dates :as params.dates]
[metabase.query-processor.pipeline :as qp.pipeline]
[metabase.sync.core :as sync]
@@ -271,7 +272,7 @@
(defn massage-sql-query
"Adjusts mbql query for use in a transform."
[query]
- (assoc-in query [:middleware :disable-remaps?] true))
+ (remap/disable-remaps query))
(defn- checkpoint-incremental?
"Returns true if `source` uses checkpoint-based incremental strategy."
diff --git a/test/metabase/driver/native_parsing_test.clj b/test/metabase/driver/native_parsing_test.clj
new file mode 100644
index 00000000000..53d24a2b621
--- /dev/null
+++ b/test/metabase/driver/native_parsing_test.clj
@@ -0,0 +1,21 @@
+(ns ^:mb/driver-tests metabase.driver.native-parsing-test
+ (:require
+ [clojure.test :refer :all]
+ [metabase.driver :as driver]
+ [metabase.lib.core :as lib]
+ [metabase.test :as mt]))
+
+(deftest ^:parallel can-get-deps-from-table-tags
+ (mt/test-drivers (mt/normal-drivers-with-feature :parameters/table-reference)
+ (testing "native-query-deps looks in table tags for dependencies"
+ (let [mp (mt/metadata-provider)
+ sql (mt/native-query-with-card-template-tag driver/*driver* "table")
+ base-query (lib/native-query mp sql)
+ template-tag (get (lib/template-tags base-query) "table")
+ query (lib/with-template-tags base-query
+ {"table" (merge template-tag
+ {:type :table
+ :table-id (mt/id :orders)})})]
+ ;; by not preprocessing the query, the query itself is unparseable and we need to rely on the table tag
+ (is (= #{{:table (mt/id :orders)}}
+ (driver/native-query-deps driver/*driver* query)))))))
diff --git a/test/metabase/lib/native_test.cljc b/test/metabase/lib/native_test.cljc
index 3e01d00c5be..f4fc4e7283e 100644
--- a/test/metabase/lib/native_test.cljc
+++ b/test/metabase/lib/native_test.cljc
@@ -645,3 +645,15 @@
{"mytag" {:type :dimension
:name "mytag"
:id "9ae1ea5e-ac33-4574-bc95-ff595b0ac1a7"}}))))
+
+(defn- table-tag-query [mp template-tag-overrides]
+ (let [base-query (lib.native/native-query mp "select * from {{table}}")
+ template-tag (get (lib.native/template-tags base-query) "table")]
+ (lib.native/with-template-tags base-query
+ {"table" (merge template-tag {:type :table} template-tag-overrides)})))
+
+(deftest ^:parallel basic-native-query-table-references-test
+ (testing "should find id-based native query table references"
+ (is (= #{{:table (meta/id :orders)}}
+ (lib.native/native-query-table-references
+ (table-tag-query meta/metadata-provider {:table-id (meta/id :orders)}))))))
diff --git a/test/metabase/query_processor/parameters_test.clj b/test/metabase/query_processor/parameters_test.clj
index 1232a573f0d..9c84172d2d5 100644
--- a/test/metabase/query_processor/parameters_test.clj
+++ b/test/metabase/query_processor/parameters_test.clj
@@ -775,3 +775,26 @@
(is (= [[1 2.07]
[212 2.07]]
(mt/formatted-rows [int 2.0] (qp/process-query query)))))))
+
+(defn- query-result-ids [query]
+ (into #{}
+ (map first)
+ (mt/formatted-rows [int] (qp/process-query query))))
+
+(defn- assert-table-param-query-selects-ids
+ [mp ids template-tag-overrides]
+ (let [sql (mt/native-query-with-card-template-tag driver/*driver* "table")
+ base-query (lib/native-query mp sql)
+ template-tag (get (lib/template-tags base-query) "table")
+ query (lib/with-template-tags base-query
+ {"table" (merge template-tag {:type :table} template-tag-overrides)})]
+ (is (= (set ids) (query-result-ids query)))))
+
+(deftest ^:parallel basic-table-template-tag-test
+ (mt/test-drivers (mt/normal-drivers-with-feature :parameters/table-reference)
+ (testing "can run queries with basic table template tags"
+ (let [mp (mt/metadata-provider)]
+ (assert-table-param-query-selects-ids
+ mp
+ (query-result-ids (lib/query mp (lib.metadata/table mp (mt/id :products))))
+ {:table-id (mt/id :products)})))))