Skip to content

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

Replace and remove use-table-list-query (#64772)

Nemanja Glumacf573f15de137
diff --git a/frontend/src/metabase-types/api/database.ts b/frontend/src/metabase-types/api/database.ts
index 13e19eb58ef..1a86304ca30 100644
--- a/frontend/src/metabase-types/api/database.ts
+++ b/frontend/src/metabase-types/api/database.ts
@@ -180,6 +180,7 @@ export interface GetDatabaseMetadataRequest {
include_hidden?: boolean;
include_editable_data_model?: boolean;
remove_inactive?: boolean;
+ skip_fields?: boolean;
}
export interface CreateDatabaseRequest {
diff --git a/frontend/src/metabase/admin/permissions/pages/DataPermissionsPage/DataPermissionsPage.tsx b/frontend/src/metabase/admin/permissions/pages/DataPermissionsPage/DataPermissionsPage.tsx
index d0b023de54d..0eb8487d8c9 100644
--- a/frontend/src/metabase/admin/permissions/pages/DataPermissionsPage/DataPermissionsPage.tsx
+++ b/frontend/src/metabase/admin/permissions/pages/DataPermissionsPage/DataPermissionsPage.tsx
@@ -3,7 +3,7 @@ import type { Route } from "react-router";
import { useAsync } from "react-use";
import _ from "underscore";
-import { useTableListQuery } from "metabase/common/hooks";
+import { skipToken, useGetDatabaseMetadataQuery } from "metabase/api";
import Databases from "metabase/entities/databases";
import Groups from "metabase/entities/groups";
import { isAdminGroup, isDefaultGroup } from "metabase/lib/groups";
@@ -45,7 +45,6 @@ function DataPermissionsPage({
const showSplitPermsModal = useSelector((state) =>
getSetting(state, "show-updated-permission-modal"),
);
-
const dispatch = useDispatch();
const resetPermissions = () => dispatch(restoreLoadedPermissions());
@@ -67,15 +66,16 @@ function DataPermissionsPage({
await dispatch({ type: LOAD_DATA_PERMISSIONS_FOR_GROUP, payload: result });
}, []);
- const { isLoading: isLoadingTables } = useTableListQuery({
- query: {
- dbId: params.databaseId,
- include_hidden: true,
- remove_inactive: true,
- skip_fields: true,
- },
- enabled: params.databaseId !== undefined,
- });
+ const { isLoading: isLoadingTables } = useGetDatabaseMetadataQuery(
+ params.databaseId !== undefined
+ ? {
+ id: params.databaseId,
+ include_hidden: true,
+ remove_inactive: true,
+ skip_fields: true,
+ }
+ : skipToken,
+ );
if (isLoadingAllUsers || isLoadingAdminstrators || isLoadingTables) {
return (
diff --git a/frontend/src/metabase/common/hooks/entity-framework/index.ts b/frontend/src/metabase/common/hooks/entity-framework/index.ts
index 5aacec1188a..8962d6a8c5b 100644
--- a/frontend/src/metabase/common/hooks/entity-framework/index.ts
+++ b/frontend/src/metabase/common/hooks/entity-framework/index.ts
@@ -12,5 +12,4 @@ export * from "./use-group-list-query";
export * from "./use-question-list-query";
export * from "./use-question-query";
export * from "./use-search-list-query";
-export * from "./use-table-list-query";
export * from "./use-table-query";
diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-table-list-query/index.ts b/frontend/src/metabase/common/hooks/entity-framework/use-table-list-query/index.ts
deleted file mode 100644
index 29f623152f9..00000000000
--- a/frontend/src/metabase/common/hooks/entity-framework/use-table-list-query/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from "./use-table-list-query";
diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-table-list-query/use-table-list-query.ts b/frontend/src/metabase/common/hooks/entity-framework/use-table-list-query/use-table-list-query.ts
deleted file mode 100644
index e9541daf8aa..00000000000
--- a/frontend/src/metabase/common/hooks/entity-framework/use-table-list-query/use-table-list-query.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-import type {
- UseEntityListQueryProps,
- UseEntityListQueryResult,
-} from "metabase/common/hooks/entity-framework/use-entity-list-query";
-import { useEntityListQuery } from "metabase/common/hooks/entity-framework/use-entity-list-query";
-import Tables from "metabase/entities/tables";
-import type Table from "metabase-lib/v1/metadata/Table";
-import type { TableListQuery } from "metabase-types/api";
-
-/**
- * @deprecated use "metabase/api" instead
- */
-export const useTableListQuery = (
- props: UseEntityListQueryProps<TableListQuery> = {},
-): UseEntityListQueryResult<Table> => {
- return useEntityListQuery(props, {
- fetchList: Tables.actions.fetchList,
- getList: Tables.selectors.getList,
- getLoading: Tables.selectors.getLoading,
- getLoaded: Tables.selectors.getLoaded,
- getError: Tables.selectors.getError,
- getListMetadata: Tables.selectors.getListMetadata,
- });
-};
diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-table-list-query/use-table-list-query.unit.spec.tsx b/frontend/src/metabase/common/hooks/entity-framework/use-table-list-query/use-table-list-query.unit.spec.tsx
deleted file mode 100644
index 9d37312c956..00000000000
--- a/frontend/src/metabase/common/hooks/entity-framework/use-table-list-query/use-table-list-query.unit.spec.tsx
+++ /dev/null
@@ -1,59 +0,0 @@
-import { setupTablesEndpoints } from "__support__/server-mocks";
-import {
- renderWithProviders,
- screen,
- waitForLoaderToBeRemoved,
- within,
-} from "__support__/ui";
-import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { createMockTable } from "metabase-types/api/mocks";
-
-import { useTableListQuery } from "./use-table-list-query";
-
-const TEST_TABLE = createMockTable();
-
-const TestComponent = () => {
- const { data = [], metadata, isLoading, error } = useTableListQuery();
-
- if (isLoading || error) {
- return <LoadingAndErrorWrapper loading={isLoading} error={error} />;
- }
-
- return (
- <div>
- {data.map((table) => (
- <div key={table.id}>{table.name}</div>
- ))}
-
- <div data-testid="metadata">
- {(!metadata || Object.keys(metadata).length === 0) && "No metadata"}
- </div>
- </div>
- );
-};
-
-const setup = () => {
- setupTablesEndpoints([TEST_TABLE]);
- renderWithProviders(<TestComponent />);
-};
-
-describe("useTableListQuery", () => {
- it("should be initially loading", () => {
- setup();
- expect(screen.getByTestId("loading-indicator")).toBeInTheDocument();
- });
-
- it("should show data from the response", async () => {
- setup();
- await waitForLoaderToBeRemoved();
- expect(screen.getByText(TEST_TABLE.name)).toBeInTheDocument();
- });
-
- it("should not have any metadata in the response", async () => {
- setup();
- await waitForLoaderToBeRemoved();
- expect(
- within(screen.getByTestId("metadata")).getByText("No metadata"),
- ).toBeInTheDocument();
- });
-});