Skip to content

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

Convert DataModel queries to MBQL lib (#64633)

Alexander Polyankin9fd8200087f9
diff --git a/e2e/test/scenarios/visualizations-tabular/object_detail.cy.spec.js b/e2e/test/scenarios/visualizations-tabular/object_detail.cy.spec.js
index 2e494fff85e..4243e0ca5e4 100644
--- a/e2e/test/scenarios/visualizations-tabular/object_detail.cy.spec.js
+++ b/e2e/test/scenarios/visualizations-tabular/object_detail.cy.spec.js
@@ -287,24 +287,6 @@ describe("scenarios > question > object details", { tags: "@slow" }, () => {
.should("be.visible");
});
- it("should fetch linked entities data only once per entity type when reopening the modal (metabase#32720)", () => {
- cy.intercept("POST", "/api/dataset", cy.spy().as("fetchDataset"));
-
- H.openProductsTable();
- cy.get("@fetchDataset").should("have.callCount", 1);
-
- drillPK({ id: 5 });
- cy.get("@fetchDataset").should("have.callCount", 3);
-
- cy.findByLabelText("Close").click();
-
- drillPK({ id: 5 });
- cy.get("@fetchDataset").should("have.callCount", 3);
-
- cy.wait(100);
- cy.get("@fetchDataset").should("have.callCount", 3);
- });
-
it("should not offer drill-through on the object detail records (metabase#20560)", () => {
H.openPeopleTable({ limit: 2 });
diff --git a/frontend/src/metabase-lib/metadata.ts b/frontend/src/metabase-lib/metadata.ts
index 7f756703c3f..03fdeb642ca 100644
--- a/frontend/src/metabase-lib/metadata.ts
+++ b/frontend/src/metabase-lib/metadata.ts
@@ -5,6 +5,7 @@ import type {
CardType,
DatabaseId,
DatasetColumn,
+ FieldId,
TableId,
} from "metabase-types/api";
@@ -170,6 +171,13 @@ export function tableOrCardMetadata(
return ML.table_or_card_metadata(queryOrMetadataProvider, tableID);
}
+export function fieldMetadata(
+ queryOrMetadataProvider: Query | MetadataProvider,
+ fieldID: FieldId,
+): ColumnMetadata | null {
+ return ML.field_metadata(queryOrMetadataProvider, fieldID);
+}
+
export function visibleColumns(
query: Query,
stageIndex: number,
diff --git a/frontend/src/metabase/api/table.ts b/frontend/src/metabase/api/table.ts
index a09f433cf57..f875a2a8242 100644
--- a/frontend/src/metabase/api/table.ts
+++ b/frontend/src/metabase/api/table.ts
@@ -1,5 +1,5 @@
import { updateMetadata } from "metabase/lib/redux/metadata";
-import { TableSchema } from "metabase/schema";
+import { ForeignKeySchema, TableSchema } from "metabase/schema";
import type {
ForeignKey,
GetTableDataRequest,
@@ -74,6 +74,10 @@ export const tableApi = Api.injectEndpoints({
url: `/api/table/${id}/fks`,
}),
providesTags: [listTag("field")],
+ onQueryStarted: (_, { queryFulfilled, dispatch }) =>
+ handleQueryFulfilled(queryFulfilled, (data) =>
+ dispatch(updateMetadata(data, [ForeignKeySchema])),
+ ),
}),
updateTable: builder.mutation<Table, UpdateTableRequest>({
query: ({ id, ...body }) => ({
diff --git a/frontend/src/metabase/detail-view/components/DetailViewPage/DetailViewPage.tsx b/frontend/src/metabase/detail-view/components/DetailViewPage/DetailViewPage.tsx
index 465156cf174..10c8b56d54f 100644
--- a/frontend/src/metabase/detail-view/components/DetailViewPage/DetailViewPage.tsx
+++ b/frontend/src/metabase/detail-view/components/DetailViewPage/DetailViewPage.tsx
@@ -116,11 +116,8 @@ export function DetailViewPage({
w={isMediumBreakpoint ? "100%" : rem(440)}
>
<Relationships
- columns={columns}
- row={row}
rowId={rowId}
rowName={rowName}
- table={table}
tableForeignKeys={tableForeignKeys}
/>
</Box>
diff --git a/frontend/src/metabase/detail-view/components/DetailViewSidesheet/DetailViewSidesheet.tsx b/frontend/src/metabase/detail-view/components/DetailViewSidesheet/DetailViewSidesheet.tsx
index d8d6c6020f3..bda95ba9546 100644
--- a/frontend/src/metabase/detail-view/components/DetailViewSidesheet/DetailViewSidesheet.tsx
+++ b/frontend/src/metabase/detail-view/components/DetailViewSidesheet/DetailViewSidesheet.tsx
@@ -372,11 +372,8 @@ export function DetailViewSidesheet({
py={rem(48)}
>
<Relationships
- columns={columns}
- row={row}
rowId={rowId}
rowName={rowName}
- table={table}
tableForeignKeys={tableForeignKeys}
onClick={onClose}
/>
diff --git a/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.tsx b/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.tsx
index a1100977238..40153beed59 100644
--- a/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.tsx
+++ b/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.tsx
@@ -2,50 +2,51 @@ import cx from "classnames";
import { inflect } from "inflection";
import { useMemo } from "react";
import { Link } from "react-router";
+import { useLatest } from "react-use";
import { t } from "ttag";
import { skipToken, useGetAdhocQueryQuery } from "metabase/api";
+import { useSelector } from "metabase/lib/redux";
+import { getMetadata } from "metabase/selectors/metadata";
import { Loader, Stack, Text, rem } from "metabase/ui";
-import { isNumeric, isPK } from "metabase-lib/v1/types/utils/isa";
-import type { ForeignKey, Table } from "metabase-types/api";
+import * as Lib from "metabase-lib";
+import type { ForeignKey } from "metabase-types/api";
import S from "./Relationship.module.css";
+import {
+ getForeignKeyCountQuery,
+ getForeignKeyQuery,
+ getForeignKeyQuestionUrl,
+} from "./utils";
interface Props {
fk: ForeignKey;
- href: string | undefined;
rowId: string | number;
- table: Table;
onClick?: () => void;
}
-export const Relationship = ({ fk, href, rowId, table, onClick }: Props) => {
- const pk = (table.fields ?? []).find(isPK);
- const fkOriginId =
- fk.origin && typeof fk.origin.id == "number" ? fk.origin.id : undefined;
+export const Relationship = ({ fk, rowId, onClick }: Props) => {
+ const metadata = useSelector(getMetadata);
+ const metadataRef = useLatest(metadata);
+ const fkQuery = useMemo(
+ () => getForeignKeyQuery(fk, rowId, metadataRef.current),
+ [fk, rowId, metadataRef],
+ );
+ const fkCountQuery = useMemo(
+ () => (fkQuery != null ? getForeignKeyCountQuery(fkQuery) : undefined),
+ [fkQuery],
+ );
+ const fkQuestionUrl = useMemo(
+ () => (fkQuery != null ? getForeignKeyQuestionUrl(fkQuery) : undefined),
+ [fkQuery],
+ );
const {
data: dataset,
error,
isFetching,
} = useGetAdhocQueryQuery(
- fk.origin != null && fkOriginId != null
- ? {
- type: "query",
- query: {
- "source-table": fk.origin?.table_id,
- filter: [
- "=",
- ["field", fkOriginId, null],
- isNumeric(pk) && typeof rowId === "string"
- ? parseFloat(rowId)
- : rowId,
- ],
- aggregation: [["count"]],
- },
- database: fk.origin.table?.db_id ?? table.db_id,
- }
- : skipToken,
+ fkCountQuery != null ? Lib.toJsQuery(fkCountQuery) : skipToken,
);
const count = useMemo(() => {
@@ -68,7 +69,9 @@ export const Relationship = ({ fk, href, rowId, table, onClick }: Props) => {
[S.clickable]: clickable,
})}
gap={rem(12)}
- {...(clickable ? { component: Link, to: href, onClick } : undefined)}
+ {...(clickable
+ ? { component: Link, to: fkQuestionUrl, onClick }
+ : undefined)}
>
{isFetching && <Loader data-testid="loading-indicator" size="md" />}
diff --git a/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.unit.spec.tsx b/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.unit.spec.tsx
index b3d63493b87..1ecc200ad11 100644
--- a/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.unit.spec.tsx
+++ b/frontend/src/metabase/detail-view/components/Relationships/Relationship/Relationship.unit.spec.tsx
@@ -4,6 +4,7 @@ import fetchMock from "fetch-mock";
import { Route } from "react-router";
import { setupCardDataset } from "__support__/server-mocks";
+import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, waitForLoaderToBeRemoved } from "__support__/ui";
import type { Table } from "metabase-types/api";
import { createMockForeignKey } from "metabase-types/api/mocks";
@@ -16,7 +17,9 @@ import {
PRODUCTS,
createOrdersProductIdField,
createOrdersTable,
+ createSampleDatabase,
} from "metabase-types/api/mocks/presets";
+import { createMockState } from "metabase-types/store/mocks";
import { Relationship } from "./Relationship";
@@ -51,23 +54,22 @@ interface SetupOpts {
table?: Table;
}
-function setup({ dataset = DATASET, table = ORDERS_TABLE }: SetupOpts = {}) {
+function setup({ dataset = DATASET }: SetupOpts = {}) {
const onClick = jest.fn();
const TestComponent = () => (
- <Relationship
- fk={FK}
- href="/test"
- rowId={ROW_ID}
- table={table}
- onClick={onClick}
- />
+ <Relationship fk={FK} rowId={ROW_ID} onClick={onClick} />
);
setupCardDataset(dataset);
renderWithProviders(<Route path="/" component={TestComponent} />, {
withRouter: true,
+ storeInitialState: createMockState({
+ entities: createMockEntitiesState({
+ databases: [createSampleDatabase()],
+ }),
+ }),
});
return { onClick };
diff --git a/frontend/src/metabase/detail-view/components/Relationships/Relationship/utils.ts b/frontend/src/metabase/detail-view/components/Relationships/Relationship/utils.ts
new file mode 100644
index 00000000000..14e44670b24
--- /dev/null
+++ b/frontend/src/metabase/detail-view/components/Relationships/Relationship/utils.ts
@@ -0,0 +1,89 @@
+import { parseNumber } from "metabase/lib/number";
+import * as Urls from "metabase/lib/urls";
+import * as Lib from "metabase-lib";
+import Question from "metabase-lib/v1/Question";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
+import type { ForeignKey, RowValue } from "metabase-types/api";
+
+const STAGE_INDEX = 0;
+
+function getForeignKeyFilterClause(field: Lib.ColumnMetadata, rowId: RowValue) {
+ if (Lib.isStringOrStringLike(field) && typeof rowId === "string") {
+ return Lib.stringFilterClause({
+ operator: "=",
+ column: field,
+ values: [rowId],
+ options: {},
+ });
+ }
+
+ if (Lib.isNumeric(field) && typeof rowId === "string") {
+ const number = parseNumber(rowId);
+ if (number != null) {
+ return Lib.numberFilterClause({
+ operator: "=",
+ column: field,
+ values: [number],
+ });
+ }
+ }
+
+ if (Lib.isNumeric(field) && typeof rowId === "number") {
+ return Lib.numberFilterClause({
+ operator: "=",
+ column: field,
+ values: [rowId],
+ });
+ }
+
+ if (Lib.isBoolean(field) && typeof rowId === "boolean") {
+ return Lib.booleanFilterClause({
+ operator: "=",
+ column: field,
+ values: [rowId],
+ });
+ }
+}
+
+export function getForeignKeyQuery(
+ fk: ForeignKey,
+ rowId: RowValue,
+ metadata: Metadata,
+) {
+ if (fk.origin == null || fk.origin.table == null) {
+ return;
+ }
+
+ const metadataProvider = Lib.metadataProvider(
+ fk.origin.table.db_id,
+ metadata,
+ );
+ const table = Lib.tableOrCardMetadata(metadataProvider, fk.origin.table_id);
+ const field = Lib.fieldMetadata(metadataProvider, fk.origin_id);
+ if (table == null || field == null) {
+ return;
+ }
+
+ const filter = getForeignKeyFilterClause(field, rowId);
+ if (filter == null) {
+ return;
+ }
+
+ return Lib.filter(
+ Lib.queryFromTableOrCardMetadata(metadataProvider, table),
+ STAGE_INDEX,
+ filter,
+ );
+}
+
+export function getForeignKeyCountQuery(fkQuery: Lib.Query) {
+ return Lib.aggregateByCount(fkQuery, STAGE_INDEX);
+}
+
+export const getForeignKeyQuestionUrl = (query: Lib.Query): string => {
+ const question = Question.create({
+ dataset_query: Lib.toJsQuery(query),
+ });
+
+ return Urls.question(question.card(), { hash: question.card() });
+};
diff --git a/frontend/src/metabase/detail-view/components/Relationships/Relationships.tsx b/frontend/src/metabase/detail-view/components/Relationships/Relationships.tsx
index 07536719370..a706b2adfa0 100644
--- a/frontend/src/metabase/detail-view/components/Relationships/Relationships.tsx
+++ b/frontend/src/metabase/detail-view/components/Relationships/Relationships.tsx
@@ -2,36 +2,24 @@ import { type ReactNode, useMemo } from "react";
import { jt, t } from "ttag";
import { type BoxProps, Stack, Text } from "metabase/ui";
-import type {
- DatasetColumn,
- ForeignKey,
- RowValues,
- Table,
-} from "metabase-types/api";
+import type { ForeignKey } from "metabase-types/api";
import { Relationship } from "./Relationship";
-import { getUrl } from "./utils";
interface Props {
- columns: DatasetColumn[];
- row: RowValues;
rowId: string | number;
rowName: ReactNode;
- table: Table;
tableForeignKeys: ForeignKey[];
onClick?: () => void;
}
export function Relationships({
- columns,
- row,
rowId,
rowName,
- table,
tableForeignKeys,
onClick,
}: Props & BoxProps): JSX.Element | null {
- const sortedForeignTables = useMemo(
+ const sortedForeignKeys = useMemo(
() =>
tableForeignKeys.toSorted((a, b) => {
const aDisplayName = a.origin?.table?.display_name ?? "";
@@ -58,14 +46,12 @@ export function Relationships({
</Text>
<Stack gap="md">
- {sortedForeignTables.map((fk) => {
+ {sortedForeignKeys.map((fk) => {
return (
<Relationship
key={`${fk.origin_id}-${fk.destination_id}`}
fk={fk}
- href={getUrl({ columns, row, table, fk })}
rowId={rowId}
- table={table}
onClick={onClick}
/>
);
diff --git a/frontend/src/metabase/detail-view/components/Relationships/utils.ts b/frontend/src/metabase/detail-view/components/Relationships/utils.ts
deleted file mode 100644
index d5c5fade0d7..00000000000
--- a/frontend/src/metabase/detail-view/components/Relationships/utils.ts
+++ /dev/null
@@ -1,51 +0,0 @@
-import { question } from "metabase/lib/urls";
-import { isPK } from "metabase-lib/v1/types/utils/isa";
-import type {
- DatasetColumn,
- ForeignKey,
- RowValues,
- Table,
-} from "metabase-types/api";
-
-export const getUrl = ({
- columns,
- row,
- table,
- fk,
-}: {
- columns: DatasetColumn[];
- fk: ForeignKey;
- row: RowValues;
- table: Table;
-}): string | undefined => {
- const pkIndex = columns.findIndex(isPK);
-
- if (pkIndex === -1) {
- return undefined;
- }
-
- const objectId = row[pkIndex];
-
- if (objectId == null) {
- return undefined;
- }
-
- if (fk.origin?.table_id) {
- const card = {
- type: "question" as const,
- dataset_query: {
- type: "query" as const,
- query: {
- "source-table": fk.origin.table_id,
- filter: ["=", ["field", fk.origin.id, null], objectId],
- },
- database: fk.origin.table?.db_id || table.db_id,
- },
- };
-
- const questionUrl = question(card, { hash: card as any });
- return questionUrl;
- }
-
- return undefined;
-};
diff --git a/frontend/src/metabase/metadata/.eslintrc b/frontend/src/metabase/metadata/.eslintrc
index 571ee33de34..4bed1e7be77 100644
--- a/frontend/src/metabase/metadata/.eslintrc
+++ b/frontend/src/metabase/metadata/.eslintrc
@@ -13,8 +13,6 @@
"/embedding-sdk-package",
"/embedding-sdk-bundle",
"/embedding-sdk-shared",
- "metabase-lib/v1/metadata",
- "metabase-lib/v1/metadata/*",
"metabase/entities",
"metabase/entities/*",
],
diff --git a/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/ObjectDetailPreview.tsx b/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/ObjectDetailPreview.tsx
index 75ef4a4bdc9..c50f5641c05 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/ObjectDetailPreview.tsx
+++ b/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/ObjectDetailPreview.tsx
@@ -1,21 +1,22 @@
-import { memo, useMemo } from "react";
+import { memo, useMemo, useRef } from "react";
import { t } from "ttag";
-import { useGetAdhocQueryQuery } from "metabase/api";
+import { skipToken, useGetAdhocQueryQuery } from "metabase/api";
import { getErrorMessage } from "metabase/api/utils";
import EmptyState from "metabase/common/components/EmptyState";
import { DetailsGroup, Header } from "metabase/detail-view/components";
import { getEntityIcon, getHeaderColumns } from "metabase/detail-view/utils";
+import { useSelector } from "metabase/lib/redux";
+import { getMetadataUnfiltered } from "metabase/selectors/metadata";
import { Box, Repeat, Skeleton, Stack, rem } from "metabase/ui";
import { extractRemappedColumns } from "metabase/visualizations";
+import * as Lib from "metabase-lib";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type {
DatabaseId,
DatasetColumn,
- DatasetQuery,
Field,
- FieldFilter,
FieldId,
- FieldReference,
RawSeries,
RowValues,
TableId,
@@ -101,25 +102,50 @@ const ObjectDetailPreviewBase = ({
);
};
+function getDataSampleQuery(
+ metadata: Metadata,
+ databaseId: DatabaseId,
+ tableId: TableId,
+ fieldId: FieldId,
+) {
+ const metadataProvider = Lib.metadataProvider(databaseId, metadata);
+ const table = Lib.tableOrCardMetadata(metadataProvider, tableId);
+ const field = Lib.fieldMetadata(metadataProvider, fieldId);
+ if (table == null || field == null) {
+ return;
+ }
+
+ const tableQuery = Lib.queryFromTableOrCardMetadata(metadataProvider, table);
+ const stageIndex = 0;
+ return Lib.filter(
+ tableQuery,
+ stageIndex,
+ Lib.defaultFilterClause({
+ operator: "not-null",
+ column: field,
+ }),
+ );
+}
+
function useDataSample({ databaseId, field, fieldId, tableId }: Props) {
- const reference: FieldReference = ["field", fieldId, null];
- const filter: FieldFilter = ["not-null", reference];
-
- const datasetQuery: DatasetQuery = {
- type: "query" as const,
- database: databaseId,
- query: {
- "source-table": tableId,
- filter,
- limit: 1,
- },
- };
+ // do not generate a new query when metadata changes
+ const metadata = useSelector(getMetadataUnfiltered);
+ const metadataRef = useRef(metadata);
+ metadataRef.current = metadata;
+ const query = useMemo(
+ () => getDataSampleQuery(metadataRef.current, databaseId, tableId, fieldId),
+ [databaseId, tableId, fieldId],
+ );
- const { data, ...rest } = useGetAdhocQueryQuery({
- ...datasetQuery,
- ignore_error: true,
- _refetchDeps: field,
- });
+ const { data, ...rest } = useGetAdhocQueryQuery(
+ query
+ ? {
+ ...Lib.toJsQuery(query),
+ ignore_error: true,
+ _refetchDeps: field,
+ }
+ : skipToken,
+ );
const base = {
...rest,
@@ -144,14 +170,14 @@ function useDataSample({ databaseId, field, fieldId, tableId }: Props) {
};
}
- if (!data?.data) {
+ if (data?.data == null || query == null) {
return base;
}
const rawSeries: RawSeries = [
{
card: createMockCard({
- dataset_query: datasetQuery,
+ dataset_query: Lib.toJsQuery(query),
display: "object",
visualization_settings: {},
}),
diff --git a/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/PreviewSection.tsx b/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/PreviewSection.tsx
index 243412ea2ff..c87d986ca14 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/PreviewSection.tsx
+++ b/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/PreviewSection.tsx
@@ -51,7 +51,10 @@ const PreviewSectionBase = ({
onPreviewTypeChange,
}: Props) => {
const data = useMemo(() => getPreviewTypeData(), []);
- const pkFields = table.fields?.filter((field) => isPK(field)) ?? [];
+ const pkFields = useMemo(
+ () => table.fields?.filter((field) => isPK(field)) ?? [],
+ [table.fields],
+ );
return (
<Card
diff --git a/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/TablePreview.tsx b/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/TablePreview.tsx
index 73e1dfddce4..60dd80bdc08 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/TablePreview.tsx
+++ b/frontend/src/metabase/metadata/pages/DataModel/components/PreviewSection/TablePreview.tsx
@@ -1,20 +1,20 @@
-import { memo } from "react";
+import { memo, useMemo, useRef } from "react";
import { t } from "ttag";
import _ from "underscore";
import { skipToken, useGetAdhocQueryQuery } from "metabase/api";
import { getErrorMessage } from "metabase/api/utils";
import EmptyState from "metabase/common/components/EmptyState";
-import { getRawTableFieldId } from "metabase/metadata/utils/field";
+import { useSelector } from "metabase/lib/redux";
+import { getMetadataUnfiltered } from "metabase/selectors/metadata";
import { Repeat, Skeleton, Stack } from "metabase/ui";
import Visualization from "metabase/visualizations/components/Visualization";
+import * as Lib from "metabase-lib";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type {
DatabaseId,
- DatasetQuery,
Field,
- FieldFilter,
FieldId,
- FieldReference,
RawSeries,
TableId,
} from "metabase-types/api";
@@ -84,13 +84,27 @@ function useDataSample({
pkFields,
tableId,
}: Props) {
- const datasetQuery = getPreviewQuery(databaseId, tableId, fieldId, pkFields);
+ // do not generate a new query when metadata changes
+ const metadata = useSelector(getMetadataUnfiltered);
+ const metadataRef = useRef(metadata);
+ metadataRef.current = metadata;
+ const query = useMemo(
+ () =>
+ getPreviewQuery(
+ metadataRef.current,
+ databaseId,
+ tableId,
+ fieldId,
+ pkFields,
+ ),
+ [databaseId, tableId, fieldId, pkFields],
+ );
const { data, refetch, ...rest } = useGetAdhocQueryQuery(
- isFieldHidden(field)
+ query == null || isFieldHidden(field)
? skipToken
: {
- ...datasetQuery,
+ ...Lib.toJsQuery(query),
ignore_error: true,
_refetchDeps: field,
},
@@ -113,14 +127,14 @@ function useDataSample({
return { ...base, isError: true, error: getDataErrorMessage(data) };
}
- if (!data?.data || data.data.cols.length === 0) {
+ if (query == null || !data?.data || data.data.cols.length === 0) {
return base;
}
const rawSeries: RawSeries = [
{
card: createMockCard({
- dataset_query: datasetQuery,
+ dataset_query: Lib.toJsQuery(query),
display: "table",
visualization_settings: {},
}),
@@ -135,30 +149,34 @@ function useDataSample({
}
function getPreviewQuery(
+ metadata: Metadata,
databaseId: DatabaseId,
tableId: TableId,
fieldId: FieldId,
pkFields: Field[],
-): DatasetQuery {
- const fieldRef: FieldReference = ["field", fieldId, null];
- const pkFieldRefs: FieldReference[] = pkFields.map((pkField) => {
- return ["field", getRawTableFieldId(pkField), null];
- });
- const filter: FieldFilter = ["not-null", fieldRef];
-
- return {
- type: "query",
- database: databaseId,
- query: {
- "source-table": tableId,
- filter,
- fields: [fieldRef],
- // fetch more rows to increase probability of getting at least 5 unique values
- limit: 50,
- // order by PKs when possible to prevent SQL returning non-deterministically ordered values
- "order-by": pkFieldRefs.map((pkFieldRef) => ["asc", pkFieldRef]),
- },
- };
+): Lib.Query | undefined {
+ const metadataProvider = Lib.metadataProvider(databaseId, metadata);
+ const table = Lib.tableOrCardMetadata(metadataProvider, tableId);
+ const field = Lib.fieldMetadata(metadataProvider, fieldId);
+ if (table == null || field == null) {
+ return;
+ }
+
+ const tableQuery = Lib.queryFromTableOrCardMetadata(metadataProvider, table);
+ const stageIndex = 0;
+ const fieldQuery = Lib.withFields(tableQuery, stageIndex, [field]);
+ const filterQuery = Lib.filter(
+ fieldQuery,
+ stageIndex,
+ Lib.defaultFilterClause({ operator: "not-null", column: field }),
+ );
+ // order by PKs when possible to prevent SQL returning non-deterministically ordered values
+ const orderByQuery = pkFields.reduce((query: Lib.Query, { id }: Field) => {
+ const pkField = Lib.fieldMetadata(metadataProvider, Number(id));
+ return pkField ? Lib.orderBy(query, stageIndex, pkField, "asc") : query;
+ }, filterQuery);
+ // fetch more rows to increase probability of getting at least 5 unique values
+ return Lib.limit(orderByQuery, stageIndex, 50);
}
export const TablePreview = memo(TablePreviewBase);
diff --git a/frontend/src/metabase/metadata/pages/DataModel/utils.ts b/frontend/src/metabase/metadata/pages/DataModel/utils.ts
index 09249a47e1f..55a47d08a26 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/utils.ts
+++ b/frontend/src/metabase/metadata/pages/DataModel/utils.ts
@@ -1,7 +1,6 @@
import { skipToken } from "metabase/api";
import * as Urls from "metabase/lib/urls";
import { PLUGIN_FEATURE_LEVEL_PERMISSIONS } from "metabase/plugins";
-// eslint-disable-next-line no-restricted-imports
import { getSchemaName } from "metabase-lib/v1/metadata/utils/schema";
import type { GetTableQueryMetadataRequest, TableId } from "metabase-types/api";
diff --git a/frontend/src/metabase/schema.js b/frontend/src/metabase/schema.js
index ef8707c9351..3133c951008 100644
--- a/frontend/src/metabase/schema.js
+++ b/frontend/src/metabase/schema.js
@@ -67,6 +67,7 @@ export const FieldSchema = new schema.Entity("fields", undefined, {
},
});
+export const ForeignKeySchema = new schema.Entity("foreignKeys");
export const SegmentSchema = new schema.Entity("segments");
export const PersistedModelSchema = new schema.Entity("persistedModels");
export const SnippetSchema = new schema.Entity("snippets");
@@ -101,6 +102,11 @@ FieldSchema.define({
dimensions: [{ human_readable_field: FieldSchema }],
});
+ForeignKeySchema.define({
+ origin: FieldSchema,
+ destination: FieldSchema,
+});
+
SegmentSchema.define({
table: TableSchema,
});
diff --git a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
index 7fcc6d5e506..5bb0bbce68f 100644
--- a/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
+++ b/frontend/src/metabase/visualizations/components/ObjectDetail/ObjectDetail.unit.spec.tsx
@@ -41,8 +41,7 @@ const HIDDEN_ORDERS_TABLE = createOrdersTable({
});
const REVIEWS_TABLE = createReviewsTable();
-const PRODUCTS_RECORD_RELATED_ORDERS_COUNT = 93;
-const PRODUCTS_RECORD_RELATED_REVIEWS_COUNT = 8;
+const FK_RECORDS_COUNT = 93;
interface SetupOpts {
hideOrdersTable?: boolean;
@@ -123,28 +122,10 @@ function setupForeignKeyCountQueryEndpoints() {
fetchMock.post({
name: "ordersCountQuery",
url: "path:/api/dataset",
- matchPartialBody: true,
- body: {
- query: { "source-table": ORDERS_TABLE.id },
- },
response: createMockDataset({
status: "completed",
data: {
- rows: [[PRODUCTS_RECORD_RELATED_ORDERS_COUNT]],
- },
- }),
- });
- fetchMock.post({
- name: "reviewsCountQuery",
- url: "path:/api/dataset",
- matchPartialBody: true,
- body: {
- query: { "source-table": REVIEWS_TABLE.id },
- },
- response: createMockDataset({
- status: "completed",
- data: {
- rows: [[PRODUCTS_RECORD_RELATED_REVIEWS_COUNT]],
+ rows: [[FK_RECORDS_COUNT]],
},
}),
});
@@ -165,16 +146,12 @@ describe("ObjectDetail", () => {
expect(
await screen.findByText(
- getBrokenUpTextMatcher(
- [PRODUCTS_RECORD_RELATED_REVIEWS_COUNT, "Reviews"].join(""),
- ),
+ getBrokenUpTextMatcher([FK_RECORDS_COUNT, "Reviews"].join("")),
),
).toBeInTheDocument();
expect(
await screen.findByText(
- getBrokenUpTextMatcher(
- [PRODUCTS_RECORD_RELATED_ORDERS_COUNT, "Orders"].join(""),
- ),
+ getBrokenUpTextMatcher([FK_RECORDS_COUNT, "Orders"].join("")),
),
).toBeInTheDocument();
});
@@ -189,15 +166,11 @@ describe("ObjectDetail", () => {
expect(
await screen.findByText(
- getBrokenUpTextMatcher(
- [PRODUCTS_RECORD_RELATED_REVIEWS_COUNT, "Reviews"].join(""),
- ),
+ getBrokenUpTextMatcher([FK_RECORDS_COUNT, "Reviews"].join("")),
),
).toBeInTheDocument();
expect(
- screen.queryByText(
- [PRODUCTS_RECORD_RELATED_ORDERS_COUNT, "Orders"].join(""),
- ),
+ screen.queryByText([FK_RECORDS_COUNT, "Orders"].join("")),
).not.toBeInTheDocument();
});
});
diff --git a/src/metabase/lib/js.cljs b/src/metabase/lib/js.cljs
index 77587a840a1..ab66804338b 100644
--- a/src/metabase/lib/js.cljs
+++ b/src/metabase/lib/js.cljs
@@ -2098,6 +2098,15 @@
[query-or-metadata-provider table-id]
(lib.metadata/table-or-card query-or-metadata-provider table-id))
+(defn ^:export field-metadata
+ "Given an integer `field-id`, returns the field's metadata.
+
+ Returns `nil` (JS `null`) if no matching metadata is found.
+
+ > **Code health:** Healthy."
+ [query-or-metadata-provider field-id]
+ (lib.metadata/field query-or-metadata-provider field-id))
+
;; TODO: "LHS" is a confusing name here. This is really the display name for the joined thing, usually a table.
;; It's an internal detail that this is often based on the LHS of the first join condition, ie. the FK's name.