Skip to content

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

Remove database entity (#74428)

Romeo Van Snickf8b8ebf695e1
diff --git a/enterprise/frontend/src/embedding/data-picker/DataSelector/DataSelector.jsx b/enterprise/frontend/src/embedding/data-picker/DataSelector/DataSelector.jsx
index 35d1fec7165..d0fc1c25b68 100644
--- a/enterprise/frontend/src/embedding/data-picker/DataSelector/DataSelector.jsx
+++ b/enterprise/frontend/src/embedding/data-picker/DataSelector/DataSelector.jsx
@@ -5,16 +5,18 @@ import { t } from "ttag";
import _ from "underscore";
import {
+ databaseApi,
useLazyListDatabaseSchemaTablesQuery,
useLazyListDatabaseSchemasQuery,
+ useListDatabasesQuery,
useSearchQuery,
} from "metabase/api";
import { EmptyState } from "metabase/common/components/EmptyState";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import CS from "metabase/css/core/index.css";
-import { Databases } from "metabase/entities/databases";
import { Questions } from "metabase/entities/questions";
import { Tables } from "metabase/entities/tables";
+import { entityCompatibleQuery } from "metabase/entities/utils";
import { connect } from "metabase/redux";
import { getMetadata } from "metabase/selectors/metadata";
import { getSetting } from "metabase/selectors/settings";
@@ -915,42 +917,67 @@ function withAvailableModels(WrappedComponent) {
};
}
+function withSavedDatabasesPrefetch(WrappedComponent) {
+ return function DataSelectorWithSavedDatabasesPrefetch(props) {
+ useListDatabasesQuery({ saved: true });
+ return <WrappedComponent {...props} />;
+ };
+}
+
+const isListDatabasesQuerySuccess = (state, query) =>
+ databaseApi.endpoints.listDatabases.select(query)(state).isSuccess;
+
const DataSelector = _.compose(
- Databases.loadList({
- loadingAndErrorWrapper: false,
- listName: "databases",
- query: { saved: true },
- }),
+ withSavedDatabasesPrefetch,
withAvailableModels,
withSchemaFetchers,
connect(
- (state, ownProps) => ({
- // `metadata` exposes the search response (available_models, etc.). Not to
- // be confused with Query Builder's metadata.
- availableModels: ownProps.metadata?.available_models ?? [],
- metadata: getMetadata(state),
- hasLoadedDatabasesWithTablesSaved: Databases.selectors.getLoaded(state, {
- entityQuery: { include: "tables", saved: true },
- }),
- hasLoadedDatabasesWithSaved: Databases.selectors.getLoaded(state, {
- entityQuery: { saved: true },
- }),
- hasLoadedDatabasesWithTables: Databases.selectors.getLoaded(state, {
- entityQuery: { include: "tables" },
- }),
- hasDataAccess: canUserCreateQueries(state),
- hasNestedQueriesEnabled: getSetting(state, "enable-nested-queries"),
- selectedQuestion: Questions.selectors.getObject(state, {
- entityId: getQuestionIdFromVirtualTableId(ownProps.selectedTableId),
- }),
- }),
- {
- fetchDatabases: () => Databases.actions.fetchList({ saved: true }),
- fetchFields: (tableId) => Tables.actions.fetchMetadata({ id: tableId }),
- fetchQuestion: (id) =>
- Questions.actions.fetch({
- id: getQuestionIdFromVirtualTableId(id),
+ (state, ownProps) => {
+ const response = databaseApi.endpoints.listDatabases.select({
+ saved: true,
+ })(state).data;
+ const metadata = getMetadata(state);
+ return {
+ // `metadata` exposes the search response (available_models, etc.). Not to
+ // be confused with Query Builder's metadata.
+ availableModels: ownProps.metadata?.available_models ?? [],
+ metadata,
+ databases: (response?.data ?? [])
+ .map(({ id }) => metadata.database(id))
+ .filter((database) => database != null),
+ hasLoadedDatabasesWithTablesSaved: isListDatabasesQuerySuccess(state, {
+ include: "tables",
+ saved: true,
}),
+ hasLoadedDatabasesWithSaved: isListDatabasesQuerySuccess(state, {
+ saved: true,
+ }),
+ hasLoadedDatabasesWithTables: isListDatabasesQuerySuccess(state, {
+ include: "tables",
+ }),
+ hasDataAccess: canUserCreateQueries(state),
+ hasNestedQueriesEnabled: getSetting(state, "enable-nested-queries"),
+ selectedQuestion: Questions.selectors.getObject(state, {
+ entityId: getQuestionIdFromVirtualTableId(ownProps.selectedTableId),
+ }),
+ };
},
+ (dispatch) => ({
+ fetchDatabases: () =>
+ entityCompatibleQuery(
+ { saved: true },
+ dispatch,
+ databaseApi.endpoints.listDatabases,
+ { forceRefetch: false },
+ ),
+ fetchFields: (tableId) =>
+ dispatch(Tables.actions.fetchMetadata({ id: tableId })),
+ fetchQuestion: (id) =>
+ dispatch(
+ Questions.actions.fetch({
+ id: getQuestionIdFromVirtualTableId(id),
+ }),
+ ),
+ }),
),
)(UnconnectedDataSelector);
diff --git a/frontend/src/metabase/actions/containers/ActionCreator/ActionCreator.tsx b/frontend/src/metabase/actions/containers/ActionCreator/ActionCreator.tsx
index f675bfd66f8..af1af57bafb 100644
--- a/frontend/src/metabase/actions/containers/ActionCreator/ActionCreator.tsx
+++ b/frontend/src/metabase/actions/containers/ActionCreator/ActionCreator.tsx
@@ -7,6 +7,7 @@ import {
skipToken,
useCreateActionMutation,
useGetActionQuery,
+ useListDatabasesQuery,
useUpdateActionMutation,
} from "metabase/api";
import { LeaveRouteConfirmModal } from "metabase/common/components/LeaveConfirmModal";
@@ -14,7 +15,6 @@ import { Modal } from "metabase/common/components/Modal";
import { useBeforeUnload } from "metabase/common/hooks/use-before-unload";
import { useCallbackEffect } from "metabase/common/hooks/use-callback-effect";
import { useToast } from "metabase/common/hooks/use-toast";
-import { Databases } from "metabase/entities/databases";
import { Questions } from "metabase/entities/questions";
import { connect } from "metabase/redux";
import type { State } from "metabase/redux/store";
@@ -202,6 +202,7 @@ function ActionCreatorWithContext({
action,
...props
}: Props) {
+ useListDatabasesQuery();
const { data: initialAction } = useGetActionQuery(
props.actionId != null ? { id: props.actionId } : skipToken,
);
@@ -225,6 +226,5 @@ export default _.compose(
id: (state: State, props: OwnProps) => props?.modelId,
entityAlias: "model",
}),
- Databases.loadList(),
connect(mapStateToProps),
)(ActionCreatorWithContext);
diff --git a/frontend/src/metabase/admin/app/containers/DeprecationNotice/DeprecationNotice.tsx b/frontend/src/metabase/admin/app/containers/DeprecationNotice/DeprecationNotice.tsx
index 18d71e66d50..20950050702 100644
--- a/frontend/src/metabase/admin/app/containers/DeprecationNotice/DeprecationNotice.tsx
+++ b/frontend/src/metabase/admin/app/containers/DeprecationNotice/DeprecationNotice.tsx
@@ -1,9 +1,6 @@
-import _ from "underscore";
-
-import { Databases } from "metabase/entities/databases";
-import { connect } from "metabase/redux";
-import type { State } from "metabase/redux/store";
-import type Database from "metabase-lib/v1/metadata/Database";
+import { useListDatabasesQuery } from "metabase/api";
+import { useDispatch, useSelector } from "metabase/redux";
+import { getMetadata } from "metabase/selectors/metadata";
import { disableNotice } from "../../actions";
import DeprecationNotice from "../../components/DeprecationNotice";
@@ -12,23 +9,23 @@ import {
isDeprecationNoticeEnabled,
} from "../../selectors";
-interface Props {
- databases?: Database[];
-}
-
-const mapStateToProps = (state: State, props: Props) => ({
- hasDeprecatedDatabase: hasDeprecatedDatabase(state, props),
- isEnabled: isDeprecationNoticeEnabled(state),
-});
+const DeprecationNoticeContainer = () => {
+ useListDatabasesQuery();
+ const databases = useSelector((state) => getMetadata(state).databasesList());
+ const hasDeprecated = useSelector((state) =>
+ hasDeprecatedDatabase(state, { databases }),
+ );
+ const isEnabled = useSelector(isDeprecationNoticeEnabled);
+ const dispatch = useDispatch();
-const mapDispatchToProps = {
- onClose: disableNotice,
+ return (
+ <DeprecationNotice
+ hasDeprecatedDatabase={hasDeprecated}
+ isEnabled={isEnabled}
+ onClose={() => dispatch(disableNotice())}
+ />
+ );
};
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default _.compose(
- Databases.loadList({
- loadingAndErrorWrapper: false,
- }),
- connect(mapStateToProps, mapDispatchToProps),
-)(DeprecationNotice);
+export default DeprecationNoticeContainer;
diff --git a/frontend/src/metabase/admin/databases/database.ts b/frontend/src/metabase/admin/databases/database.ts
index 2c617606b30..31568cc1201 100644
--- a/frontend/src/metabase/admin/databases/database.ts
+++ b/frontend/src/metabase/admin/databases/database.ts
@@ -1,10 +1,13 @@
import { createAction, createReducer } from "@reduxjs/toolkit";
import { push } from "react-router-redux";
-import { Databases } from "metabase/entities/databases";
+import { databaseApi } from "metabase/api";
+import { entityCompatibleQuery } from "metabase/entities/utils";
import { combineReducers } from "metabase/redux";
import { createDatabase } from "metabase/redux/databases";
+import { updateMetadata } from "metabase/redux/metadata-typed";
import type { Dispatch } from "metabase/redux/store";
+import { DatabaseSchema } from "metabase/schema";
import type { DatabaseData, DatabaseId } from "metabase-types/api";
const DELETE_DATABASE = createAction<{ databaseId: DatabaseId }>(
@@ -20,8 +23,13 @@ const DELETE_DATABASE_FAILED = createAction<{
export const updateDatabase = function (database: DatabaseData) {
return async function (dispatch: Dispatch) {
- const action = await dispatch(Databases.actions.update(database));
- return Databases.HACK_getObjectFromAction(action);
+ const result = await entityCompatibleQuery(
+ database,
+ dispatch,
+ databaseApi.endpoints.updateDatabase,
+ );
+ dispatch(updateMetadata(result, DatabaseSchema));
+ return result;
};
};
@@ -40,7 +48,11 @@ export const deleteDatabase = function (databaseId: DatabaseId) {
return async function (dispatch: Dispatch) {
try {
dispatch(DELETE_DATABASE_STARTED({ databaseId }));
- await dispatch(Databases.actions.delete({ id: databaseId }));
+ await entityCompatibleQuery(
+ databaseId,
+ dispatch,
+ databaseApi.endpoints.deleteDatabase,
+ );
dispatch(push("/admin/databases/"));
dispatch(DELETE_DATABASE({ databaseId }));
diff --git a/frontend/src/metabase/admin/permissions/pages/DataPermissionsPage/DataPermissionsPage.tsx b/frontend/src/metabase/admin/permissions/pages/DataPermissionsPage/DataPermissionsPage.tsx
index 4d6c542b954..14bc508a8be 100644
--- a/frontend/src/metabase/admin/permissions/pages/DataPermissionsPage/DataPermissionsPage.tsx
+++ b/frontend/src/metabase/admin/permissions/pages/DataPermissionsPage/DataPermissionsPage.tsx
@@ -6,10 +6,11 @@ import { isAdminGroup, isDefaultGroup } from "metabase/admin/utils/groups";
import {
skipToken,
useGetDatabaseMetadataQuery,
+ useListDatabasesQuery,
useListPermissionsGroupsQuery,
} from "metabase/api";
-import { Databases } from "metabase/entities/databases";
import { useDispatch, useSelector } from "metabase/redux";
+import { getMetadataUnfiltered } from "metabase/selectors/metadata";
import { getSetting } from "metabase/selectors/settings";
import { Center, Loader } from "metabase/ui";
import type Database from "metabase-lib/v1/metadata/Database";
@@ -30,17 +31,22 @@ type DataPermissionsPageProps = {
params: {
databaseId: DatabaseId;
};
- databases: Database[];
};
const EMPTY_GROUP_LIST: GroupInfo[] = [];
+const EMPTY_DATABASE_LIST: Database[] = [];
function DataPermissionsPage({
children,
route,
params,
- databases,
}: DataPermissionsPageProps) {
+ const { isLoading: isLoadingDatabases } = useListDatabasesQuery();
+ const databases = useSelector(
+ (state) =>
+ (getMetadataUnfiltered(state).databasesList() as Database[]) ??
+ EMPTY_DATABASE_LIST,
+ );
const { data, isLoading: isLoadingGroups } = useListPermissionsGroupsQuery(
{},
);
@@ -83,6 +89,7 @@ function DataPermissionsPage({
);
if (
+ isLoadingDatabases ||
isLoadingGroups ||
isLoadingAllUsers ||
isLoadingAdminstrators ||
@@ -112,6 +119,4 @@ function DataPermissionsPage({
}
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default Databases.loadList({
- selectorName: "getListUnfiltered",
-})(DataPermissionsPage);
+export default DataPermissionsPage;
diff --git a/frontend/src/metabase/browse/schemas/BrowseSchemas.tsx b/frontend/src/metabase/browse/schemas/BrowseSchemas.tsx
index cd6a23daa55..d41e7b7ca75 100644
--- a/frontend/src/metabase/browse/schemas/BrowseSchemas.tsx
+++ b/frontend/src/metabase/browse/schemas/BrowseSchemas.tsx
@@ -1,15 +1,19 @@
import cx from "classnames";
import { t } from "ttag";
-import { useListDatabaseSchemasQuery } from "metabase/api";
+import {
+ skipToken,
+ useGetDatabaseQuery,
+ useListDatabaseSchemasQuery,
+} from "metabase/api";
import { TableBrowser } from "metabase/browse/tables/TableBrowser";
import { BrowserCrumbs } from "metabase/common/components/BrowserCrumbs";
import { NotFound } from "metabase/common/components/ErrorPages";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import CS from "metabase/css/core/index.css";
-import { Databases } from "metabase/entities/databases";
import { Flex } from "metabase/ui";
import * as Urls from "metabase/urls";
+import type { DatabaseId } from "metabase-types/api";
import { BrowseCard } from "../components/BrowseCard";
import S from "../components/BrowseContainer.module.css";
@@ -18,6 +22,13 @@ import { BrowseGrid } from "../components/BrowseGrid";
type Schema = { id: string; name: string };
+const DatabaseName = ({ id }: { id: DatabaseId | null | undefined }) => {
+ const { data: database } = useGetDatabaseQuery(
+ id != null ? { id } : skipToken,
+ );
+ return <>{database?.name ?? ""}</>;
+};
+
const BrowseSchemasContainer = ({
schemas,
params,
@@ -55,7 +66,7 @@ const BrowseSchemasContainer = ({
<BrowserCrumbs
crumbs={[
{ title: t`Databases`, to: "/browse/databases" },
- { title: <Databases.Name id={dbId} /> },
+ { title: <DatabaseName id={dbId} /> },
]}
/>
</Flex>
diff --git a/frontend/src/metabase/browse/tables/TableBrowser/useDatabaseCrumb.ts b/frontend/src/metabase/browse/tables/TableBrowser/useDatabaseCrumb.ts
index dd5ef7a69d3..8ce2e30db59 100644
--- a/frontend/src/metabase/browse/tables/TableBrowser/useDatabaseCrumb.ts
+++ b/frontend/src/metabase/browse/tables/TableBrowser/useDatabaseCrumb.ts
@@ -1,8 +1,8 @@
import { t } from "ttag";
import { skipToken, useGetDatabaseQuery } from "metabase/api";
-import { Databases } from "metabase/entities/databases";
import { useSelector } from "metabase/redux";
+import { getMetadata } from "metabase/selectors/metadata";
import * as Urls from "metabase/urls";
import { SAVED_QUESTIONS_VIRTUAL_DB_ID } from "metabase-lib/v1/metadata/utils/saved-questions";
import type { DatabaseId } from "metabase-types/api";
@@ -11,12 +11,9 @@ export const useDatabaseCrumb = (id: DatabaseId) => {
// We display what we already have in store to avoid showing loading state.
// It's possible because GET /api/database is always dispatched on app launch.
// We still re-fetch the database to get new data, just in case it changed.
- const legacyDatabase = useSelector((state) => {
- return Databases.selectors.getObject(state, {
- entityId: id,
- requestType: "fetch",
- });
- });
+ const cachedDatabase = useSelector((state) =>
+ getMetadata(state).database(id),
+ );
const { data: fetchedDatabase } = useGetDatabaseQuery(
id === SAVED_QUESTIONS_VIRTUAL_DB_ID ? skipToken : { id },
@@ -29,7 +26,7 @@ export const useDatabaseCrumb = (id: DatabaseId) => {
};
}
- const database = fetchedDatabase ?? legacyDatabase;
+ const database = fetchedDatabase ?? cachedDatabase;
if (!database) {
return {
diff --git a/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx b/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx
index 8663bddfff7..75169ea1758 100644
--- a/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx
+++ b/frontend/src/metabase/collections/components/CollectionContent/CollectionContent.tsx
@@ -9,10 +9,10 @@ import {
} from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { useDatabaseListQuery } from "metabase/common/hooks";
-import { Databases } from "metabase/entities/databases";
import { useDispatch, useSelector } from "metabase/redux";
import type { UploadFileProps } from "metabase/redux/uploads";
import { uploadFile as uploadFileAction } from "metabase/redux/uploads";
+import { getMetadata } from "metabase/selectors/metadata";
import { getSetting } from "metabase/selectors/settings";
import { getUserIsAdmin } from "metabase/selectors/user";
import type {
@@ -48,12 +48,8 @@ export function CollectionContent({
const canCreateUploadInDb = useSelector(
(state) =>
- uploadDbId &&
- Databases.selectors
- .getObject(state, {
- entityId: uploadDbId,
- })
- ?.canUpload(),
+ uploadDbId != null &&
+ !!getMetadata(state).database(uploadDbId)?.canUpload(),
);
const isAdmin = useSelector(getUserIsAdmin);
diff --git a/frontend/src/metabase/common/components/NewItemMenu/NewItemMenu.tsx b/frontend/src/metabase/common/components/NewItemMenu/NewItemMenu.tsx
index 9d149e95a61..9ff606bd754 100644
--- a/frontend/src/metabase/common/components/NewItemMenu/NewItemMenu.tsx
+++ b/frontend/src/metabase/common/components/NewItemMenu/NewItemMenu.tsx
@@ -1,40 +1,37 @@
-import { push } from "react-router-redux";
-import _ from "underscore";
-
-import { Databases } from "metabase/entities/databases";
-import { connect } from "metabase/redux";
+import { useListDatabasesQuery } from "metabase/api";
+import { useDispatch, useSelector } from "metabase/redux";
import { closeNavbar } from "metabase/redux/app";
-import type { State } from "metabase/redux/store";
import { getHasDatabaseWithJsonEngine } from "metabase/selectors/data";
import {
canUserCreateNativeQueries,
canUserCreateQueries,
} from "metabase/selectors/user";
-import type Database from "metabase-lib/v1/metadata/Database";
import { NewItemMenuView } from "./NewItemMenuView";
-interface MenuDatabaseProps {
- databases?: Database[];
-}
+type NewItemMenuProps = Omit<
+ React.ComponentProps<typeof NewItemMenuView>,
+ | "hasDataAccess"
+ | "hasNativeWrite"
+ | "hasDatabaseWithJsonEngine"
+ | "onCloseNavbar"
+>;
-const mapStateToProps = (
- state: State,
- { databases = [] }: MenuDatabaseProps,
-) => ({
- hasDataAccess: canUserCreateQueries(state),
- hasNativeWrite: canUserCreateNativeQueries(state),
- hasDatabaseWithJsonEngine: getHasDatabaseWithJsonEngine(databases),
-});
+export const NewItemMenu = (props: NewItemMenuProps) => {
+ const { data: databasesResponse } = useListDatabasesQuery();
+ const databases = databasesResponse?.data ?? [];
+ const hasDataAccess = useSelector(canUserCreateQueries);
+ const hasNativeWrite = useSelector(canUserCreateNativeQueries);
+ const hasDatabaseWithJsonEngine = getHasDatabaseWithJsonEngine(databases);
+ const dispatch = useDispatch();
-const mapDispatchToProps = {
- onCloseNavbar: closeNavbar,
- onChangeLocation: push,
+ return (
+ <NewItemMenuView
+ {...props}
+ hasDataAccess={hasDataAccess}
+ hasNativeWrite={hasNativeWrite}
+ hasDatabaseWithJsonEngine={hasDatabaseWithJsonEngine}
+ onCloseNavbar={() => dispatch(closeNavbar())}
+ />
+ );
};
-
-export const NewItemMenu = _.compose(
- Databases.loadList({
- loadingAndErrorWrapper: false,
- }),
- connect(mapStateToProps, mapDispatchToProps),
-)(NewItemMenuView);
diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-database-list-query/use-database-list-query.ts b/frontend/src/metabase/common/hooks/entity-framework/use-database-list-query/use-database-list-query.ts
index c2b50625f6d..46060b99607 100644
--- a/frontend/src/metabase/common/hooks/entity-framework/use-database-list-query/use-database-list-query.ts
+++ b/frontend/src/metabase/common/hooks/entity-framework/use-database-list-query/use-database-list-query.ts
@@ -1,24 +1,42 @@
+import { skipToken, useListDatabasesQuery } from "metabase/api";
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 { Databases } from "metabase/entities/databases";
+import { useSelector } from "metabase/redux";
+import { getMetadata } from "metabase/selectors/metadata";
import type Database from "metabase-lib/v1/metadata/Database";
import type { ListDatabasesRequest } from "metabase-types/api";
/**
* @deprecated use "metabase/api" instead
*/
-export const useDatabaseListQuery = (
- props: UseEntityListQueryProps<ListDatabasesRequest> = {},
-): UseEntityListQueryResult<Database> => {
- return useEntityListQuery<Database, ListDatabasesRequest>(props, {
- fetchList: Databases.actions.fetchList,
- getList: Databases.selectors.getList,
- getLoading: Databases.selectors.getLoading,
- getLoaded: Databases.selectors.getLoaded,
- getError: Databases.selectors.getError,
- getListMetadata: Databases.selectors.getListMetadata,
+export const useDatabaseListQuery = ({
+ query,
+ reload = false,
+ enabled = true,
+}: UseEntityListQueryProps<ListDatabasesRequest> = {}): UseEntityListQueryResult<Database> => {
+ const {
+ data: response,
+ isFetching,
+ isSuccess,
+ error,
+ } = useListDatabasesQuery(enabled ? (query ?? undefined) : skipToken, {
+ refetchOnMountOrArgChange: reload,
});
+ const data = useSelector((state) => {
+ if (!response) {
+ return undefined;
+ }
+ const metadata = getMetadata(state);
+ return response.data
+ .map(({ id }) => metadata.database(id))
+ .filter((database): database is Database => database != null);
+ });
+ return {
+ data,
+ isLoading: isFetching,
+ isLoaded: isSuccess,
+ error,
+ };
};
diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-database-query/use-database-query.ts b/frontend/src/metabase/common/hooks/entity-framework/use-database-query/use-database-query.ts
index 2f5cd04536f..8157a088a63 100644
--- a/frontend/src/metabase/common/hooks/entity-framework/use-database-query/use-database-query.ts
+++ b/frontend/src/metabase/common/hooks/entity-framework/use-database-query/use-database-query.ts
@@ -1,22 +1,36 @@
+import { skipToken, useGetDatabaseQuery } from "metabase/api";
import type {
UseEntityQueryProps,
UseEntityQueryResult,
} from "metabase/common/hooks/entity-framework/use-entity-query";
-import { useEntityQuery } from "metabase/common/hooks/entity-framework/use-entity-query";
-import { Databases } from "metabase/entities/databases";
+import { useSelector } from "metabase/redux";
+import { getMetadata } from "metabase/selectors/metadata";
import type Database from "metabase-lib/v1/metadata/Database";
import type { DatabaseId, GetDatabaseRequest } from "metabase-types/api";
/**
* @deprecated use "metabase/api" instead
*/
-export const useDatabaseQuery = (
- props: UseEntityQueryProps<DatabaseId, Omit<GetDatabaseRequest, "id">>,
-): UseEntityQueryResult<Database> => {
- return useEntityQuery(props, {
- fetch: Databases.actions.fetch,
- getObject: Databases.selectors.getObject,
- getLoading: Databases.selectors.getLoading,
- getError: Databases.selectors.getError,
- });
+export const useDatabaseQuery = ({
+ id,
+ query,
+ reload = false,
+ enabled = true,
+}: UseEntityQueryProps<
+ DatabaseId,
+ Omit<GetDatabaseRequest, "id">
+>): UseEntityQueryResult<Database> => {
+ const isActive = enabled && id != null;
+ const { isFetching, error } = useGetDatabaseQuery(
+ isActive ? { id, ...query } : skipToken,
+ { refetchOnMountOrArgChange: reload },
+ );
+ const data = useSelector((state) =>
+ id != null ? (getMetadata(state).database(id) ?? undefined) : undefined,
+ );
+ return {
+ data,
+ isLoading: isFetching || (isActive && data == null),
+ error,
+ };
};
diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/use-entity-list-query.unit.spec.tsx b/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/use-entity-list-query.unit.spec.tsx
index 50943455b7a..8fccf254108 100644
--- a/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/use-entity-list-query.unit.spec.tsx
+++ b/frontend/src/metabase/common/hooks/entity-framework/use-entity-list-query/use-entity-list-query.unit.spec.tsx
@@ -2,7 +2,7 @@ import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
import {
- setupDatabasesEndpoints,
+ setupCardsEndpoints,
setupTablesEndpoints,
} from "__support__/server-mocks";
import {
@@ -13,18 +13,18 @@ import {
within,
} from "__support__/ui";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { Databases } from "metabase/entities/databases";
+import { Questions } from "metabase/entities/questions";
import { Tables } from "metabase/entities/tables";
import { useDispatch } from "metabase/redux";
import { delay } from "metabase/utils/promise";
-import type Database from "metabase-lib/v1/metadata/Database";
+import type Question from "metabase-lib/v1/Question";
import type Table from "metabase-lib/v1/metadata/Table";
import type { TableListQuery } from "metabase-types/api";
-import { createMockDatabase, createMockTable } from "metabase-types/api/mocks";
+import { createMockCard, createMockTable } from "metabase-types/api/mocks";
import { useEntityListQuery } from "./use-entity-list-query";
-const TEST_DB = createMockDatabase();
+const TEST_CARD = createMockCard();
const TEST_TABLE = createMockTable();
const TestComponent = ({ testId }: { testId?: string }) => {
@@ -32,20 +32,20 @@ const TestComponent = ({ testId }: { testId?: string }) => {
data = [],
isLoading,
error,
- } = useEntityListQuery<Database>(
+ } = useEntityListQuery<Question>(
{},
{
- fetchList: Databases.actions.fetchList,
- getList: Databases.selectors.getList,
- getLoading: Databases.selectors.getLoading,
- getLoaded: Databases.selectors.getLoaded,
- getError: Databases.selectors.getError,
- getListMetadata: Databases.selectors.getListMetadata,
+ fetchList: Questions.actions.fetchList,
+ getList: Questions.selectors.getList,
+ getLoading: Questions.selectors.getLoading,
+ getLoaded: Questions.selectors.getLoaded,
+ getError: Questions.selectors.getError,
+ getListMetadata: Questions.selectors.getListMetadata,
},
);
const dispatch = useDispatch();
- const handleInvalidate = () => dispatch(Databases.actions.invalidateLists());
+ const handleInvalidate = () => dispatch(Questions.actions.invalidateLists());
if (isLoading || error) {
return (
@@ -59,9 +59,9 @@ const TestComponent = ({ testId }: { testId?: string }) => {
return (
<div data-testid={testId}>
- <button onClick={handleInvalidate}>Invalidate databases</button>
- {data.map((database) => (
- <div key={database.id}>{database.name}</div>
+ <button onClick={handleInvalidate}>Invalidate questions</button>
+ {data.map((question) => (
+ <div key={question.id()}>{question.displayName()}</div>
))}
<TestInnerComponent />
</div>
@@ -105,7 +105,7 @@ const TestInnerComponent = () => {
};
const setup = () => {
- setupDatabasesEndpoints([TEST_DB]);
+ setupCardsEndpoints([TEST_CARD]);
setupTablesEndpoints([TEST_TABLE]);
return renderWithProviders(<TestComponent />);
};
@@ -122,9 +122,9 @@ describe("useEntityListQuery", () => {
await waitForLoaderToBeRemoved();
- expect(screen.getByText(TEST_DB.name)).toBeInTheDocument();
+ expect(screen.getByText(TEST_CARD.name)).toBeInTheDocument();
expect(screen.getByText(TEST_TABLE.name)).toBeInTheDocument();
- expect(fetchMock.callHistory.calls("path:/api/database")).toHaveLength(1);
+ expect(fetchMock.callHistory.calls("path:/api/card")).toHaveLength(1);
expect(fetchMock.callHistory.calls("path:/api/table")).toHaveLength(1);
});
@@ -134,9 +134,9 @@ describe("useEntityListQuery", () => {
await waitForLoaderToBeRemoved();
rerender(<TestComponent />);
- expect(screen.getByText(TEST_DB.name)).toBeInTheDocument();
+ expect(screen.getByText(TEST_CARD.name)).toBeInTheDocument();
expect(screen.getByText(TEST_TABLE.name)).toBeInTheDocument();
- expect(fetchMock.callHistory.calls("path:/api/database")).toHaveLength(1);
+ expect(fetchMock.callHistory.calls("path:/api/card")).toHaveLength(1);
expect(fetchMock.callHistory.calls("path:/api/table")).toHaveLength(1);
});
@@ -148,9 +148,9 @@ describe("useEntityListQuery", () => {
rerender(<TestComponent />);
await waitForLoaderToBeRemoved();
- expect(screen.getByText(TEST_DB.name)).toBeInTheDocument();
+ expect(screen.getByText(TEST_CARD.name)).toBeInTheDocument();
expect(screen.getByText(TEST_TABLE.name)).toBeInTheDocument();
- expect(fetchMock.callHistory.calls("path:/api/database")).toHaveLength(1);
+ expect(fetchMock.callHistory.calls("path:/api/card")).toHaveLength(1);
expect(fetchMock.callHistory.calls("path:/api/table")).toHaveLength(2);
});
@@ -158,12 +158,12 @@ describe("useEntityListQuery", () => {
setup();
await waitForLoaderToBeRemoved();
- await userEvent.click(screen.getByText("Invalidate databases"));
+ await userEvent.click(screen.getByText("Invalidate questions"));
await waitFor(() => {
- expect(fetchMock.callHistory.calls("path:/api/database")).toHaveLength(2);
+ expect(fetchMock.callHistory.calls("path:/api/card")).toHaveLength(2);
});
- expect(await screen.findByText(TEST_DB.name)).toBeInTheDocument();
+ expect(await screen.findByText(TEST_CARD.name)).toBeInTheDocument();
});
it("should reload data when the reload flag is on and it is explicitly invalidated", async () => {
@@ -182,14 +182,14 @@ describe("useEntityListQuery", () => {
it("should not remove loader in case second api call is cached", async () => {
const { rerender } = setup();
- fetchMock.modifyRoute("database-list", {
+ fetchMock.modifyRoute("cards-list", {
response: async () => {
await delay(100);
- return [TEST_DB];
+ return [TEST_CARD];
},
});
await waitFor(() => {
- expect(fetchMock.callHistory.calls("path:/api/database")).toHaveLength(1);
+ expect(fetchMock.callHistory.calls("path:/api/card")).toHaveLength(1);
});
rerender(
@@ -200,7 +200,7 @@ describe("useEntityListQuery", () => {
);
// second component should not create extra request, make sure that caching works as expected
- expect(fetchMock.callHistory.calls("path:/api/database")).toHaveLength(1);
+ expect(fetchMock.callHistory.calls("path:/api/card")).toHaveLength(1);
expect(
within(screen.getByTestId("test2")).getByTestId("loading-indicator"),
@@ -210,7 +210,7 @@ describe("useEntityListQuery", () => {
await delay(0); // trigger extra event loop to make sure React state has been updated
- expect(fetchMock.callHistory.calls("path:/api/database")).toHaveLength(1);
+ expect(fetchMock.callHistory.calls("path:/api/card")).toHaveLength(1);
expect(screen.queryByTestId("loading-indicator")).not.toBeInTheDocument();
});
});
diff --git a/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/use-entity-query.unit.spec.tsx b/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/use-entity-query.unit.spec.tsx
index b84a0814c75..f51246c9f5e 100644
--- a/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/use-entity-query.unit.spec.tsx
+++ b/frontend/src/metabase/common/hooks/entity-framework/use-entity-query/use-entity-query.unit.spec.tsx
@@ -1,7 +1,7 @@
import fetchMock from "fetch-mock";
import {
- setupDatabaseEndpoints,
+ setupCardEndpoints,
setupTableEndpoints,
} from "__support__/server-mocks";
import {
@@ -10,42 +10,42 @@ import {
waitForLoaderToBeRemoved,
} from "__support__/ui";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { Databases } from "metabase/entities/databases";
+import { Questions } from "metabase/entities/questions";
import { Tables } from "metabase/entities/tables";
-import type Database from "metabase-lib/v1/metadata/Database";
+import type Question from "metabase-lib/v1/Question";
import type Table from "metabase-lib/v1/metadata/Table";
-import type { DatabaseId, TableId } from "metabase-types/api";
-import { createMockDatabase, createMockTable } from "metabase-types/api/mocks";
+import type { CardId, TableId } from "metabase-types/api";
+import { createMockCard, createMockTable } from "metabase-types/api/mocks";
import { useEntityQuery } from "./use-entity-query";
-const TEST_DB = createMockDatabase();
+const TEST_CARD = createMockCard();
const TEST_TABLE = createMockTable();
const TestComponent = () => {
const {
- data: database,
+ data: question,
isLoading,
error,
- } = useEntityQuery<DatabaseId, Database>(
+ } = useEntityQuery<CardId, Question>(
{
- id: TEST_DB.id,
+ id: TEST_CARD.id,
},
{
- fetch: Databases.actions.fetch,
- getObject: Databases.selectors.getObject,
- getLoading: Databases.selectors.getLoading,
- getError: Databases.selectors.getError,
+ fetch: Questions.actions.fetch,
+ getObject: Questions.selectors.getObject,
+ getLoading: Questions.selectors.getLoading,
+ getError: Questions.selectors.getError,
},
);
- if (isLoading || error || !database) {
+ if (isLoading || error || !question) {
return <LoadingAndErrorWrapper loading={isLoading} error={error} />;
}
return (
<div>
- <div>{database.name}</div>
+ <div>{question.displayName()}</div>
<TestInnerComponent />
</div>
);
@@ -77,7 +77,7 @@ const TestInnerComponent = () => {
};
const setup = () => {
- setupDatabaseEndpoints(TEST_DB);
+ setupCardEndpoints(TEST_CARD);
setupTableEndpoints(TEST_TABLE);
return renderWithProviders(<TestComponent />);
};
@@ -94,10 +94,10 @@ describe("useEntityQuery", () => {
await waitForLoaderToBeRemoved();
- expect(screen.getByText(TEST_DB.name)).toBeInTheDocument();
+ expect(screen.getByText(TEST_CARD.name)).toBeInTheDocument();
expect(screen.getByText(TEST_TABLE.name)).toBeInTheDocument();
expect(
- fetchMock.callHistory.calls(`path:/api/database/${TEST_DB.id}`),
+ fetchMock.callHistory.calls(`path:/api/card/${TEST_CARD.id}`),
).toHaveLength(1);
expect(
fetchMock.callHistory.calls(`path:/api/table/${TEST_TABLE.id}`),
@@ -110,10 +110,10 @@ describe("useEntityQuery", () => {
await waitForLoaderToBeRemoved();
rerender(<TestComponent />);
- expect(screen.getByText(TEST_DB.name)).toBeInTheDocument();
+ expect(screen.getByText(TEST_CARD.name)).toBeInTheDocument();
expect(screen.getByText(TEST_TABLE.name)).toBeInTheDocument();
expect(
- fetchMock.callHistory.calls(`path:/api/database/${TEST_DB.id}`),
+ fetchMock.callHistory.calls(`path:/api/card/${TEST_CARD.id}`),
).toHaveLength(1);
expect(
fetchMock.callHistory.calls(`path:/api/table/${TEST_TABLE.id}`),
@@ -128,10 +128,10 @@ describe("useEntityQuery", () => {
rerender(<TestComponent />);
await waitForLoaderToBeRemoved();
- expect(screen.getByText(TEST_DB.name)).toBeInTheDocument();
+ expect(screen.getByText(TEST_CARD.name)).toBeInTheDocument();
expect(screen.getByText(TEST_TABLE.name)).toBeInTheDocument();
expect(
- fetchMock.callHistory.calls(`path:/api/database/${TEST_DB.id}`),
+ fetchMock.callHistory.calls(`path:/api/card/${TEST_CARD.id}`),
).toHaveLength(1);
expect(
fetchMock.callHistory.calls(`path:/api/table/${TEST_TABLE.id}`),
diff --git a/frontend/src/metabase/entities/containers/rtk-query/types/entities.ts b/frontend/src/metabase/entities/containers/rtk-query/types/entities.ts
index 8243fc2bcbb..fb9ce835d51 100644
--- a/frontend/src/metabase/entities/containers/rtk-query/types/entities.ts
+++ b/frontend/src/metabase/entities/containers/rtk-query/types/entities.ts
@@ -37,7 +37,6 @@ export type ReloadIntervalSelector<Entity> = (
export type EntityType =
| "alerts"
| "bookmarks"
- | "databases"
| "documents"
| "pulses"
| "questions"
diff --git a/frontend/src/metabase/entities/databases.js b/frontend/src/metabase/entities/databases.js
deleted file mode 100644
index 5de62741894..00000000000
--- a/frontend/src/metabase/entities/databases.js
+++ /dev/null
@@ -1,141 +0,0 @@
-import { createSelector } from "@reduxjs/toolkit";
-import { normalize } from "normalizr";
-import _ from "underscore";
-
-import {
- databaseApi,
- useGetDatabaseMetadataQuery,
- useGetDatabaseQuery,
- useListDatabasesQuery,
-} from "metabase/api";
-import { createThunkAction } from "metabase/redux";
-import { DatabaseSchema } from "metabase/schema";
-import {
- getMetadata,
- getMetadataUnfiltered,
-} from "metabase/selectors/metadata";
-import { isVirtualCardId } from "metabase-lib/v1/metadata/utils/saved-questions";
-
-import { createEntity, entityCompatibleQuery, fetchData } from "./utils";
-
-// OBJECT ACTIONS
-export const FETCH_DATABASE_METADATA =
- "metabase/entities/database/FETCH_DATABASE_METADATA";
-
-/**
- * @deprecated use "metabase/api" instead
- */
-export const Databases = createEntity({
- name: "databases",
- path: "/api/database",
- schema: DatabaseSchema,
-
- nameOne: "database",
- nameMany: "databases",
-
- rtk: () => ({
- getUseGetQuery: (fetchType) => {
- if (fetchType === "fetchDatabaseMetadata") {
- return {
- useGetQuery: useGetDatabaseMetadataQuery,
- };
- }
-
- return {
- useGetQuery: useGetDatabaseQuery,
- };
- },
- useListQuery: useListDatabasesQuery,
- }),
-
- api: {
- list: (entityQuery, dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- databaseApi.endpoints.listDatabases,
- ),
- get: (entityQuery, options, dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- databaseApi.endpoints.getDatabase,
- ),
- create: (entityQuery, dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- databaseApi.endpoints.createDatabase,
- ),
- update: (entityQuery, dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- databaseApi.endpoints.updateDatabase,
- ),
- delete: ({ id }, dispatch) =>
- entityCompatibleQuery(id, dispatch, databaseApi.endpoints.deleteDatabase),
- addSampleDatabase: (dispatch) =>
- entityCompatibleQuery(
- undefined,
- dispatch,
- databaseApi.endpoints.addSampleDatabase,
- ),
- },
-
- // ACTION CREATORS
- objectActions: {
- fetchDatabaseMetadata: createThunkAction(
- FETCH_DATABASE_METADATA,
- ({ id }, { reload = false, params } = {}) =>
- (dispatch, getState) =>
- fetchData({
- dispatch,
- getState,
- requestStatePath: ["metadata", "databases", id],
- existingStatePath: ["metadata", "databases", id],
- getData: async () => {
- const databaseMetadata = await entityCompatibleQuery(
- { id, ...params },
- dispatch,
- databaseApi.endpoints.getDatabaseMetadata,
- );
- return normalize(databaseMetadata, DatabaseSchema);
- },
- reload,
- }),
- ),
- },
-
- selectors: {
- getObject: (state, { entityId }) => getMetadata(state).database(entityId),
-
- // these unfiltered selectors include hidden tables/fields for display in the admin panel
- getObjectUnfiltered: (state, { entityId }) =>
- getMetadataUnfiltered(state).database(entityId),
-
- getListUnfiltered: (state, { entityQuery }) => {
- const entityIds =
- Databases.selectors.getEntityIds(state, { entityQuery }) ?? [];
- return entityIds.map((entityId) =>
- Databases.selectors.getObjectUnfiltered(state, { entityId }),
- );
- },
-
- getHasSampleDatabase: (state, props) =>
- _.any(Databases.selectors.getList(state, props), (db) => db.is_sample),
-
- getIdFields: createSelector(
- [
- (state) => getMetadata(state).fieldsList(),
- (state, props) => props.databaseId,
- ],
- (fields, databaseId) =>
- fields.filter((field) => {
- const dbId = field?.table?.db_id;
- const isRealField = !isVirtualCardId(field.table_id);
- return dbId === databaseId && isRealField && field.isPK();
- }),
- ),
- },
-});
diff --git a/frontend/src/metabase/entities/index.ts b/frontend/src/metabase/entities/index.ts
index ee6db6721fc..5830ecb6bbb 100644
--- a/frontend/src/metabase/entities/index.ts
+++ b/frontend/src/metabase/entities/index.ts
@@ -70,5 +70,4 @@
export { Questions as questions } from "./questions";
-export { Databases as databases } from "./databases";
export { Tables as tables } from "./tables";
diff --git a/frontend/src/metabase/entities/utils.ts b/frontend/src/metabase/entities/utils.ts
index fb4e0f92a96..901d75194e8 100644
--- a/frontend/src/metabase/entities/utils.ts
+++ b/frontend/src/metabase/entities/utils.ts
@@ -975,6 +975,7 @@ type CombinedEntities = {
const RETIRED_ENTITY_NAMES = [
"collections",
"dashboards",
+ "databases",
"fields",
"measures",
"metrics",
diff --git a/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx b/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx
index 8fac2b805a0..424994830e4 100644
--- a/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx
+++ b/frontend/src/metabase/models/components/ModelActions/ModelActionDetails/ModelActionDetails.tsx
@@ -2,12 +2,17 @@ import { useCallback, useMemo } from "react";
import { t } from "ttag";
import _ from "underscore";
-import { useDeleteActionMutation, useListActionsQuery } from "metabase/api";
+import {
+ useDeleteActionMutation,
+ useListActionsQuery,
+ useListDatabasesQuery,
+} from "metabase/api";
import { useSetArchive } from "metabase/archive/hooks";
import { Button } from "metabase/common/components/Button";
import { Link } from "metabase/common/components/Link";
import { useConfirmation } from "metabase/common/hooks/use-confirmation";
-import { Databases } from "metabase/entities/databases";
+import { useSelector } from "metabase/redux";
+import { getMetadata } from "metabase/selectors/metadata";
import * as Urls from "metabase/urls";
import { parseTimestamp } from "metabase/utils/time-dayjs";
import type Question from "metabase-lib/v1/Question";
@@ -16,7 +21,6 @@ import {
canEditAction,
canRunAction,
} from "metabase-lib/v1/actions/utils";
-import type Database from "metabase-lib/v1/metadata/Database";
import type { Card, WritebackAction } from "metabase-types/api";
import {
@@ -40,13 +44,11 @@ interface OwnProps {
model: Question;
}
-interface DatabaseLoaderProps {
- databases: Database[];
-}
-
-type Props = OwnProps & DatabaseLoaderProps;
+type Props = OwnProps;
-function ModelActionDetails({ model, databases }: Props) {
+function ModelActionDetails({ model }: Props) {
+ useListDatabasesQuery();
+ const databases = useSelector((state) => getMetadata(state).databasesList());
const { data: actions = [] } = useListActionsQuery({
"model-id": model.id(),
});
@@ -204,4 +206,4 @@ function mostRecentFirst(action: WritebackAction) {
}
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default _.compose(Databases.loadList())(ModelActionDetails);
+export default ModelActionDetails;
diff --git a/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx b/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx
index cfd0ef361d2..605303e232d 100644
--- a/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx
+++ b/frontend/src/metabase/models/containers/ModelActions/ModelActions.tsx
@@ -4,9 +4,8 @@ import { replace } from "react-router-redux";
import { useMount } from "react-use";
import _ from "underscore";
-import { useListActionsQuery } from "metabase/api";
+import { useListActionsQuery, useListDatabasesQuery } from "metabase/api";
import { NotFound } from "metabase/common/components/ErrorPages";
-import { Databases } from "metabase/entities/databases";
import { Questions } from "metabase/entities/questions";
import { Tables } from "metabase/entities/tables";
import { usePageTitle } from "metabase/hooks/use-page-title";
@@ -52,6 +51,7 @@ function ModelActions({
fetchTableForeignKeys,
onChangeLocation,
}: Props) {
+ useListDatabasesQuery();
const { data: actions = [] } = useListActionsQuery({
"model-id": model.id(),
});
@@ -119,7 +119,6 @@ function getModelId(state: State, props: OwnProps) {
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
Questions.load({ id: getModelId, entityAlias: "model" }),
- Databases.loadList(),
connect<null, DispatchProps, OwnProps & EntityLoadersProps, State>(
null,
mapDispatchToProps,
diff --git a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/MainNavbarContainer.tsx b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/MainNavbarContainer.tsx
index 23eae5ff9b5..8bc0a62a1be 100644
--- a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/MainNavbarContainer.tsx
+++ b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbarContainer/MainNavbarContainer.tsx
@@ -1,12 +1,12 @@
import type { LocationDescriptor } from "history";
import { memo, useCallback, useMemo, useState } from "react";
import { t } from "ttag";
-import _ from "underscore";
import {
useGetCollectionQuery,
useListBookmarksQuery,
useListCollectionsTreeQuery,
+ useListDatabasesQuery,
useReorderBookmarksMutation,
} from "metabase/api";
import { logout } from "metabase/auth/actions";
@@ -20,7 +20,6 @@ import {
nonPersonalOrArchivedCollection,
} from "metabase/collections/utils";
import { Modal } from "metabase/common/components/Modal";
-import { Databases } from "metabase/entities/databases";
import { PLUGIN_TENANTS } from "metabase/plugins";
import { connect, useDispatch, useSelector } from "metabase/redux";
import type { State } from "metabase/redux/store";
@@ -31,7 +30,6 @@ import {
getUserCanWriteToCollections,
} from "metabase/selectors/user";
import * as Urls from "metabase/urls";
-import type Database from "metabase-lib/v1/metadata/Database";
import type { Collection, User } from "metabase-types/api";
import { NavbarErrorView } from "../NavbarErrorView";
@@ -42,10 +40,9 @@ import { MainNavbarView } from "./MainNavbarView";
type NavbarModal = "MODAL_NEW_COLLECTION" | null;
-function mapStateToProps(_state: State, { databases = [] }: DatabaseProps) {
+function mapStateToProps(state: State) {
return {
- currentUser: getUser(_state),
- hasDataAccess: databases.length > 0,
+ currentUser: getUser(state),
};
}
@@ -54,25 +51,16 @@ const mapDispatchToProps = {
};
interface Props extends MainNavbarProps {
- currentUser: User;
- databases: Database[];
+ currentUser: User | null;
selectedItems: SelectedItem[];
- hasDataAccess: boolean;
- allError: boolean;
- allFetched: boolean;
logout: () => void;
onChangeLocation: (location: LocationDescriptor) => void;
}
-interface DatabaseProps {
- databases?: Database[];
-}
-
function MainNavbarContainer({
selectedItems,
isOpen,
currentUser,
- hasDataAccess,
location,
params,
openNavbar,
@@ -81,6 +69,12 @@ function MainNavbarContainer({
onChangeLocation,
...props
}: Props) {
+ const {
+ data: databasesResponse,
+ isLoading: isLoadingDatabases,
+ error: databasesError,
+ } = useListDatabasesQuery();
+ const hasDataAccess = (databasesResponse?.data.length ?? 0) > 0;
const [modal, setModal] = useState<NavbarModal>(null);
const canWriteToCollections = useSelector(getUserCanWriteToCollections);
const isTenantUser = useSelector(getIsTenantUser);
@@ -121,7 +115,7 @@ function MainNavbarContainer({
const preparedCollections = [];
const userPersonalCollections = currentUserPersonalCollections(
collections,
- currentUser.id,
+ currentUser!.id,
);
const displayableCollections = collections.filter((collection) =>
nonPersonalOrArchivedCollection(collection),
@@ -202,13 +196,11 @@ function MainNavbarContainer({
return null;
}, [modal, closeModal, onChangeLocation]);
- const allError = props.allError || !!error;
- if (allError) {
+ if (error || databasesError) {
return <NavbarErrorView />;
}
- const allFetched = props.allFetched && !isLoading;
- if (!allFetched) {
+ if (isLoading || isLoadingDatabases) {
return <NavbarLoadingView />;
}
@@ -237,9 +229,7 @@ function MainNavbarContainer({
}
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default _.compose(
- Databases.loadList({
- loadingAndErrorWrapper: false,
- }),
- connect(mapStateToProps, mapDispatchToProps),
+export default connect(
+ mapStateToProps,
+ mapDispatchToProps,
)(memo(MainNavbarContainer));
diff --git a/frontend/src/metabase/nav/containers/Navbar.tsx b/frontend/src/metabase/nav/containers/Navbar.tsx
index ea878028356..02670226a53 100644
--- a/frontend/src/metabase/nav/containers/Navbar.tsx
+++ b/frontend/src/metabase/nav/containers/Navbar.tsx
@@ -1,10 +1,8 @@
-import type { Location } from "history";
import { useMemo } from "react";
-import { withRouter } from "react-router";
-import _ from "underscore";
+import { type WithRouterProps, withRouter } from "react-router";
import { getAdminPaths } from "metabase/admin/app/selectors";
-import { Databases } from "metabase/entities/databases";
+import { useListDatabasesQuery } from "metabase/api";
import { connect } from "metabase/redux";
import type { AdminPath, State } from "metabase/redux/store";
import { getIsNavbarOpen } from "metabase/selectors/app";
@@ -15,11 +13,9 @@ import { AdminNavbar } from "../components/AdminNavbar";
import MainNavbar from "./MainNavbar";
-type NavbarProps = {
+type NavbarProps = WithRouterProps & {
isOpen: boolean;
- user: User;
- location: Location;
- params: Record<string, unknown>;
+ user: User | null;
adminPaths: AdminPath[];
};
@@ -30,6 +26,7 @@ const mapStateToProps = (state: State) => ({
});
function Navbar({ isOpen, user, location, params, adminPaths }: NavbarProps) {
+ useListDatabasesQuery();
const isAdminApp = useMemo(
() => location.pathname.startsWith("/admin/"),
[location.pathname],
@@ -47,10 +44,4 @@ function Navbar({ isOpen, user, location, params, adminPaths }: NavbarProps) {
}
// eslint-disable-next-line import/no-default-export -- deprecated usage
-export default _.compose(
- Databases.loadList({
- loadingAndErrorWrapper: false,
- }),
- withRouter,
- connect(mapStateToProps),
-)(Navbar);
+export default withRouter(connect(mapStateToProps)(Navbar));
diff --git a/frontend/src/metabase/query_builder/actions/core/core.ts b/frontend/src/metabase/query_builder/actions/core/core.ts
index 88214a99c00..65d4ae7e4bb 100644
--- a/frontend/src/metabase/query_builder/actions/core/core.ts
+++ b/frontend/src/metabase/query_builder/actions/core/core.ts
@@ -1,11 +1,15 @@
import _ from "underscore";
-import { invalidateNotificationsApiCache, revisionApi } from "metabase/api";
+import {
+ databaseApi,
+ invalidateNotificationsApiCache,
+ revisionApi,
+} from "metabase/api";
+import { listTag } from "metabase/api/tags";
import {
cardIsEquivalent,
cardQueryIsEquivalent,
} from "metabase/common/utils/card";
-import { Databases } from "metabase/entities/databases";
import { Questions } from "metabase/entities/questions";
import { entityCompatibleQuery } from "metabase/entities/utils";
import { loadMetadataForCard } from "metabase/questions/actions";
@@ -32,12 +36,7 @@ import * as Lib from "metabase-lib";
import Question from "metabase-lib/v1/Question";
import { isAdHocModelOrMetricQuestion } from "metabase-lib/v1/metadata/utils/models";
import NativeQuery from "metabase-lib/v1/queries/NativeQuery";
-import type {
- Card,
- DashboardTabId,
- Database,
- DatasetQuery,
-} from "metabase-types/api";
+import type { Card, DashboardTabId, DatasetQuery } from "metabase-types/api";
import { trackNewQuestionSaved } from "../../analytics";
import { updateModelIndexes } from "../../model-indexes/actions";
@@ -237,9 +236,9 @@ export const apiCreateQuestion = (
options,
);
- const databases: Database[] = Databases.selectors.getList(getState());
+ const databases = getMetadata(getState()).databasesList();
if (databases && !databases.some((d) => d.is_saved_questions)) {
- dispatch({ type: Databases.actionTypes.INVALIDATE_LISTS_ACTION });
+ dispatch(databaseApi.util.invalidateTags([listTag("database")]));
}
trackNewQuestionSaved(
diff --git a/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts b/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts
index e737ac0918d..4c66260f170 100644
--- a/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts
+++ b/frontend/src/metabase/query_builder/actions/core/initializeQB.unit.spec.ts
@@ -4,7 +4,6 @@ import type { LocationDescriptorObject } from "history";
import { createMockEntitiesState } from "__support__/store";
import { snippetApi } from "metabase/api";
import * as CardLib from "metabase/common/utils/card";
-import { Databases } from "metabase/entities/databases";
import * as questionActions from "metabase/questions/actions";
import { setErrorPage } from "metabase/redux/app";
import * as sharedQB from "metabase/redux/query-builder";
@@ -639,10 +638,6 @@ describe("QB Actions > initializeQB", () => {
});
it("does not load snippets if missing DB write permissions", async () => {
- Databases.selectors.getObject = jest.fn().mockReturnValue({
- native_permissions: "none",
- });
-
const { initiateSpy } = await setupSnippets({
hasDatabaseWritePermission: false,
});
diff --git a/frontend/src/metabase/query_builder/components/view/QuestionRowCount/QuestionRowCount.tsx b/frontend/src/metabase/query_builder/components/view/QuestionRowCount/QuestionRowCount.tsx
index 50f41605622..53cf1fa1cab 100644
--- a/frontend/src/metabase/query_builder/components/view/QuestionRowCount/QuestionRowCount.tsx
+++ b/frontend/src/metabase/query_builder/components/view/QuestionRowCount/QuestionRowCount.tsx
@@ -2,8 +2,8 @@ import { useDisclosure } from "@mantine/hooks";
import cx from "classnames";
import { useMemo } from "react";
import { t } from "ttag";
-import _ from "underscore";
+import { skipToken, useGetDatabaseQuery } from "metabase/api";
import {
type NumberFormatter,
useNumberFormatter,
@@ -11,7 +11,6 @@ import {
import { formatRowCount } from "metabase/common/utils/format-row-count";
import { getRowCountMessage } from "metabase/common/utils/get-row-count-message";
import CS from "metabase/css/core/index.css";
-import { Databases } from "metabase/entities/databases";
import { setLimit } from "metabase/query_builder/actions";
import { LimitPopover } from "metabase/query_builder/components/LimitPopover";
import {
@@ -38,22 +37,15 @@ interface OwnProps {
interface StateProps {
question: Question;
- result: Dataset;
+ result: Dataset | null;
isResultDirty: boolean;
}
-interface EntityLoaderProps {
- loading: boolean;
-}
-
interface DispatchProps {
onChangeLimit: (limit: Limit) => void;
}
-type QuestionRowCountProps = OwnProps &
- StateProps &
- DispatchProps &
- EntityLoaderProps;
+type QuestionRowCountProps = OwnProps & StateProps & DispatchProps;
function mapStateToProps(state: State) {
// Not expected to render before question is loaded
@@ -74,14 +66,20 @@ function QuestionRowCountInner({
question,
result,
isResultDirty,
- loading,
className,
onChangeLimit,
}: QuestionRowCountProps) {
const [opened, { close, toggle }] = useDisclosure(false);
+ const databaseId = question.databaseId();
+ const { isLoading: loading } = useGetDatabaseQuery(
+ databaseId != null ? { id: databaseId } : skipToken,
+ );
const { isEditable, isNative } = Lib.queryDisplayInfo(question.query());
const formatNumber = useNumberFormatter();
const message = useMemo(() => {
+ if (result == null) {
+ return "";
+ }
if (isNative) {
return isResultDirty ? "" : getRowCountMessage(result, formatNumber);
}
@@ -197,20 +195,13 @@ function getLimitMessage(
return t`Showing first ${formatRowCount(HARD_ROW_LIMIT, formatNumber)} rows`;
}
-function getDatabaseId(_state: State, { question }: OwnProps & StateProps) {
- return question.databaseId();
-}
-
-const ConnectedQuestionRowCount = _.compose(
- connect(mapStateToProps, mapDispatchToProps),
- Databases.load({
- id: getDatabaseId,
- loadingAndErrorWrapper: false,
- }),
+const ConnectedQuestionRowCount = connect(
+ mapStateToProps,
+ mapDispatchToProps,
)(QuestionRowCountInner);
export type QuestionRowCountOpts = {
- result?: Dataset;
+ result?: Dataset | null;
isObjectDetail: boolean;
};
diff --git a/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx b/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx
index d12260a136b..5cc4f25b95d 100644
--- a/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx
+++ b/frontend/src/metabase/querying/common/components/DataSelector/DataSelector.jsx
@@ -6,16 +6,18 @@ import { t } from "ttag";
import _ from "underscore";
import {
+ databaseApi,
useLazyListDatabaseSchemaTablesQuery,
useLazyListDatabaseSchemasQuery,
+ useListDatabasesQuery,
useSearchQuery,
} from "metabase/api";
import { EmptyState } from "metabase/common/components/EmptyState";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import CS from "metabase/css/core/index.css";
-import { Databases } from "metabase/entities/databases";
import { Questions } from "metabase/entities/questions";
import { Tables } from "metabase/entities/tables";
+import { entityCompatibleQuery } from "metabase/entities/utils";
import { connect } from "metabase/redux";
import { getMetadata } from "metabase/selectors/metadata";
import { getSetting } from "metabase/selectors/settings";
@@ -183,7 +185,6 @@ export class UnconnectedDataSelector extends Component {
delete: PropTypes.func,
reload: PropTypes.func,
list: PropTypes.arrayOf(PropTypes.object),
- allDatabases: PropTypes.arrayOf(PropTypes.object),
};
static defaultProps = {
@@ -1126,46 +1127,72 @@ function withAvailableModels(WrappedComponent) {
};
}
+function withAllDatabases(WrappedComponent) {
+ return function DataSelectorWithAllDatabases(props) {
+ useListDatabasesQuery();
+ return <WrappedComponent {...props} />;
+ };
+}
+
+const isListDatabasesQuerySuccess = (state, query) =>
+ databaseApi.endpoints.listDatabases.select(query)(state).isSuccess;
+
const DataSelector = _.compose(
- Databases.loadList({
- loadingAndErrorWrapper: false,
- listName: "allDatabases",
- }),
+ withAllDatabases,
withAvailableModels,
withSchemaFetchers,
connect(
- (state, ownProps) => ({
- availableModels: ownProps.metadata?.available_models ?? [],
- metadata: getMetadata(state),
- databases:
- ownProps.databases ||
- Databases.selectors.getList(state, {
- entityQuery: { ...ownProps.databaseQuery, "can-query": true },
- }) ||
- [],
- hasLoadedDatabasesWithTablesSaved: Databases.selectors.getLoaded(state, {
- entityQuery: { include: "tables", saved: true, "can-query": true },
- }),
- hasLoadedDatabasesWithSaved: Databases.selectors.getLoaded(state, {
- entityQuery: { saved: true, "can-query": true },
- }),
- hasLoadedDatabasesWithTables: Databases.selectors.getLoaded(state, {
- entityQuery: { include: "tables", "can-query": true },
- }),
- hasDataAccess: canUserCreateQueries(state),
- hasNestedQueriesEnabled: getSetting(state, "enable-nested-queries"),
- selectedQuestion: Questions.selectors.getObject(state, {
- entityId: getQuestionIdFromVirtualTableId(ownProps.selectedTableId),
- }),
- }),
- {
- fetchDatabases: (databaseQuery) =>
- Databases.actions.fetchList({ ...databaseQuery, "can-query": true }),
- fetchFields: (tableId) => Tables.actions.fetchMetadata({ id: tableId }),
- fetchQuestion: (id) =>
- Questions.actions.fetch({
- id: getQuestionIdFromVirtualTableId(id),
+ (state, ownProps) => {
+ const databaseQuery = { ...ownProps.databaseQuery, "can-query": true };
+ const queriedDatabases =
+ databaseApi.endpoints.listDatabases.select(databaseQuery)(state).data
+ ?.data;
+ const metadata = getMetadata(state);
+ return {
+ availableModels: ownProps.metadata?.available_models ?? [],
+ metadata,
+ databases:
+ ownProps.databases ||
+ queriedDatabases
+ ?.map(({ id }) => metadata.database(id))
+ .filter((database) => database != null) ||
+ [],
+ hasLoadedDatabasesWithTablesSaved: isListDatabasesQuerySuccess(state, {
+ include: "tables",
+ saved: true,
+ "can-query": true,
}),
+ hasLoadedDatabasesWithSaved: isListDatabasesQuerySuccess(state, {
+ saved: true,
+ "can-query": true,
+ }),
+ hasLoadedDatabasesWithTables: isListDatabasesQuerySuccess(state, {
+ include: "tables",
+ "can-query": true,
+ }),
+ hasDataAccess: canUserCreateQueries(state),
+ hasNestedQueriesEnabled: getSetting(state, "enable-nested-queries"),
+ selectedQuestion: Questions.selectors.getObject(state, {
+ entityId: getQuestionIdFromVirtualTableId(ownProps.selectedTableId),
+ }),
+ };
},
+ (dispatch) => ({
+ fetchDatabases: (databaseQuery) =>
+ entityCompatibleQuery(
+ { ...databaseQuery, "can-query": true },
+ dispatch,
+ databaseApi.endpoints.listDatabases,
+ { forceRefetch: false },
+ ),
+ fetchFields: (tableId) =>
+ dispatch(Tables.actions.fetchMetadata({ id: tableId })),
+ fetchQuestion: (id) =>
+ dispatch(
+ Questions.actions.fetch({
+ id: getQuestionIdFromVirtualTableId(id),
+ }),
+ ),
+ }),
),
)(UnconnectedDataSelector);
diff --git a/frontend/src/metabase/querying/selectors.ts b/frontend/src/metabase/querying/selectors.ts
index e61e238b881..ddec4c42f2e 100644
--- a/frontend/src/metabase/querying/selectors.ts
+++ b/frontend/src/metabase/querying/selectors.ts
@@ -1,16 +1,12 @@
import { createSelector } from "@reduxjs/toolkit";
import _ from "underscore";
-import { Databases } from "metabase/entities/databases";
import type { State } from "metabase/redux/store";
-import type { Database } from "metabase-types/api";
-
-const getDatabasesListDefaultValue: Database[] = [];
+import { getMetadata } from "metabase/selectors/metadata";
+import type Database from "metabase-lib/v1/metadata/Database";
export const getDatabasesList = (state: State): Database[] =>
- Databases.selectors.getList(state, {
- entityQuery: { include: "tables", saved: true },
- }) || getDatabasesListDefaultValue;
+ getMetadata(state).databasesList();
export const getSampleDatabaseId = createSelector(
[getDatabasesList],
diff --git a/frontend/src/metabase/redux/databases.ts b/frontend/src/metabase/redux/databases.ts
index df694ddd4a7..e872f62d655 100644
--- a/frontend/src/metabase/redux/databases.ts
+++ b/frontend/src/metabase/redux/databases.ts
@@ -1,7 +1,10 @@
import _ from "underscore";
-import { Databases } from "metabase/entities/databases";
+import { databaseApi } from "metabase/api";
+import { entityCompatibleQuery } from "metabase/entities/utils";
+import { updateMetadata } from "metabase/redux/metadata-typed";
import type { Dispatch } from "metabase/redux/store";
+import { DatabaseSchema } from "metabase/schema";
import type { DatabaseData } from "metabase-types/api";
export const editParamsForUserControlledScheduling = _.compose(
@@ -42,9 +45,12 @@ export const createDatabase = function (inputDatabase: DatabaseData) {
return async function (dispatch: Dispatch) {
try {
- const action = await dispatch(Databases.actions.create(database));
- const savedDatabase = Databases.HACK_getObjectFromAction(action);
-
+ const savedDatabase = await entityCompatibleQuery(
+ database,
+ dispatch,
+ databaseApi.endpoints.createDatabase,
+ );
+ dispatch(updateMetadata(savedDatabase, DatabaseSchema));
return savedDatabase;
} catch (error) {
console.error("error creating a database", error);
diff --git a/frontend/src/metabase/redux/metadata.js b/frontend/src/metabase/redux/metadata.js
index dd08fe879fc..b94bc8ab3b1 100644
--- a/frontend/src/metabase/redux/metadata.js
+++ b/frontend/src/metabase/redux/metadata.js
@@ -4,16 +4,16 @@ import _ from "underscore";
import {
cardApi,
dashboardApi,
+ databaseApi,
datasetApi,
fieldApi,
segmentApi,
} from "metabase/api";
-import { Databases } from "metabase/entities/databases";
import { Tables } from "metabase/entities/tables";
import { entityCompatibleQuery } from "metabase/entities/utils";
import { isProduction } from "metabase/env";
import { createThunkAction } from "metabase/redux";
-import { FieldSchema } from "metabase/schema";
+import { DatabaseSchema, FieldSchema } from "metabase/schema";
import { RevisionsApi } from "metabase/services";
import { normalizeParameter } from "metabase-lib/v1/parameters/utils/parameter-values";
@@ -47,20 +47,40 @@ export const updateSegment = (segment) => (dispatch) => {
);
};
-export const fetchRealDatabases = (reload = false) => {
- deprecated("metabase/redux/metadata fetchRealDatabases");
- return Databases.actions.fetchList({ include: "tables" }, { reload });
-};
+export const fetchRealDatabases =
+ (reload = false) =>
+ (dispatch) => {
+ deprecated("metabase/redux/metadata fetchRealDatabases");
+ return entityCompatibleQuery(
+ { include: "tables" },
+ dispatch,
+ databaseApi.endpoints.listDatabases,
+ { forceRefetch: reload },
+ );
+ };
-export const fetchDatabaseMetadata = (dbId, reload = false) => {
- deprecated("metabase/redux/metadata fetchDatabaseMetadata");
- return Databases.actions.fetchDatabaseMetadata({ id: dbId }, { reload });
-};
+export const fetchDatabaseMetadata =
+ (dbId, reload = false) =>
+ (dispatch) => {
+ deprecated("metabase/redux/metadata fetchDatabaseMetadata");
+ return entityCompatibleQuery(
+ { id: dbId },
+ dispatch,
+ databaseApi.endpoints.getDatabaseMetadata,
+ { forceRefetch: reload },
+ );
+ };
-export const updateDatabase = (database) => {
+export const updateDatabase = (database) => async (dispatch) => {
deprecated("metabase/redux/metadata updateDatabase");
const slimDatabase = _.omit(database, "tables", "tables_lookup");
- return Databases.actions.update(slimDatabase);
+ const result = await entityCompatibleQuery(
+ slimDatabase,
+ dispatch,
+ databaseApi.endpoints.updateDatabase,
+ );
+ dispatch(updateMetadata(result, DatabaseSchema));
+ return result;
};
export const updateTable = (table) => {