Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor: migrate db schema store to react app (#20458)

ecmadaofa02a1663748
diff --git a/frontend/src/plugins/ai/react/context.tsx b/frontend/src/plugins/ai/react/context.tsx
index 26156422ef..ad385bf7cf 100644
--- a/frontend/src/plugins/ai/react/context.tsx
+++ b/frontend/src/plugins/ai/react/context.tsx
@@ -9,13 +9,14 @@ import {
useRef,
useState,
} from "react";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import { useVueState } from "@/react/hooks/useVueState";
import {
getCurrentSQLEditorTab,
useCurrentSQLEditorTab,
} from "@/react/stores/sqlEditor/tab";
-import { useDBSchemaV1Store, useSettingV1Store } from "@/store";
+import { useSettingV1Store } from "@/store";
import { Engine } from "@/types/proto-es/v1/common_pb";
import type { DatabaseMetadata } from "@/types/proto-es/v1/database_service_pb";
import type { AISetting } from "@/types/proto-es/v1/setting_service_pb";
@@ -118,25 +119,12 @@ export function AIContextProvider({ children }: { children: ReactNode }) {
const { instance, database } = useConnectionOfCurrentSQLEditorTab();
const engine: Engine | undefined = instance.engine;
- // Fetch database metadata on database change (mirrors Vue
- // `useMetadata`'s `watchEffect` + cache read). `useDBSchemaV1Store`
- // dedupes concurrent fetches, so firing this from the React effect
- // doesn't race with another caller. We read the cache via
- // `useVueState` (re-subscribed per database) so cache hydration
- // triggers a re-render.
+ // `useAppDatabaseMetadata` self-fetches and subscribes; the app-store
+ // dbSchema slice dedupes concurrent fetches, so this stays cheap even
+ // if another mount triggers the same fetch in parallel.
const databaseName = database.name;
- const dbSchemaStore = useDBSchemaV1Store();
- useEffect(() => {
- if (!databaseName) return;
- void dbSchemaStore.getOrFetchDatabaseMetadata({ database: databaseName });
- }, [databaseName, dbSchemaStore]);
- const databaseMetadata = useVueState<DatabaseMetadata | undefined>(
- () =>
- databaseName
- ? dbSchemaStore.getDatabaseMetadata(databaseName)
- : undefined,
- { deps: [databaseName] }
- );
+ const fetchedMetadata = useAppDatabaseMetadata(databaseName ?? "");
+ const databaseMetadata = databaseName ? fetchedMetadata : undefined;
const schema: string | undefined = currentTab?.connection.schema;
diff --git a/frontend/src/react/components/DatabaseResourceSelector.test.tsx b/frontend/src/react/components/DatabaseResourceSelector.test.tsx
index de72cc2bce..3e50b45dc8 100644
--- a/frontend/src/react/components/DatabaseResourceSelector.test.tsx
+++ b/frontend/src/react/components/DatabaseResourceSelector.test.tsx
@@ -97,10 +97,18 @@ vi.mock("@/react/components/AdvancedSearch", () => ({
),
}));
-vi.mock("@/store/modules/v1/dbSchema", () => ({
- useDBSchemaV1Store: () => ({
- getOrFetchDatabaseMetadata: mocks.getOrFetchDatabaseMetadata,
- }),
+vi.mock("@/react/stores/app", () => ({
+ useAppStore: Object.assign(
+ (selector: (state: unknown) => unknown) =>
+ selector({
+ getOrFetchDatabaseMetadata: mocks.getOrFetchDatabaseMetadata,
+ }),
+ {
+ getState: () => ({
+ getOrFetchDatabaseMetadata: mocks.getOrFetchDatabaseMetadata,
+ }),
+ }
+ ),
}));
vi.mock("@/react/components/EnvironmentLabel", () => ({
diff --git a/frontend/src/react/components/DatabaseResourceSelector.tsx b/frontend/src/react/components/DatabaseResourceSelector.tsx
index 99826e598a..d5759ecedb 100644
--- a/frontend/src/react/components/DatabaseResourceSelector.tsx
+++ b/frontend/src/react/components/DatabaseResourceSelector.tsx
@@ -19,12 +19,12 @@ import {
import { EnvironmentLabel } from "@/react/components/EnvironmentLabel";
import { Checkbox } from "@/react/components/ui/checkbox";
import { useVueState } from "@/react/hooks/useVueState";
+import { useAppStore } from "@/react/stores/app";
import {
useDatabaseV1Store,
useEnvironmentV1Store,
useInstanceV1Store,
} from "@/store";
-import { useDBSchemaV1Store } from "@/store/modules/v1/dbSchema";
import type { DatabaseResource } from "@/types";
import { Engine } from "@/types/proto-es/v1/common_pb";
import type {
@@ -100,7 +100,9 @@ export function DatabaseResourceSelector({
}) {
const { t } = useTranslation();
const databaseStore = useDatabaseV1Store();
- const dbSchemaStore = useDBSchemaV1Store();
+ const getOrFetchDatabaseMetadata = useAppStore(
+ (s) => s.getOrFetchDatabaseMetadata
+ );
const environmentStore = useEnvironmentV1Store();
const instanceStore = useInstanceV1Store();
@@ -694,7 +696,7 @@ export function DatabaseResourceSelector({
if (!metadataMap.has(dbName) && !loadingMetadata.has(dbName)) {
setLoadingMetadata((prev) => new Set(prev).add(dbName));
try {
- const metadata = await dbSchemaStore.getOrFetchDatabaseMetadata({
+ const metadata = await getOrFetchDatabaseMetadata({
database: dbName,
});
setMetadataMap((prev) => new Map(prev).set(dbName, metadata));
@@ -711,7 +713,12 @@ export function DatabaseResourceSelector({
}
setExpandedDatabases(next);
},
- [expandedDatabases, metadataMap, loadingMetadata, dbSchemaStore]
+ [
+ expandedDatabases,
+ metadataMap,
+ loadingMetadata,
+ getOrFetchDatabaseMetadata,
+ ]
);
const toggleExpandSchema = useCallback(
diff --git a/frontend/src/react/components/sql-editor/ContainerChooser.test.tsx b/frontend/src/react/components/sql-editor/ContainerChooser.test.tsx
index 9e752b9e86..5ee74078bc 100644
--- a/frontend/src/react/components/sql-editor/ContainerChooser.test.tsx
+++ b/frontend/src/react/components/sql-editor/ContainerChooser.test.tsx
@@ -9,11 +9,14 @@ import { beforeEach, describe, expect, test, vi } from "vitest";
const mocks = vi.hoisted(() => ({
useTranslation: vi.fn(() => ({ t: (key: string) => key })),
- usePiniaBridge: vi.fn<(getter: () => unknown) => unknown>(),
tabTable: undefined as string | undefined,
currentTabId: "tab1",
getSQLEditorTabsState: vi.fn(),
- useDBSchemaV1Store: vi.fn(),
+ // Default schemas shape — tests override `mocks.metadata` to drive
+ // different option lists.
+ metadata: {
+ schemas: [] as Array<{ name: string; tables: { name: string }[] }>,
+ },
useConnectionOfCurrentSQLEditorTab: vi.fn(),
router: {
currentRoute: { value: { query: {} } },
@@ -25,12 +28,8 @@ vi.mock("react-i18next", () => ({
useTranslation: mocks.useTranslation,
}));
-vi.mock("@/react/hooks/usePiniaBridge", () => ({
- usePiniaBridge: mocks.usePiniaBridge,
-}));
-
-vi.mock("@/store", () => ({
- useDBSchemaV1Store: mocks.useDBSchemaV1Store,
+vi.mock("@/react/hooks/useAppDatabaseMetadata", () => ({
+ useAppDatabaseMetadata: () => mocks.metadata,
}));
vi.mock("@/react/hooks/useSQLEditorBridge", () => ({
@@ -131,17 +130,14 @@ beforeEach(async () => {
tabsById: new Map([["tab1", { connection: {} }]]),
updateCurrentTab: vi.fn(),
});
- mocks.useDBSchemaV1Store.mockReturnValue({
- getDatabaseMetadata: vi.fn(() => ({
- schemas: [
- {
- name: "default",
- tables: [{ name: "container1" }, { name: "container2" }],
- },
- ],
- })),
- });
- mocks.usePiniaBridge.mockImplementation((getter) => getter());
+ mocks.metadata = {
+ schemas: [
+ {
+ name: "default",
+ tables: [{ name: "container1" }, { name: "container2" }],
+ },
+ ],
+ };
({ ContainerChooser } = await import("./ContainerChooser"));
});
diff --git a/frontend/src/react/components/sql-editor/ContainerChooser.tsx b/frontend/src/react/components/sql-editor/ContainerChooser.tsx
index d57bfe6350..bc3765e506 100644
--- a/frontend/src/react/components/sql-editor/ContainerChooser.tsx
+++ b/frontend/src/react/components/sql-editor/ContainerChooser.tsx
@@ -1,13 +1,12 @@
import { useEffect, useMemo } from "react";
import { useTranslation } from "react-i18next";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import { useVueRoute } from "@/react/hooks/useVueRoute";
import {
getSQLEditorTabsState,
useSQLEditorTabState,
} from "@/react/stores/sqlEditor/tab";
-import { useDBSchemaV1Store } from "@/store";
import { Engine } from "@/types/proto-es/v1/common_pb";
import { ConnectChooser } from "./ConnectChooser";
@@ -20,7 +19,6 @@ const OptionValueUnspecified = "-1";
*/
export function ContainerChooser() {
const { t } = useTranslation();
- const dbSchemaStore = useDBSchemaV1Store();
const { instance, database } = useConnectionOfCurrentSQLEditorTab();
const engine = instance.engine;
@@ -28,9 +26,11 @@ export function ContainerChooser() {
const tabTable = useSQLEditorTabState(
(s) => s.tabsById.get(s.currentTabId)?.connection.table
);
- const schemas = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName).schemas
- );
+ // Parent SchemaPane (E4 migration) drives the metadata fetch; here we
+ // only need the cached read.
+ const { schemas } = useAppDatabaseMetadata(databaseName, {
+ autoFetch: false,
+ });
const show = engine === Engine.COSMOSDB;
diff --git a/frontend/src/react/components/sql-editor/DiagramPanel.tsx b/frontend/src/react/components/sql-editor/DiagramPanel.tsx
index 15dab428e6..1db03177cf 100644
--- a/frontend/src/react/components/sql-editor/DiagramPanel.tsx
+++ b/frontend/src/react/components/sql-editor/DiagramPanel.tsx
@@ -1,22 +1,20 @@
import { SchemaDiagram } from "@/react/components/SchemaDiagram";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
-import { useDBSchemaV1Store } from "@/store";
/**
* React port of `frontend/src/views/sql-editor/EditorPanel/Panels/DiagramPanel/DiagramPanel.vue`.
*
* Reads the current tab's database from the SQL Editor connection
- * store + its metadata from `useDBSchemaV1Store`, and forwards both
+ * store + its metadata from the app store, and forwards both
* to `<SchemaDiagram>`. Mounted by `Panels.vue` via `ReactPageMount`.
*/
export function DiagramPanel() {
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(database.name),
- { deep: true }
- );
+ // Parent `Panels.tsx` drives the metadata fetch; we only subscribe.
+ const databaseMetadata = useAppDatabaseMetadata(database.name, {
+ autoFetch: false,
+ });
return (
<div className="w-full h-full bb-react-schema-diagram">
diff --git a/frontend/src/react/components/sql-editor/Panels/ExternalTablesPanel/ExternalTablesPanel.tsx b/frontend/src/react/components/sql-editor/Panels/ExternalTablesPanel/ExternalTablesPanel.tsx
index 345c5660ee..1a0464d89d 100644
--- a/frontend/src/react/components/sql-editor/Panels/ExternalTablesPanel/ExternalTablesPanel.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/ExternalTablesPanel/ExternalTablesPanel.tsx
@@ -1,9 +1,8 @@
import { ChevronLeft, Table as TableIcon } from "lucide-react";
import { useState } from "react";
import { Button } from "@/react/components/ui/button";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
-import { useDBSchemaV1Store } from "@/store";
import { PanelSearchBox } from "../common/PanelSearchBox";
import { ColumnsTable } from "../common/tables/ColumnsTable";
import { useViewStateNav } from "../common/useViewStateNav";
@@ -15,14 +14,12 @@ import { ExternalTablesTable } from "./ExternalTablesTable";
* the CodeViewer/AI carve-out that gates other panels.
*/
export function ExternalTablesPanel() {
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
const db = database;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const {
schema: schemaName,
@@ -34,12 +31,12 @@ export function ExternalTablesPanel() {
const [tableKeyword, setTableKeyword] = useState("");
const [columnKeyword, setColumnKeyword] = useState("");
- const schema = databaseMetadata?.schemas.find((s) => s.name === schemaName);
+ const schema = databaseMetadata.schemas.find((s) => s.name === schemaName);
const externalTable = schema?.externalTables.find(
(t) => t.name === detail?.externalTable
);
- if (!db || !databaseMetadata || !schema) return null;
+ if (!db || !schema) return null;
return (
<div className="px-2 py-2 gap-y-2 h-full overflow-hidden flex flex-col">
diff --git a/frontend/src/react/components/sql-editor/Panels/FunctionsPanel/FunctionsPanel.tsx b/frontend/src/react/components/sql-editor/Panels/FunctionsPanel/FunctionsPanel.tsx
index b2be37b047..955a990a6f 100644
--- a/frontend/src/react/components/sql-editor/Panels/FunctionsPanel/FunctionsPanel.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/FunctionsPanel/FunctionsPanel.tsx
@@ -1,27 +1,24 @@
import { ChevronLeft, FunctionSquare } from "lucide-react";
import { useState } from "react";
import { Button } from "@/react/components/ui/button";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import {
extractKeyWithPosition,
keyWithPosition,
} from "@/react/lib/keyWithPosition";
-import { useDBSchemaV1Store } from "@/store";
import { CodeViewer } from "../common/CodeViewer";
import { PanelSearchBox } from "../common/PanelSearchBox";
import { useViewStateNav } from "../common/useViewStateNav";
import { FunctionsTable } from "./FunctionsTable";
export function FunctionsPanel() {
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
const db = database;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const {
schema: schemaName,
@@ -32,13 +29,13 @@ export function FunctionsPanel() {
const [keyword, setKeyword] = useState("");
- const schema = databaseMetadata?.schemas.find((s) => s.name === schemaName);
+ const schema = databaseMetadata.schemas.find((s) => s.name === schemaName);
const [funcName, funcPosition] = extractKeyWithPosition(detail?.func ?? "");
const func = schema?.functions.find(
(f, i) => f.name === funcName && i === funcPosition
);
- if (!db || !databaseMetadata || !schema) return null;
+ if (!db || !schema) return null;
if (func) {
return (
diff --git a/frontend/src/react/components/sql-editor/Panels/InfoPanel/InfoPanel.tsx b/frontend/src/react/components/sql-editor/Panels/InfoPanel/InfoPanel.tsx
index eb0098c10c..aa9c0f9abc 100644
--- a/frontend/src/react/components/sql-editor/Panels/InfoPanel/InfoPanel.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/InfoPanel/InfoPanel.tsx
@@ -1,10 +1,9 @@
import { useState } from "react";
import { useTranslation } from "react-i18next";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import { keyWithPosition } from "@/react/lib/keyWithPosition";
import { DatabaseOverviewInfo } from "@/react/pages/project/database-detail/overview/DatabaseOverviewInfo";
-import { useDBSchemaV1Store } from "@/store";
import {
getInstanceResource,
instanceV1SupportsExternalTable,
@@ -23,14 +22,12 @@ import { ViewsTable } from "../ViewsPanel/ViewsTable";
export function InfoPanel() {
const { t } = useTranslation();
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
const db = database;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const { schema: schemaName, updateViewState } = useViewStateNav();
@@ -42,7 +39,7 @@ export function InfoPanel() {
const [externalTables, setExternalTables] = useState("");
const [packages, setPackages] = useState("");
- if (!db || !databaseMetadata) return null;
+ if (!db) return null;
const schema = databaseMetadata.schemas.find((s) => s.name === schemaName);
const instance = getInstanceResource(db);
const showSequences = instanceV1SupportsSequence(instance);
diff --git a/frontend/src/react/components/sql-editor/Panels/PackagesPanel/PackagesPanel.tsx b/frontend/src/react/components/sql-editor/Panels/PackagesPanel/PackagesPanel.tsx
index edbb557c4d..8d53730518 100644
--- a/frontend/src/react/components/sql-editor/Panels/PackagesPanel/PackagesPanel.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/PackagesPanel/PackagesPanel.tsx
@@ -1,27 +1,24 @@
import { ChevronLeft, Package } from "lucide-react";
import { useState } from "react";
import { Button } from "@/react/components/ui/button";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import {
extractKeyWithPosition,
keyWithPosition,
} from "@/react/lib/keyWithPosition";
-import { useDBSchemaV1Store } from "@/store";
import { CodeViewer } from "../common/CodeViewer";
import { PanelSearchBox } from "../common/PanelSearchBox";
import { useViewStateNav } from "../common/useViewStateNav";
import { PackagesTable } from "./PackagesTable";
export function PackagesPanel() {
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
const db = database;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const {
schema: schemaName,
@@ -32,7 +29,7 @@ export function PackagesPanel() {
const [keyword, setKeyword] = useState("");
- const schema = databaseMetadata?.schemas.find((s) => s.name === schemaName);
+ const schema = databaseMetadata.schemas.find((s) => s.name === schemaName);
const [packName, packPosition] = extractKeyWithPosition(
detail?.package ?? ""
);
@@ -40,7 +37,7 @@ export function PackagesPanel() {
(p, i) => p.name === packName && i === packPosition
);
- if (!db || !databaseMetadata || !schema) return null;
+ if (!db || !schema) return null;
if (pack) {
return (
diff --git a/frontend/src/react/components/sql-editor/Panels/Panels.tsx b/frontend/src/react/components/sql-editor/Panels/Panels.tsx
index 95092bec10..8cb8c37a5f 100644
--- a/frontend/src/react/components/sql-editor/Panels/Panels.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/Panels.tsx
@@ -1,5 +1,5 @@
import { Loader2, ShieldAlert } from "lucide-react";
-import { Suspense, useEffect, useMemo, useState } from "react";
+import { Suspense, useEffect, useMemo } from "react";
import { useTranslation } from "react-i18next";
import {
Panel,
@@ -25,6 +25,7 @@ import { TerminalPanel } from "@/react/components/sql-editor/TerminalPanel/Termi
import { TriggersPanel } from "@/react/components/sql-editor/TriggersPanel";
import { ViewsPanel } from "@/react/components/sql-editor/ViewsPanel";
import { Alert } from "@/react/components/ui/alert";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useExecuteSQL } from "@/react/hooks/useExecuteSQL";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import { useAppStore } from "@/react/stores/app";
@@ -37,7 +38,6 @@ import {
useCurrentSQLEditorTab,
useSQLEditorTabState,
} from "@/react/stores/sqlEditor/tab";
-import { useDBSchemaV1Store } from "@/store";
import { isValidDatabaseName } from "@/types";
import {
extractDatabaseResourceName,
@@ -78,7 +78,6 @@ export function Panels() {
const handleEditorPanelResize = useSQLEditorStore(
(s) => s.handleEditorPanelResize
);
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const tab = useCurrentSQLEditorTab();
@@ -131,25 +130,11 @@ export function Panels() {
};
}, [updateViewState, execute]);
- const [databaseMetadata, setDatabaseMetadata] = useState<
- | Awaited<ReturnType<typeof dbSchemaStore.getOrFetchDatabaseMetadata>>
- | undefined
- >();
- useEffect(() => {
- if (!databaseName || !isValidDatabaseName(databaseName)) {
- setDatabaseMetadata(undefined);
- return;
- }
- let cancelled = false;
- void dbSchemaStore
- .getOrFetchDatabaseMetadata({ database: databaseName, silent: true })
- .then((meta) => {
- if (!cancelled) setDatabaseMetadata(meta);
- });
- return () => {
- cancelled = true;
- };
- }, [databaseName, dbSchemaStore]);
+ // Parent drives the metadata fetch for the whole Panels subtree;
+ // children call `useAppDatabaseMetadata(..., { autoFetch: false })`.
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ silent: true,
+ });
// Pin the active schema to a sensible default whenever the tab,
// database metadata, or current schema changes (mirrors the Vue
@@ -158,7 +143,6 @@ export function Panels() {
const currentSchema = tab?.viewState?.schema;
useEffect(() => {
if (!tabId) return;
- if (!databaseMetadata) return;
if (
!isValidDatabaseName(
extractDatabaseResourceName(databaseMetadata.name).database
diff --git a/frontend/src/react/components/sql-editor/Panels/ProceduresPanel/ProceduresPanel.tsx b/frontend/src/react/components/sql-editor/Panels/ProceduresPanel/ProceduresPanel.tsx
index 9836ba551f..8c47b99afc 100644
--- a/frontend/src/react/components/sql-editor/Panels/ProceduresPanel/ProceduresPanel.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/ProceduresPanel/ProceduresPanel.tsx
@@ -1,27 +1,24 @@
import { ChevronLeft, FileCode } from "lucide-react";
import { useState } from "react";
import { Button } from "@/react/components/ui/button";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import {
extractKeyWithPosition,
keyWithPosition,
} from "@/react/lib/keyWithPosition";
-import { useDBSchemaV1Store } from "@/store";
import { CodeViewer } from "../common/CodeViewer";
import { PanelSearchBox } from "../common/PanelSearchBox";
import { useViewStateNav } from "../common/useViewStateNav";
import { ProceduresTable } from "./ProceduresTable";
export function ProceduresPanel() {
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
const db = database;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const {
schema: schemaName,
@@ -32,7 +29,7 @@ export function ProceduresPanel() {
const [keyword, setKeyword] = useState("");
- const schema = databaseMetadata?.schemas.find((s) => s.name === schemaName);
+ const schema = databaseMetadata.schemas.find((s) => s.name === schemaName);
const [procName, procPosition] = extractKeyWithPosition(
detail?.procedure ?? ""
);
@@ -40,7 +37,7 @@ export function ProceduresPanel() {
(p, i) => p.name === procName && i === procPosition
);
- if (!db || !databaseMetadata || !schema) return null;
+ if (!db || !schema) return null;
if (procedure) {
return (
diff --git a/frontend/src/react/components/sql-editor/Panels/SequencesPanel/SequencesPanel.tsx b/frontend/src/react/components/sql-editor/Panels/SequencesPanel/SequencesPanel.tsx
index 46149c92cf..f92f0335e6 100644
--- a/frontend/src/react/components/sql-editor/Panels/SequencesPanel/SequencesPanel.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/SequencesPanel/SequencesPanel.tsx
@@ -1,8 +1,7 @@
import { useState } from "react";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import { keyWithPosition } from "@/react/lib/keyWithPosition";
-import { useDBSchemaV1Store } from "@/store";
import { PanelSearchBox } from "../common/PanelSearchBox";
import { useViewStateNav } from "../common/useViewStateNav";
import { SequencesTable } from "./SequencesTable";
@@ -13,20 +12,18 @@ import { SequencesTable } from "./SequencesTable";
* to scroll that row into view (no separate detail surface).
*/
export function SequencesPanel() {
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const { schema: schemaName, setDetail } = useViewStateNav();
const [keyword, setKeyword] = useState("");
- const schema = databaseMetadata?.schemas.find((s) => s.name === schemaName);
- if (!databaseMetadata || !schema) return null;
+ const schema = databaseMetadata.schemas.find((s) => s.name === schemaName);
+ if (!schema) return null;
return (
<div className="h-full overflow-hidden flex flex-col">
diff --git a/frontend/src/react/components/sql-editor/Panels/TablesPanel/TablesPanel.tsx b/frontend/src/react/components/sql-editor/Panels/TablesPanel/TablesPanel.tsx
index 115e7750c8..8eeee654a2 100644
--- a/frontend/src/react/components/sql-editor/Panels/TablesPanel/TablesPanel.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/TablesPanel/TablesPanel.tsx
@@ -1,30 +1,28 @@
import { useState } from "react";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
-import { useDBSchemaV1Store } from "@/store";
import { PanelSearchBox } from "../common/PanelSearchBox";
import { useViewStateNav } from "../common/useViewStateNav";
import { TableDetail } from "./TableDetail";
import { TablesTable } from "./TablesTable";
export function TablesPanel() {
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
const db = database;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ // Parent `Panels.tsx` drives the metadata fetch; we only subscribe.
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const { schema: schemaName, detail, setDetail } = useViewStateNav();
const [keyword, setKeyword] = useState("");
- const schema = databaseMetadata?.schemas.find((s) => s.name === schemaName);
+ const schema = databaseMetadata.schemas.find((s) => s.name === schemaName);
const table = schema?.tables.find((t) => t.name === detail?.table);
- if (!db || !databaseMetadata || !schema) return null;
+ if (!db || !schema) return null;
if (table) {
return (
diff --git a/frontend/src/react/components/sql-editor/Panels/TriggersPanel/TriggersPanel.tsx b/frontend/src/react/components/sql-editor/Panels/TriggersPanel/TriggersPanel.tsx
index 81b620979d..d282f27be3 100644
--- a/frontend/src/react/components/sql-editor/Panels/TriggersPanel/TriggersPanel.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/TriggersPanel/TriggersPanel.tsx
@@ -1,13 +1,12 @@
import { ChevronLeft, Zap } from "lucide-react";
import { useState } from "react";
import { Button } from "@/react/components/ui/button";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import {
extractKeyWithPosition,
keyWithPosition,
} from "@/react/lib/keyWithPosition";
-import { useDBSchemaV1Store } from "@/store";
import { CodeViewer } from "../common/CodeViewer";
import { PanelSearchBox } from "../common/PanelSearchBox";
import { useViewStateNav } from "../common/useViewStateNav";
@@ -19,14 +18,12 @@ import { TriggersTable } from "./TriggersTable";
* that behavior.
*/
export function TriggersPanel() {
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
const db = database;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const {
schema: schemaName,
@@ -38,7 +35,7 @@ export function TriggersPanel() {
const [keyword, setKeyword] = useState("");
- const schema = databaseMetadata?.schemas.find((s) => s.name === schemaName);
+ const schema = databaseMetadata.schemas.find((s) => s.name === schemaName);
const table = schema?.tables.find((t) => t.name === viewState?.table);
const [triggerName, triggerPosition] = extractKeyWithPosition(
@@ -48,7 +45,7 @@ export function TriggersPanel() {
(tr, i) => tr.name === triggerName && i === triggerPosition
);
- if (!db || !databaseMetadata || !schema) return null;
+ if (!db || !schema) return null;
if (trigger) {
return (
diff --git a/frontend/src/react/components/sql-editor/Panels/ViewsPanel/ViewsPanel.tsx b/frontend/src/react/components/sql-editor/Panels/ViewsPanel/ViewsPanel.tsx
index c035f37eae..d5cc7b8005 100644
--- a/frontend/src/react/components/sql-editor/Panels/ViewsPanel/ViewsPanel.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/ViewsPanel/ViewsPanel.tsx
@@ -1,30 +1,27 @@
import { useState } from "react";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
-import { useDBSchemaV1Store } from "@/store";
import { PanelSearchBox } from "../common/PanelSearchBox";
import { useViewStateNav } from "../common/useViewStateNav";
import { ViewDetail } from "./ViewDetail";
import { ViewsTable } from "./ViewsTable";
export function ViewsPanel() {
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
const db = database;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const { schema: schemaName, detail, setDetail } = useViewStateNav();
const [keyword, setKeyword] = useState("");
- const schema = databaseMetadata?.schemas.find((s) => s.name === schemaName);
+ const schema = databaseMetadata.schemas.find((s) => s.name === schemaName);
const view = schema?.views.find((v) => v.name === detail?.view);
- if (!db || !databaseMetadata || !schema) return null;
+ if (!db || !schema) return null;
if (view) {
return (
diff --git a/frontend/src/react/components/sql-editor/Panels/common/SchemaSelectToolbar.tsx b/frontend/src/react/components/sql-editor/Panels/common/SchemaSelectToolbar.tsx
index 0ffa05d01f..b0c1b73a19 100644
--- a/frontend/src/react/components/sql-editor/Panels/common/SchemaSelectToolbar.tsx
+++ b/frontend/src/react/components/sql-editor/Panels/common/SchemaSelectToolbar.tsx
@@ -6,9 +6,8 @@ import {
SelectTrigger,
SelectValue,
} from "@/react/components/ui/select";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
-import { useDBSchemaV1Store } from "@/store";
import { hasSchemaProperty } from "@/utils";
import { useViewStateNav } from "./useViewStateNav";
@@ -21,19 +20,16 @@ import { useViewStateNav } from "./useViewStateNav";
*/
export function SchemaSelectToolbar() {
const { t } = useTranslation();
- const dbSchemaStore = useDBSchemaV1Store();
const { database, instance } = useConnectionOfCurrentSQLEditorTab();
const databaseName = database.name;
const engine = instance.engine;
- const databaseMetadata = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName ?? ""),
- { deep: true }
- );
+ const databaseMetadata = useAppDatabaseMetadata(databaseName ?? "", {
+ autoFetch: false,
+ });
const { schema, setSchema } = useViewStateNav();
if (engine === undefined || !hasSchemaProperty(engine)) return null;
- if (!databaseMetadata) return null;
const options = databaseMetadata.schemas.map((s) => ({
label: s.name || t("db.schema.default"),
diff --git a/frontend/src/react/components/sql-editor/ResultView/ResultView.tsx b/frontend/src/react/components/sql-editor/ResultView/ResultView.tsx
index 086bc194d4..215f809ed9 100644
--- a/frontend/src/react/components/sql-editor/ResultView/ResultView.tsx
+++ b/frontend/src/react/components/sql-editor/ResultView/ResultView.tsx
@@ -23,7 +23,6 @@ import { cn } from "@/react/lib/utils";
import { useAppStore } from "@/react/stores/app";
import { useSQLEditorEditorState } from "@/react/stores/sqlEditor/editor";
import { getSQLEditorTabsState } from "@/react/stores/sqlEditor/tab";
-import { useDBSchemaV1Store } from "@/store";
import type { SQLEditorQueryParams, SQLResultSetV1 } from "@/types";
import { isValidDatabaseName } from "@/types";
import {
@@ -473,7 +472,6 @@ export function ResultView({
function SyncDatabaseButton({ database }: { database: Database }) {
const { t } = useTranslation();
- const dbSchemaStore = useDBSchemaV1Store();
const [syncing, setSyncing] = useState(false);
if (!isValidDatabaseName(database.name)) return null;
@@ -486,8 +484,9 @@ function SyncDatabaseButton({ database }: { database: Database }) {
setSyncing(true);
const { databaseName } = extractDatabaseResourceName(database.name);
try {
- await useAppStore.getState().syncDatabase(database.name);
- await dbSchemaStore.getOrFetchDatabaseMetadata({
+ const appStore = useAppStore.getState();
+ await appStore.syncDatabase(database.name);
+ await appStore.getOrFetchDatabaseMetadata({
database: database.name,
skipCache: true,
});
diff --git a/frontend/src/react/components/sql-editor/SchemaChooser.test.tsx b/frontend/src/react/components/sql-editor/SchemaChooser.test.tsx
index 27aeb01a9b..de2953eeee 100644
--- a/frontend/src/react/components/sql-editor/SchemaChooser.test.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaChooser.test.tsx
@@ -9,13 +9,12 @@ import { beforeEach, describe, expect, test, vi } from "vitest";
const mocks = vi.hoisted(() => ({
useTranslation: vi.fn(() => ({ t: (key: string) => key })),
- usePiniaBridge: vi.fn<(getter: () => unknown) => unknown>(),
// Selector hook over the Zustand tabs store; returns the current tab's
// `connection.schema` (and `currentTabId` for the seed effect).
tabSchema: undefined as string | undefined,
currentTabId: "tab1",
getSQLEditorTabsState: vi.fn(),
- useDBSchemaV1Store: vi.fn(),
+ metadata: { schemas: [] as Array<{ name: string }> },
useConnectionOfCurrentSQLEditorTab: vi.fn(),
instanceAllowsSchemaScopedQuery: vi.fn(),
router: {
@@ -28,12 +27,8 @@ vi.mock("react-i18next", () => ({
useTranslation: mocks.useTranslation,
}));
-vi.mock("@/react/hooks/usePiniaBridge", () => ({
- usePiniaBridge: mocks.usePiniaBridge,
-}));
-
-vi.mock("@/store", () => ({
- useDBSchemaV1Store: mocks.useDBSchemaV1Store,
+vi.mock("@/react/hooks/useAppDatabaseMetadata", () => ({
+ useAppDatabaseMetadata: () => mocks.metadata,
}));
vi.mock("@/react/hooks/useSQLEditorBridge", () => ({
@@ -126,12 +121,9 @@ beforeEach(async () => {
tabsById: new Map([["tab1", { connection: {} }]]),
updateCurrentTab: vi.fn(),
});
- mocks.useDBSchemaV1Store.mockReturnValue({
- getDatabaseMetadata: vi.fn(() => ({
- schemas: [{ name: "public" }, { name: "private" }],
- })),
- });
- mocks.usePiniaBridge.mockImplementation((getter) => getter());
+ mocks.metadata = {
+ schemas: [{ name: "public" }, { name: "private" }],
+ };
mocks.instanceAllowsSchemaScopedQuery.mockReturnValue(true);
({ SchemaChooser } = await import("./SchemaChooser"));
});
diff --git a/frontend/src/react/components/sql-editor/SchemaChooser.tsx b/frontend/src/react/components/sql-editor/SchemaChooser.tsx
index cf60155918..5fccdab357 100644
--- a/frontend/src/react/components/sql-editor/SchemaChooser.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaChooser.tsx
@@ -1,13 +1,12 @@
import { useEffect, useMemo } from "react";
import { useTranslation } from "react-i18next";
-import { usePiniaBridge } from "@/react/hooks/usePiniaBridge";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import { useVueRoute } from "@/react/hooks/useVueRoute";
import {
getSQLEditorTabsState,
useSQLEditorTabState,
} from "@/react/stores/sqlEditor/tab";
-import { useDBSchemaV1Store } from "@/store";
import { instanceAllowsSchemaScopedQuery } from "@/utils";
import { ConnectChooser } from "./ConnectChooser";
@@ -20,7 +19,6 @@ const SchemaOptionValueUnspecified = "-1";
*/
export function SchemaChooser() {
const { t } = useTranslation();
- const dbSchemaStore = useDBSchemaV1Store();
const { instance, database } = useConnectionOfCurrentSQLEditorTab();
const engine = instance.engine;
@@ -28,9 +26,11 @@ export function SchemaChooser() {
const tabSchema = useSQLEditorTabState(
(s) => s.tabsById.get(s.currentTabId)?.connection.schema
);
- const schemas = usePiniaBridge(
- () => dbSchemaStore.getDatabaseMetadata(databaseName).schemas
- );
+ // Parent SchemaPane (E4 migration) drives the metadata fetch; here we
+ // only need the cached read.
+ const { schemas } = useAppDatabaseMetadata(databaseName, {
+ autoFetch: false,
+ });
const show = instanceAllowsSchemaScopedQuery(engine);
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ColumnInfo.tsx b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ColumnInfo.tsx
index b177a11aba..8b7a588b84 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ColumnInfo.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ColumnInfo.tsx
@@ -3,7 +3,7 @@ import { Check, X } from "lucide-react";
import { useTranslation } from "react-i18next";
import { getColumnDefaultValuePlaceholder } from "@/react/components/SchemaEditorLite/core/columnDefaultValue";
import { useAppDatabase } from "@/react/hooks/useAppDatabase";
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import { Engine } from "@/types/proto-es/v1/common_pb";
import { ColumnMetadataSchema } from "@/types/proto-es/v1/database_service_pb";
import { getInstanceResource } from "@/utils";
@@ -23,13 +23,13 @@ type Props = {
*/
export function ColumnInfo({ database, schema, table, column }: Props) {
const { t } = useTranslation();
- const dbSchema = useDBSchemaV1Store();
const databaseEntity = useAppDatabase(database);
+ const tableMetadata = useAppStore((s) =>
+ s.getTableMetadata({ database, schema, table })
+ );
const columnMetadata =
- dbSchema
- .getTableMetadata({ database, schema, table })
- .columns.find((col) => col.name === column) ??
+ tableMetadata.columns.find((col) => col.name === column) ??
create(ColumnMetadataSchema, {});
const instanceEngine = getInstanceResource(databaseEntity).engine;
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ExternalTableInfo.tsx b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ExternalTableInfo.tsx
index 4c15b36849..cf9c1af844 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ExternalTableInfo.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ExternalTableInfo.tsx
@@ -1,5 +1,5 @@
import { useTranslation } from "react-i18next";
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import { InfoItem } from "./InfoItem";
type Props = {
@@ -11,12 +11,9 @@ type Props = {
/** Replaces `HoverPanel/ExternalTableInfo.vue`. */
export function ExternalTableInfo({ database, schema, externalTable }: Props) {
const { t } = useTranslation();
- const dbSchema = useDBSchemaV1Store();
- const externalTableMetadata = dbSchema.getExternalTableMetadata({
- database,
- schema,
- externalTable,
- });
+ const externalTableMetadata = useAppStore((s) =>
+ s.getExternalTableMetadata({ database, schema, externalTable })
+ );
return (
<div className="min-w-56 max-w-[18rem] gap-y-1">
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/TableInfo.tsx b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/TableInfo.tsx
index 4e97e3a976..b0e0e756f4 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/TableInfo.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/TableInfo.tsx
@@ -1,7 +1,7 @@
import { useTranslation } from "react-i18next";
import { EngineIcon } from "@/react/components/EngineIcon";
import { useAppDatabase } from "@/react/hooks/useAppDatabase";
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import { Engine } from "@/types/proto-es/v1/common_pb";
import { bytesToString, getInstanceResource } from "@/utils";
import { engineNameV1 } from "@/utils/v1/instance";
@@ -21,10 +21,10 @@ type Props = {
*/
export function TableInfo({ database, schema, table }: Props) {
const { t } = useTranslation();
- const dbSchema = useDBSchemaV1Store();
const databaseEntity = useAppDatabase(database);
-
- const tableMetadata = dbSchema.getTableMetadata({ database, schema, table });
+ const tableMetadata = useAppStore((s) =>
+ s.getTableMetadata({ database, schema, table })
+ );
const instanceEngine = getInstanceResource(databaseEntity).engine;
const indexSize =
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/TablePartitionInfo.tsx b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/TablePartitionInfo.tsx
index 8239fd86df..0304b5d128 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/TablePartitionInfo.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/TablePartitionInfo.tsx
@@ -1,6 +1,6 @@
import { create } from "@bufbuild/protobuf";
import { useTranslation } from "react-i18next";
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import {
TablePartitionMetadata_Type,
TablePartitionMetadataSchema,
@@ -22,12 +22,12 @@ export function TablePartitionInfo({
partition,
}: Props) {
const { t } = useTranslation();
- const dbSchema = useDBSchemaV1Store();
+ const tableMetadata = useAppStore((s) =>
+ s.getTableMetadata({ database, schema, table })
+ );
const partitionMetadata =
- dbSchema
- .getTableMetadata({ database, schema, table })
- .partitions.find((p) => p.name === partition) ??
+ tableMetadata.partitions.find((p) => p.name === partition) ??
create(TablePartitionMetadataSchema, {});
return (
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ViewInfo.tsx b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ViewInfo.tsx
index 2b06d5fc8d..aab37069ac 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ViewInfo.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/HoverPanel/ViewInfo.tsx
@@ -1,4 +1,4 @@
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import { CommonText } from "./CommonText";
type Props = {
@@ -9,7 +9,8 @@ type Props = {
/** Replaces `HoverPanel/ViewInfo.vue`. Just the view's comment, wrapped. */
export function ViewInfo({ database, schema, view }: Props) {
- const dbSchema = useDBSchemaV1Store();
- const viewMetadata = dbSchema.getViewMetadata({ database, schema, view });
+ const viewMetadata = useAppStore((s) =>
+ s.getViewMetadata({ database, schema, view })
+ );
return <CommonText content={viewMetadata.comment} />;
}
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/SchemaPane.test.tsx b/frontend/src/react/components/sql-editor/SchemaPane/SchemaPane.test.tsx
index bb2b5fbba1..02838bc74e 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/SchemaPane.test.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/SchemaPane.test.tsx
@@ -63,6 +63,10 @@ vi.mock("@/react/stores/app", () => {
syncDatabase: vi.fn(),
fetchDatabases: vi.fn(async () => ({ databases: [], nextPageToken: "" })),
databasesByName: {} as Record<string, unknown>,
+ // SchemaPane reads cached metadata reactively via this getter; return
+ // undefined so the tree stays empty unless a test seeds the cache.
+ getCachedDatabaseMetadata: () => undefined,
+ getOrFetchDatabaseMetadata: mocks.getOrFetchDatabaseMetadata,
};
return {
useAppStore: Object.assign(
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/SchemaPane.tsx b/frontend/src/react/components/sql-editor/SchemaPane/SchemaPane.tsx
index 086250c582..e2bc5fab00 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/SchemaPane.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/SchemaPane.tsx
@@ -20,16 +20,14 @@ import { Input } from "@/react/components/ui/input";
import { Tree, type TreeDataNode } from "@/react/components/ui/tree";
import { countVisibleRows } from "@/react/components/ui/tree-utils";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
-import { useVueState } from "@/react/hooks/useVueState";
import { cn } from "@/react/lib/utils";
+import { useAppStore } from "@/react/stores/app";
import {
getSQLEditorTabsState,
useSQLEditorTabState,
} from "@/react/stores/sqlEditor/tab";
-import { useDBSchemaV1Store } from "@/store";
import { isValidDatabaseName } from "@/types";
import type {
- DatabaseMetadata,
GetSchemaStringRequest_ObjectType,
TableMetadata,
} from "@/types/proto-es/v1/database_service_pb";
@@ -97,8 +95,10 @@ export function SchemaPane() {
function SchemaPaneInner() {
const { t } = useTranslation();
- const dbSchemaStore = useDBSchemaV1Store();
const { database } = useConnectionOfCurrentSQLEditorTab();
+ const getOrFetchDatabaseMetadata = useAppStore(
+ (s) => s.getOrFetchDatabaseMetadata
+ );
const hoverState = useHoverState();
const currentTabId = useSQLEditorTabState((s) => s.currentTabId);
@@ -120,21 +120,19 @@ function SchemaPaneInner() {
setSearchPattern("");
}, [currentTabId]);
- // Reactive read of the cached metadata. Returns the live dbSchema
- // cache entry (or null when uncached) so the tree rebuilds whenever
- // the metadata for this database changes — including a manual sync via
+ // Reactive read of the cached metadata. Returns the live cache entry
+ // (or null when uncached) so the tree rebuilds whenever the metadata
+ // for this database changes — including a manual sync via
// SyncSchemaButton, which refetches with `skipCache` and replaces the
- // entry. `getDatabaseMetadataWithoutDefault` returns a stable
- // `undefined` when uncached (vs `getDatabaseMetadata`'s fresh empty
- // object), keeping the snapshot reference stable across renders.
- const metadata = useVueState<DatabaseMetadata | null>(
- () =>
+ // entry. `getCachedDatabaseMetadata` returns a stable `undefined` when
+ // uncached (vs `getDatabaseMetadata`'s fresh empty object), keeping
+ // the snapshot reference stable across renders.
+ const metadata =
+ useAppStore((s) =>
isValidDatabaseName(database.name)
- ? (dbSchemaStore.getDatabaseMetadataWithoutDefault(database.name) ??
- null)
- : null,
- { deps: [database.name] }
- );
+ ? s.getCachedDatabaseMetadata(database.name)
+ : undefined
+ ) ?? null;
const [isFetching, setIsFetching] = useState(false);
// Trigger the fetch on database change (the store de-duplicates). The
@@ -147,15 +145,13 @@ function SchemaPaneInner() {
}
setIsFetching(true);
let cancelled = false;
- void dbSchemaStore
- .getOrFetchDatabaseMetadata({ database: database.name })
- .finally(() => {
- if (!cancelled) setIsFetching(false);
- });
+ void getOrFetchDatabaseMetadata({ database: database.name }).finally(() => {
+ if (!cancelled) setIsFetching(false);
+ });
return () => {
cancelled = true;
};
- }, [database.name, dbSchemaStore]);
+ }, [database.name, getOrFetchDatabaseMetadata]);
const totalTableCount = useMemo(() => {
if (!metadata) return 0;
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/SyncSchemaButton.test.tsx b/frontend/src/react/components/sql-editor/SchemaPane/SyncSchemaButton.test.tsx
index b49a5b90cd..3c1ed13caf 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/SyncSchemaButton.test.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/SyncSchemaButton.test.tsx
@@ -64,14 +64,13 @@ vi.mock("@/react/components/ui/button", () => ({
),
}));
-vi.mock("@/store", () => ({
- useDBSchemaV1Store: () => ({
- getOrFetchDatabaseMetadata: mocks.getOrFetchDatabaseMetadata,
- }),
-}));
-
vi.mock("@/react/stores/app", () => ({
- useAppStore: { getState: () => ({ syncDatabase: mocks.syncDatabase }) },
+ useAppStore: {
+ getState: () => ({
+ syncDatabase: mocks.syncDatabase,
+ getOrFetchDatabaseMetadata: mocks.getOrFetchDatabaseMetadata,
+ }),
+ },
}));
vi.mock("@/react/hooks/useSQLEditorBridge", () => ({
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/SyncSchemaButton.tsx b/frontend/src/react/components/sql-editor/SchemaPane/SyncSchemaButton.tsx
index a26d599713..06a2227dbc 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/SyncSchemaButton.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/SyncSchemaButton.tsx
@@ -7,7 +7,6 @@ import { Tooltip } from "@/react/components/ui/tooltip";
import { useConnectionOfCurrentSQLEditorTab } from "@/react/hooks/useSQLEditorBridge";
import { cn } from "@/react/lib/utils";
import { useAppStore } from "@/react/stores/app";
-import { useDBSchemaV1Store } from "@/store";
import { getDateForPbTimestampProtoEs, isValidDatabaseName } from "@/types";
/**
@@ -24,7 +23,6 @@ import { getDateForPbTimestampProtoEs, isValidDatabaseName } from "@/types";
export function SyncSchemaButton({ className }: { className?: string }) {
const { t } = useTranslation();
const { database } = useConnectionOfCurrentSQLEditorTab();
- const dbSchemaStore = useDBSchemaV1Store();
const [isSyncing, setIsSyncing] = useState(false);
const disabled = !isValidDatabaseName(database.name);
@@ -33,8 +31,9 @@ export function SyncSchemaButton({ className }: { className?: string }) {
if (disabled) return;
setIsSyncing(true);
try {
- await useAppStore.getState().syncDatabase(database.name, true);
- await dbSchemaStore.getOrFetchDatabaseMetadata({
+ const appStore = useAppStore.getState();
+ await appStore.syncDatabase(database.name, true);
+ await appStore.getOrFetchDatabaseMetadata({
database: database.name,
skipCache: true,
});
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/CheckNode.tsx b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/CheckNode.tsx
index f57f46793c..27987b9f84 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/CheckNode.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/CheckNode.tsx
@@ -1,4 +1,4 @@
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import type { TreeNode } from "../schemaTree";
import { CommonNode } from "./CommonNode";
import { CheckConstraintIcon } from "./icons";
@@ -13,21 +13,20 @@ type Props = {
* trailing tag with the resolved check expression (if metadata is loaded).
*/
export function CheckNode({ node, keyword }: Props) {
- const dbSchema = useDBSchemaV1Store();
const target = (node as TreeNode<"check">).meta.target;
-
- const checkMetadata = (() => {
- if ("table" in target) {
- const { database, schema, table, check } = target;
- const tableMetadata = dbSchema.getTableMetadata({
- database,
- schema,
- table,
- });
- return tableMetadata?.checkConstraints.find((c) => c.name === check);
- }
- return undefined;
- })();
+ const hasTable = "table" in target;
+ const tableMetadata = useAppStore((s) =>
+ hasTable
+ ? s.getTableMetadata({
+ database: target.database,
+ schema: target.schema,
+ table: target.table,
+ })
+ : undefined
+ );
+ const checkMetadata = hasTable
+ ? tableMetadata?.checkConstraints.find((c) => c.name === target.check)
+ : undefined;
return (
<CommonNode
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/ColumnNode.tsx b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/ColumnNode.tsx
index b678f63418..39eda61206 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/ColumnNode.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/ColumnNode.tsx
@@ -1,5 +1,5 @@
import { useMemo } from "react";
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import type { ColumnMetadata } from "@/types/proto-es/v1/database_service_pb";
import type { TreeNode } from "../schemaTree";
import { CommonNode } from "./CommonNode";
@@ -47,36 +47,45 @@ function findColumn(parent: { columns: ColumnMetadata[] }, name: string) {
* hundreds of children.
*/
export function ColumnNode({ node, keyword }: Props) {
- const dbSchema = useDBSchemaV1Store();
const target = (node as TreeNode<"column">).meta.target;
-
- const tableMetadata = useMemo(() => {
- if ("table" in target) {
- const { database, schema, table } = target;
- return dbSchema.getTableMetadata({ database, schema, table });
- }
- return undefined;
- }, [target, dbSchema]);
+ // Subscribe to the relevant slice of metadata up front. Selectors run
+ // unconditionally per the rules of hooks; the target shape dictates
+ // which one is read.
+ const tableMetadata = useAppStore((s) =>
+ "table" in target
+ ? s.getTableMetadata({
+ database: target.database,
+ schema: target.schema,
+ table: target.table,
+ })
+ : undefined
+ );
+ const schemaMetadata = useAppStore((s) =>
+ "externalTable" in target || "view" in target
+ ? s.getSchemaMetadata({
+ database: target.database,
+ schema: target.schema,
+ })
+ : undefined
+ );
const columnMetadata = useMemo(() => {
- const { database, schema, column } = target;
+ const { column } = target;
if ("table" in target && tableMetadata) {
return findColumn(tableMetadata, column);
}
if ("externalTable" in target) {
- const schemaMetadata = dbSchema.getSchemaMetadata({ database, schema });
const ext = schemaMetadata?.externalTables.find(
(t) => t.name === target.externalTable
);
return ext ? findColumn(ext, column) : undefined;
}
if ("view" in target) {
- const schemaMetadata = dbSchema.getSchemaMetadata({ database, schema });
const view = schemaMetadata?.views.find((v) => v.name === target.view);
return view ? findColumn(view, column) : undefined;
}
return undefined;
- }, [target, tableMetadata, dbSchema]);
+ }, [target, tableMetadata, schemaMetadata]);
const { isPrimaryKey, isIndex } = useMemo(() => {
if (!("table" in target) || !tableMetadata) {
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/FunctionNode.tsx b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/FunctionNode.tsx
index 630c073548..41a8d8adf7 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/FunctionNode.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/FunctionNode.tsx
@@ -1,4 +1,4 @@
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import type { TreeNode } from "../schemaTree";
import { CommonNode } from "./CommonNode";
import { FunctionIcon } from "./icons";
@@ -11,13 +11,11 @@ type Props = {
/** Replaces `TreeNode/FunctionNode.vue`. Same signature-vs-name fallback
* as ProcedureNode. */
export function FunctionNode({ node, keyword }: Props) {
- const dbSchema = useDBSchemaV1Store();
const target = (node as TreeNode<"function">).meta.target;
-
- const functionMetadata = dbSchema.getSchemaMetadata({
- database: target.database,
- schema: target.schema,
- })?.functions[target.position];
+ const schemaMetadata = useAppStore((s) =>
+ s.getSchemaMetadata({ database: target.database, schema: target.schema })
+ );
+ const functionMetadata = schemaMetadata?.functions[target.position];
return (
<CommonNode
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/IndexNode.tsx b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/IndexNode.tsx
index 833b93f7db..8392ab68d2 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/IndexNode.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/IndexNode.tsx
@@ -1,4 +1,4 @@
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import type { TreeNode } from "../schemaTree";
import { CommonNode } from "./CommonNode";
import { IndexIcon, PrimaryKeyIcon } from "./icons";
@@ -13,18 +13,17 @@ type Props = {
* marked `primary`, IndexIcon otherwise.
*/
export function IndexNode({ node, keyword }: Props) {
- const dbSchema = useDBSchemaV1Store();
const target = (node as TreeNode<"index">).meta.target;
-
- const isPrimaryKey = (() => {
- const { database, schema, table, index } = target;
- const tableMetadata = dbSchema.getTableMetadata({
- database,
- schema,
- table,
- });
- return !!tableMetadata.indexes.find((i) => i.name === index)?.primary;
- })();
+ const tableMetadata = useAppStore((s) =>
+ s.getTableMetadata({
+ database: target.database,
+ schema: target.schema,
+ table: target.table,
+ })
+ );
+ const isPrimaryKey = !!tableMetadata.indexes.find(
+ (i) => i.name === target.index
+ )?.primary;
return (
<CommonNode
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/ProcedureNode.tsx b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/ProcedureNode.tsx
index b5a1c9477c..bcaef117b8 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/ProcedureNode.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/TreeNode/ProcedureNode.tsx
@@ -1,4 +1,4 @@
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import type { TreeNode } from "../schemaTree";
import { CommonNode } from "./CommonNode";
import { ProcedureIcon } from "./icons";
@@ -14,13 +14,11 @@ type Props = {
* Oracle expose overloads where signature is the disambiguator).
*/
export function ProcedureNode({ node, keyword }: Props) {
- const dbSchema = useDBSchemaV1Store();
const target = (node as TreeNode<"procedure">).meta.target;
-
- const procedureMetadata = dbSchema.getSchemaMetadata({
- database: target.database,
- schema: target.schema,
- })?.procedures[target.position];
+ const schemaMetadata = useAppStore((s) =>
+ s.getSchemaMetadata({ database: target.database, schema: target.schema })
+ );
+ const procedureMetadata = schemaMetadata?.procedures[target.position];
return (
<CommonNode
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/actions.test.tsx b/frontend/src/react/components/sql-editor/SchemaPane/actions.test.tsx
index 380a4663af..be1789bf34 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/actions.test.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/actions.test.tsx
@@ -52,16 +52,20 @@ vi.mock("@/react/i18n", () => ({
vi.mock("@/store", () => ({
pushNotification: vi.fn(),
- useDBSchemaV1Store: () => ({ getTableMetadata: mocks.getTableMetadata }),
}));
-vi.mock("@/react/stores/app", () => ({
- useAppStore: Object.assign(
- (selector: (state: unknown) => unknown) =>
- selector({ getDatabaseByName: mocks.getDatabaseByName }),
- { getState: () => ({ getDatabaseByName: mocks.getDatabaseByName }) }
- ),
-}));
+vi.mock("@/react/stores/app", () => {
+ const state = {
+ getDatabaseByName: mocks.getDatabaseByName,
+ getTableMetadata: mocks.getTableMetadata,
+ };
+ return {
+ useAppStore: Object.assign(
+ (selector: (state: unknown) => unknown) => selector(state),
+ { getState: () => state }
+ ),
+ };
+});
vi.mock("@/react/stores/sqlEditor/tab", () => ({
// actions.tsx only reaches the store imperatively via getSQLEditorTabsState
diff --git a/frontend/src/react/components/sql-editor/SchemaPane/actions.tsx b/frontend/src/react/components/sql-editor/SchemaPane/actions.tsx
index a94c36e75a..8bf43bf1a6 100644
--- a/frontend/src/react/components/sql-editor/SchemaPane/actions.tsx
+++ b/frontend/src/react/components/sql-editor/SchemaPane/actions.tsx
@@ -22,7 +22,6 @@ import { useAppStore } from "@/react/stores/app";
import { getSQLEditorTabsState } from "@/react/stores/sqlEditor/tab";
import { router } from "@/router";
import { SQL_EDITOR_DATABASE_MODULE } from "@/router/sqlEditor";
-import { useDBSchemaV1Store } from "@/store";
import {
DEFAULT_SQL_EDITOR_TAB_MODE,
dialectOfEngineV1,
@@ -390,7 +389,10 @@ export function useSchemaPaneContextMenu(
): SchemaMenuItem[] {
const { t } = useTranslation();
const getDatabaseByName = useAppStore((s) => s.getDatabaseByName);
- const dbSchema = useDBSchemaV1Store();
+ // Imperative reads happen inside `onSelect` callbacks below; resolve
+ // metadata at call time via `useAppStore.getState()` so we don't
+ // subscribe (and re-derive the menu) on every metadata cache update.
+ const getTableMetadata = useAppStore((s) => s.getTableMetadata);
const { selectAllFromTableOrView, viewDetail, openNewTab } =
useSchemaPaneActions();
@@ -475,7 +477,7 @@ export function useSchemaPaneContextMenu(
label: t("sql-editor.copy-all-column-names"),
icon: <Copy className="size-4" />,
onSelect: () => {
- const tableMetadata = dbSchema.getTableMetadata({
+ const tableMetadata = getTableMetadata({
database,
schema,
table,
@@ -573,7 +575,7 @@ export function useSchemaPaneContextMenu(
});
if (type === "table") {
const { table } = target as NodeTarget<"table">;
- const tableMetadata = dbSchema.getTableMetadata({
+ const tableMetadata = getTableMetadata({
database,
schema,
table,
@@ -660,7 +662,7 @@ export function useSchemaPaneContextMenu(
node,
deps,
getDatabaseByName,
- dbSchema,
+ getTableMetadata,
notify,
openNewTab,
selectAllFromTableOrView,
diff --git a/frontend/src/react/hooks/useAppDatabaseMetadata.ts b/frontend/src/react/hooks/useAppDatabaseMetadata.ts
new file mode 100644
index 0000000000..b8f15d9815
--- /dev/null
+++ b/frontend/src/react/hooks/useAppDatabaseMetadata.ts
@@ -0,0 +1,76 @@
+import { useEffect, useMemo } from "react";
+import { useAppStore } from "@/react/stores/app";
+import { isValidDatabaseName } from "@/types";
+import type { DatabaseMetadata } from "@/types/proto-es/v1/database_service_pb";
+
+interface UseAppDatabaseMetadataOptions {
+ // Pass-through to `getOrFetchDatabaseMetadata` for advanced fetch
+ // semantics (filtered schemas/tables, limited rows). Most consumers
+ // don't pass these.
+ readonly filter?: string;
+ readonly limit?: number;
+ readonly skipCache?: boolean;
+ readonly silent?: boolean;
+ // Set to `false` to suppress the self-fetch (e.g. when the parent has
+ // already pre-fetched). Defaults to `true`.
+ readonly autoFetch?: boolean;
+}
+
+/**
+ * Reactively reads a database's metadata from the Zustand app store,
+ * self-fetching when the route hasn't preloaded it. Mirrors the legacy
+ * Pinia `useDBSchemaV1Store.getDatabaseMetadata(...)` + `getOrFetchDatabaseMetadata(...)`
+ * pair, but exposed as a single React hook with stable refs.
+ */
+export const useAppDatabaseMetadata = (
+ database: string,
+ options: UseAppDatabaseMetadataOptions = {}
+): DatabaseMetadata => {
+ const {
+ filter = "",
+ limit = 0,
+ skipCache = false,
+ silent = false,
+ autoFetch = true,
+ } = options;
+ const getDatabaseMetadata = useAppStore((s) => s.getDatabaseMetadata);
+ const getOrFetchDatabaseMetadata = useAppStore(
+ (s) => s.getOrFetchDatabaseMetadata
+ );
+ // Subscribe to the specific cache entry so re-fetches with the same
+ // filter/limit trigger re-renders. Selecting the raw entry keeps the
+ // snapshot stable for `useSyncExternalStore`.
+ const cacheKey = `${database}/metadata::${filter}::${limit}`;
+ const cached = useAppStore((s) => s.metadataByName[cacheKey]);
+
+ useEffect(() => {
+ if (!autoFetch) return;
+ if (!isValidDatabaseName(database)) return;
+ void getOrFetchDatabaseMetadata({
+ database,
+ filter,
+ limit,
+ skipCache,
+ silent,
+ });
+ }, [
+ autoFetch,
+ database,
+ filter,
+ limit,
+ skipCache,
+ silent,
+ getOrFetchDatabaseMetadata,
+ ]);
+
+ // Prefer the subscribed cache entry so consumers passing `filter` /
+ // `limit` see their fetched result. `getDatabaseMetadata` only reads
+ // the unfiltered `::0` slot; using it as the primary return would
+ // make filtered/limited fetches resolve into a cache slot the hook
+ // never returns from. Fall back to `getDatabaseMetadata` for the
+ // empty-cache case so the return type stays non-nullable.
+ return useMemo(
+ () => cached ?? getDatabaseMetadata(database),
+ [getDatabaseMetadata, database, cached]
+ );
+};
diff --git a/frontend/src/react/pages/project/ProjectDatabaseDetailPage.test.tsx b/frontend/src/react/pages/project/ProjectDatabaseDetailPage.test.tsx
index 1fd3a26890..bf9783d31d 100644
--- a/frontend/src/react/pages/project/ProjectDatabaseDetailPage.test.tsx
+++ b/frontend/src/react/pages/project/ProjectDatabaseDetailPage.test.tsx
@@ -134,7 +134,7 @@ const mocks = vi.hoisted(() => {
})),
useDBSchemaV1Store: vi.fn(() => ({
getOrFetchDatabaseMetadata: vi.fn(),
- getDatabaseMetadata: vi.fn(() => undefined as unknown),
+ getDatabaseMetadata: vi.fn((_name: string) => undefined as unknown),
getSchemaList: vi.fn(() => [] as unknown[]),
getTableList: vi.fn(() => [] as unknown[]),
})),
@@ -273,10 +273,23 @@ vi.mock("@/store", () => ({
pushNotification: mocks.pushNotification,
useProjectV1Store: mocks.useProjectV1Store,
useDatabaseV1Store: mocks.useDatabaseV1Store,
- useDBSchemaV1Store: mocks.useDBSchemaV1Store,
usePermissionStore: mocks.usePermissionStore,
}));
+// Page composes child panels that now read dbSchema getters via the app
+// store. Route the existing `mocks.useDBSchemaV1Store` shape through
+// `useAppStore` so the per-scenario `.mockReturnValue({...})` calls keep
+// working unchanged.
+vi.mock("@/react/stores/app", () => ({
+ useAppStore: (selector: (s: unknown) => unknown) =>
+ selector(mocks.useDBSchemaV1Store()),
+}));
+
+vi.mock("@/react/hooks/useAppDatabaseMetadata", () => ({
+ useAppDatabaseMetadata: (name: string) =>
+ mocks.useDBSchemaV1Store().getDatabaseMetadata?.(name) ?? { schemas: [] },
+}));
+
vi.mock("@/react/components/database", () => ({
TransferProjectSheet: mocks.transferProjectSheet,
}));
diff --git a/frontend/src/react/pages/project/ProjectDatabasesPage.tsx b/frontend/src/react/pages/project/ProjectDatabasesPage.tsx
index feee4e0b32..f36d4c0270 100644
--- a/frontend/src/react/pages/project/ProjectDatabasesPage.tsx
+++ b/frontend/src/react/pages/project/ProjectDatabasesPage.tsx
@@ -27,11 +27,11 @@ import {
import { Button } from "@/react/components/ui/button";
import { useVueState } from "@/react/hooks/useVueState";
import { preCreateIssue } from "@/react/lib/plan/issue";
+import { useAppStore } from "@/react/stores/app";
import {
pushNotification,
useActuatorV1Store,
useDatabaseV1Store,
- useDBSchemaV1Store,
useEnvironmentV1Store,
useInstanceV1Store,
useProjectV1Store,
@@ -70,7 +70,9 @@ import { DataExportPrepSheet } from "./export-center/DataExportPrepSheet";
export function ProjectDatabasesPage({ projectId }: { projectId: string }) {
const { t } = useTranslation();
const databaseStore = useDatabaseV1Store();
- const dbSchemaStore = useDBSchemaV1Store();
+ const removeDatabaseMetadataCache = useAppStore(
+ (s) => s.removeDatabaseMetadataCache
+ );
const actuatorStore = useActuatorV1Store();
const environmentStore = useEnvironmentV1Store();
const projectStore = useProjectV1Store();
@@ -266,7 +268,7 @@ export function ProjectDatabasesPage({ projectId }: { projectId: string }) {
try {
await databaseStore.batchSyncDatabases(Array.from(selectedNames));
for (const name of selectedNames) {
- dbSchemaStore.removeCache(name);
+ removeDatabaseMetadataCache(name);
}
pushNotification({
module: "bytebase",
@@ -283,7 +285,7 @@ export function ProjectDatabasesPage({ projectId }: { projectId: string }) {
} finally {
setSyncing(false);
}
- }, [syncing, selectedNames, databaseStore, dbSchemaStore, t]);
+ }, [syncing, selectedNames, databaseStore, removeDatabaseMetadataCache, t]);
const handleLabelsApply = useCallback(
async (labelsList: { [key: string]: string }[]) => {
diff --git a/frontend/src/react/pages/project/database-detail/DatabaseSyncButton.tsx b/frontend/src/react/pages/project/database-detail/DatabaseSyncButton.tsx
index 2bc777d473..74dfa6c5d4 100644
--- a/frontend/src/react/pages/project/database-detail/DatabaseSyncButton.tsx
+++ b/frontend/src/react/pages/project/database-detail/DatabaseSyncButton.tsx
@@ -3,11 +3,8 @@ import { RefreshCw } from "lucide-react";
import { useCallback, useState } from "react";
import { useTranslation } from "react-i18next";
import { Button } from "@/react/components/ui/button";
-import {
- pushNotification,
- useDatabaseV1Store,
- useDBSchemaV1Store,
-} from "@/store";
+import { useAppStore } from "@/react/stores/app";
+import { pushNotification, useDatabaseV1Store } from "@/store";
import type { Database } from "@/types/proto-es/v1/database_service_pb";
const extractDatabaseName = (resource: string) => {
@@ -26,7 +23,9 @@ export function DatabaseSyncButton({
}) {
const { t } = useTranslation();
const databaseStore = useDatabaseV1Store();
- const dbSchemaStore = useDBSchemaV1Store();
+ const getOrFetchDatabaseMetadata = useAppStore(
+ (s) => s.getOrFetchDatabaseMetadata
+ );
const [syncing, setSyncing] = useState(false);
const handleClick = useCallback(async () => {
@@ -34,7 +33,7 @@ export function DatabaseSyncButton({
try {
await databaseStore.syncDatabase(database.name);
- await dbSchemaStore.getOrFetchDatabaseMetadata({
+ await getOrFetchDatabaseMetadata({
database: database.name,
skipCache: true,
});
@@ -61,7 +60,7 @@ export function DatabaseSyncButton({
} finally {
setSyncing(false);
}
- }, [database, databaseStore, dbSchemaStore, t]);
+ }, [database, databaseStore, getOrFetchDatabaseMetadata, t]);
return (
<Button
diff --git a/frontend/src/react/pages/project/database-detail/overview/DatabaseObjectExplorer.test.tsx b/frontend/src/react/pages/project/database-detail/overview/DatabaseObjectExplorer.test.tsx
index 0d33cc43cb..fd93a82ac1 100644
--- a/frontend/src/react/pages/project/database-detail/overview/DatabaseObjectExplorer.test.tsx
+++ b/frontend/src/react/pages/project/database-detail/overview/DatabaseObjectExplorer.test.tsx
@@ -68,8 +68,21 @@ vi.mock("@/router", () => ({
},
}));
+// The component now reads dbSchema getters via the app store. Route the
+// existing `mocks.useDBSchemaV1Store` shape through `useAppStore` so the
+// test bodies' per-scenario `.mockReturnValue({ getSchemaList, ... })`
+// calls keep working without further changes.
+vi.mock("@/react/stores/app", () => ({
+ useAppStore: (selector: (s: unknown) => unknown) =>
+ selector(mocks.useDBSchemaV1Store()),
+}));
+
+vi.mock("@/react/hooks/useAppDatabaseMetadata", () => ({
+ useAppDatabaseMetadata: (name: string) =>
+ mocks.useDBSchemaV1Store().getDatabaseMetadata?.(name) ?? { schemas: [] },
+}));
+
vi.mock("@/store", () => ({
- useDBSchemaV1Store: mocks.useDBSchemaV1Store,
useDatabaseCatalog: mocks.useDatabaseCatalog,
getColumnCatalog: mocks.getColumnCatalog,
getTableCatalog: mocks.getTableCatalog,
diff --git a/frontend/src/react/pages/project/database-detail/overview/DatabaseObjectExplorer.tsx b/frontend/src/react/pages/project/database-detail/overview/DatabaseObjectExplorer.tsx
index c3091cb25d..c9b7a21b70 100644
--- a/frontend/src/react/pages/project/database-detail/overview/DatabaseObjectExplorer.tsx
+++ b/frontend/src/react/pages/project/database-detail/overview/DatabaseObjectExplorer.tsx
@@ -9,14 +9,15 @@ import {
SelectTrigger,
SelectValue,
} from "@/react/components/ui/select";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { useVueState } from "@/react/hooks/useVueState";
+import { useAppStore } from "@/react/stores/app";
import { router } from "@/router";
import {
featureToRef,
getColumnCatalog,
getTableCatalog,
useDatabaseCatalog,
- useDBSchemaV1Store,
useSettingV1Store,
} from "@/store";
import { Engine } from "@/types/proto-es/v1/common_pb";
@@ -79,36 +80,31 @@ export function DatabaseObjectExplorer({
onExternalTableSearchKeywordChange: (value: string) => void;
}) {
const { t } = useTranslation();
- const dbSchemaStore = useDBSchemaV1Store();
const settingStore = useSettingV1Store();
const databaseEngine = getDatabaseEngine(database);
const supportsSchema = hasSchemaProperty(databaseEngine);
- const schemaList = useVueState(() =>
- dbSchemaStore.getSchemaList(database.name)
- );
- const tableList = useVueState(() =>
- dbSchemaStore.getTableList({
+ const schemaList = useAppStore((s) => s.getSchemaList(database.name));
+ const tableList = useAppStore((s) =>
+ s.getTableList({
database: database.name,
schema: selectedSchemaName,
})
);
- const viewList = useVueState(() =>
- dbSchemaStore.getViewList({
+ const viewList = useAppStore((s) =>
+ s.getViewList({
database: database.name,
schema: selectedSchemaName,
})
);
- const extensionList = useVueState(() =>
- dbSchemaStore.getExtensionList(database.name)
- );
- const externalTableList = useVueState(() =>
- dbSchemaStore.getExternalTableList({
+ const extensionList = useAppStore((s) => s.getExtensionList(database.name));
+ const externalTableList = useAppStore((s) =>
+ s.getExternalTableList({
database: database.name,
schema: selectedSchemaName,
})
);
- const functionList = useVueState(() =>
- dbSchemaStore.getFunctionList({
+ const functionList = useAppStore((s) =>
+ s.getFunctionList({
database: database.name,
schema: selectedSchemaName,
})
@@ -117,9 +113,7 @@ export function DatabaseObjectExplorer({
const table = router.currentRoute.value.query.table;
return typeof table === "string" ? table : "";
});
- const databaseMetadata = useVueState(() =>
- dbSchemaStore.getDatabaseMetadata(database.name)
- );
+ const databaseMetadata = useAppDatabaseMetadata(database.name);
const hasSensitiveDataFeature = useVueState(
() => featureToRef(PlanFeature.FEATURE_DATA_MASKING).value
);
diff --git a/frontend/src/react/pages/project/database-detail/overview/DatabaseOverviewInfo.tsx b/frontend/src/react/pages/project/database-detail/overview/DatabaseOverviewInfo.tsx
index b4c3906da3..7781b551b2 100644
--- a/frontend/src/react/pages/project/database-detail/overview/DatabaseOverviewInfo.tsx
+++ b/frontend/src/react/pages/project/database-detail/overview/DatabaseOverviewInfo.tsx
@@ -1,6 +1,5 @@
import { useTranslation } from "react-i18next";
-import { useVueState } from "@/react/hooks/useVueState";
-import { useDBSchemaV1Store } from "@/store";
+import { useAppDatabaseMetadata } from "@/react/hooks/useAppDatabaseMetadata";
import { Engine, State } from "@/types/proto-es/v1/common_pb";
import {
type Database,
@@ -14,11 +13,8 @@ import {
export function DatabaseOverviewInfo({ database }: { database: Database }) {
const { t } = useTranslation();
- const dbSchemaStore = useDBSchemaV1Store();
const databaseEngine = getDatabaseEngine(database);
- const databaseSchemaMetadata = useVueState(() =>
- dbSchemaStore.getDatabaseMetadata(database.name)
- );
+ const databaseSchemaMetadata = useAppDatabaseMetadata(database.name);
const lastSyncDate = database.successfulSyncTime
? new Date(Number(database.successfulSyncTime.seconds) * 1000)
: undefined;
diff --git a/frontend/src/react/pages/project/database-detail/panels/DatabaseOverviewPanel.test.tsx b/frontend/src/react/pages/project/database-detail/panels/DatabaseOverviewPanel.test.tsx
index 5322f9127b..a864780f11 100644
--- a/frontend/src/react/pages/project/database-detail/panels/DatabaseOverviewPanel.test.tsx
+++ b/frontend/src/react/pages/project/database-detail/panels/DatabaseOverviewPanel.test.tsx
@@ -88,8 +88,21 @@ vi.mock("@/router", () => ({
},
}));
+// The component (and its child `DatabaseObjectExplorer`) now read dbSchema
+// getters via the app store. Route the existing `mocks.useDBSchemaV1Store`
+// shape through `useAppStore` so the per-scenario `.mockReturnValue({...})`
+// calls in test bodies keep working without further changes.
+vi.mock("@/react/stores/app", () => ({
+ useAppStore: (selector: (s: unknown) => unknown) =>
+ selector(mocks.useDBSchemaV1Store()),
+}));
+
+vi.mock("@/react/hooks/useAppDatabaseMetadata", () => ({
+ useAppDatabaseMetadata: (name: string) =>
+ mocks.useDBSchemaV1Store().getDatabaseMetadata?.(name) ?? { schemas: [] },
+}));
+
vi.mock("@/store", () => ({
- useDBSchemaV1Store: mocks.useDBSchemaV1Store,
useDatabaseCatalog: mocks.useDatabaseCatalog,
useSubscriptionV1Store: mocks.useSubscriptionV1Store,
getColumnCatalog: mocks.getColumnCatalog,
diff --git a/frontend/src/react/pages/project/database-detail/panels/DatabaseOverviewPanel.tsx b/frontend/src/react/pages/project/database-detail/panels/DatabaseOverviewPanel.tsx
index 7b0b1054c7..6473b5ff75 100644
--- a/frontend/src/react/pages/project/database-detail/panels/DatabaseOverviewPanel.tsx
+++ b/frontend/src/react/pages/project/database-detail/panels/DatabaseOverviewPanel.tsx
@@ -1,7 +1,7 @@
import { useEffect, useMemo, useState } from "react";
import { useVueState } from "@/react/hooks/useVueState";
+import { useAppStore } from "@/react/stores/app";
import { router } from "@/router";
-import { useDBSchemaV1Store } from "@/store";
import type { Database } from "@/types/proto-es/v1/database_service_pb";
import { getDatabaseProject, hasProjectPermissionV2 } from "@/utils";
import { DatabaseObjectExplorer } from "../overview/DatabaseObjectExplorer";
@@ -14,10 +14,7 @@ export function DatabaseOverviewPanel({
database: Database;
hasSchemaPermission?: boolean;
}) {
- const dbSchemaStore = useDBSchemaV1Store();
- const schemaList = useVueState(() =>
- dbSchemaStore.getSchemaList(database.name)
- );
+ const schemaList = useAppStore((s) => s.getSchemaList(database.name));
const routeSchema = useVueState(() => {
const schema = router.currentRoute.value.query.schema;
return typeof schema === "string" ? schema : "";
diff --git a/frontend/src/react/pages/project/database-detail/useProjectDatabaseDetail.test.tsx b/frontend/src/react/pages/project/database-detail/useProjectDatabaseDetail.test.tsx
index b8ef37995f..438ab356ce 100644
--- a/frontend/src/react/pages/project/database-detail/useProjectDatabaseDetail.test.tsx
+++ b/frontend/src/react/pages/project/database-detail/useProjectDatabaseDetail.test.tsx
@@ -62,7 +62,22 @@ vi.mock("@/router/dashboard/projectV1", () => ({
vi.mock("@/store", () => ({
useDatabaseV1Store: () => mocks.databaseStore,
- useDBSchemaV1Store: () => mocks.dbSchemaStore,
+}));
+
+vi.mock("@/react/stores/app", () => ({
+ useAppStore: Object.assign(
+ (selector: (s: unknown) => unknown) =>
+ selector({
+ getOrFetchDatabaseMetadata:
+ mocks.dbSchemaStore.getOrFetchDatabaseMetadata,
+ }),
+ {
+ getState: () => ({
+ getOrFetchDatabaseMetadata:
+ mocks.dbSchemaStore.getOrFetchDatabaseMetadata,
+ }),
+ }
+ ),
}));
vi.mock("@/utils", () => ({
diff --git a/frontend/src/react/pages/project/database-detail/useProjectDatabaseDetail.ts b/frontend/src/react/pages/project/database-detail/useProjectDatabaseDetail.ts
index e3e4c95f59..47dc1c92d4 100644
--- a/frontend/src/react/pages/project/database-detail/useProjectDatabaseDetail.ts
+++ b/frontend/src/react/pages/project/database-detail/useProjectDatabaseDetail.ts
@@ -1,13 +1,14 @@
import { useEffect, useMemo, useState } from "react";
import type { LocationQueryRaw } from "vue-router";
import { useVueState } from "@/react/hooks/useVueState";
+import { useAppStore } from "@/react/stores/app";
import { router } from "@/router";
import {
PROJECT_V1_ROUTE_DATABASE_CHANGELOG_DETAIL,
PROJECT_V1_ROUTE_DATABASE_DETAIL,
PROJECT_V1_ROUTE_DATABASE_REVISION_DETAIL,
} from "@/router/dashboard/projectV1";
-import { useDatabaseV1Store, useDBSchemaV1Store } from "@/store";
+import { useDatabaseV1Store } from "@/store";
import { isDefaultProject } from "@/types/v1/project";
import { getInstanceResource, instanceV1HasAlterSchema } from "@/utils";
import { extractProjectResourceName } from "@/utils/v1/project";
@@ -34,7 +35,9 @@ export function useProjectDatabaseDetail({
revisionId,
}: UseProjectDatabaseDetailOptions) {
const databaseStore = useDatabaseV1Store();
- const dbSchemaStore = useDBSchemaV1Store();
+ const getOrFetchDatabaseMetadata = useAppStore(
+ (s) => s.getOrFetchDatabaseMetadata
+ );
const fullDatabaseName = `instances/${instanceId}/databases/${databaseName}`;
const database = useVueState(() =>
databaseStore.getDatabaseByName(fullDatabaseName)
@@ -49,7 +52,7 @@ export function useProjectDatabaseDetail({
.getOrFetchDatabaseByName(fullDatabaseName)
.then(async (db) => {
try {
- await dbSchemaStore.getOrFetchDatabaseMetadata({
+ await getOrFetchDatabaseMetadata({
database: db.name,
silent: true,
});
@@ -92,7 +95,7 @@ export function useProjectDatabaseDetail({
changelogId,
databaseName,
databaseStore,
- dbSchemaStore,
+ getOrFetchDatabaseMetadata,
fullDatabaseName,
instanceId,
projectId,
diff --git a/frontend/src/react/pages/project/plan-detail/components/SchemaEditorSheet.tsx b/frontend/src/react/pages/project/plan-detail/components/SchemaEditorSheet.tsx
index 034723ccf3..12f90574d7 100644
--- a/frontend/src/react/pages/project/plan-detail/components/SchemaEditorSheet.tsx
+++ b/frontend/src/react/pages/project/plan-detail/components/SchemaEditorSheet.tsx
@@ -16,11 +16,8 @@ import {
SheetTitle,
} from "@/react/components/ui/sheet";
import { useVueState } from "@/react/hooks/useVueState";
-import {
- pushNotification,
- useDatabaseV1Store,
- useDBSchemaV1Store,
-} from "@/store";
+import { useAppStore } from "@/react/stores/app";
+import { pushNotification, useDatabaseV1Store } from "@/store";
import { isValidDatabaseName } from "@/types";
import type { Project } from "@/types/proto-es/v1/project_service_pb";
import { extractDatabaseResourceName, getInstanceResource } from "@/utils";
@@ -90,7 +87,9 @@ function SchemaEditorSheetBody({
onMaximizedChange,
}: BodyProps) {
const { t } = useTranslation();
- const dbSchemaStore = useDBSchemaV1Store();
+ const getOrFetchDatabaseMetadata = useAppStore(
+ (s) => s.getOrFetchDatabaseMetadata
+ );
const databaseStore = useDatabaseV1Store();
const schemaEditorRef = useRef<SchemaEditorHandle>(null);
@@ -146,7 +145,7 @@ function SchemaEditorSheetBody({
setTargets([]);
try {
const [metadata, database] = await Promise.all([
- dbSchemaStore.getOrFetchDatabaseMetadata({
+ getOrFetchDatabaseMetadata({
database: databaseName,
skipCache: true,
limit: 200,
@@ -170,7 +169,7 @@ function SchemaEditorSheetBody({
}
}
},
- [dbSchemaStore, databaseStore]
+ [getOrFetchDatabaseMetadata, databaseStore]
);
useEffect(() => {
diff --git a/frontend/src/react/pages/settings/DatabasesPage.tsx b/frontend/src/react/pages/settings/DatabasesPage.tsx
index 6d94d745d8..3fe1c38eae 100644
--- a/frontend/src/react/pages/settings/DatabasesPage.tsx
+++ b/frontend/src/react/pages/settings/DatabasesPage.tsx
@@ -24,12 +24,12 @@ import { PermissionGuard } from "@/react/components/PermissionGuard";
import { Button } from "@/react/components/ui/button";
import { useVueState } from "@/react/hooks/useVueState";
import type { DatabaseFilter } from "@/react/lib/databaseFilter";
+import { useAppStore } from "@/react/stores/app";
import { router } from "@/router";
import {
pushNotification,
useActuatorV1Store,
useDatabaseV1Store,
- useDBSchemaV1Store,
useEnvironmentV1Store,
useInstanceV1Store,
useProjectV1Store,
@@ -64,7 +64,9 @@ import {
export function DatabasesPage() {
const { t } = useTranslation();
const databaseStore = useDatabaseV1Store();
- const dbSchemaStore = useDBSchemaV1Store();
+ const removeDatabaseMetadataCache = useAppStore(
+ (s) => s.removeDatabaseMetadataCache
+ );
const actuatorStore = useActuatorV1Store();
const environmentStore = useEnvironmentV1Store();
const uiStateStore = useUIStateStore();
@@ -383,7 +385,7 @@ export function DatabasesPage() {
try {
await databaseStore.batchSyncDatabases(Array.from(selectedNames));
for (const name of selectedNames) {
- dbSchemaStore.removeCache(name);
+ removeDatabaseMetadataCache(name);
}
pushNotification({
module: "bytebase",
@@ -400,7 +402,7 @@ export function DatabasesPage() {
} finally {
setSyncing(false);
}
- }, [syncing, selectedNames, databaseStore, dbSchemaStore, t]);
+ }, [syncing, selectedNames, databaseStore, removeDatabaseMetadataCache, t]);
const handleLabelsApply = useCallback(
async (labelsList: { [key: string]: string }[]) => {
diff --git a/frontend/src/react/pages/settings/InstanceDetailPage.tsx b/frontend/src/react/pages/settings/InstanceDetailPage.tsx
index f25efda4e2..d213861bab 100644
--- a/frontend/src/react/pages/settings/InstanceDetailPage.tsx
+++ b/frontend/src/react/pages/settings/InstanceDetailPage.tsx
@@ -36,11 +36,11 @@ import {
} from "@/react/components/ui/tabs";
import { useUnsavedChangesGuard } from "@/react/hooks/useUnsavedChangesGuard";
import { useVueState } from "@/react/hooks/useVueState";
+import { useAppStore } from "@/react/stores/app";
import {
pushNotification,
useActuatorV1Store,
useDatabaseV1Store,
- useDBSchemaV1Store,
useEnvironmentV1Store,
useInstanceV1Store,
useProjectV1Store,
@@ -79,7 +79,9 @@ export function InstanceDetailPage({ instanceId }: { instanceId: string }) {
const { t } = useTranslation();
const instanceStore = useInstanceV1Store();
const databaseStore = useDatabaseV1Store();
- const dbSchemaStore = useDBSchemaV1Store();
+ const removeDatabaseMetadataCache = useAppStore(
+ (s) => s.removeDatabaseMetadataCache
+ );
const instanceName = `${instanceNamePrefix}${instanceId}`;
const instance = useVueState(() =>
instanceStore.getInstanceByName(instanceName)
@@ -131,7 +133,7 @@ export function InstanceDetailPage({ instanceId }: { instanceId: string }) {
try {
await databaseStore.batchSyncDatabases(Array.from(selectedNames));
for (const name of selectedNames) {
- dbSchemaStore.removeCache(name);
+ removeDatabaseMetadataCache(name);
}
pushNotification({
module: "bytebase",
@@ -148,7 +150,7 @@ export function InstanceDetailPage({ instanceId }: { instanceId: string }) {
} finally {
setSyncing(false);
}
- }, [syncing, selectedNames, databaseStore, dbSchemaStore, t]);
+ }, [syncing, selectedNames, databaseStore, removeDatabaseMetadataCache, t]);
const handleLabelsApply = useCallback(
async (labelsList: { [key: string]: string }[]) => {
diff --git a/frontend/src/react/stores/app/dbSchema.ts b/frontend/src/react/stores/app/dbSchema.ts
new file mode 100644
index 0000000000..88f83f97c3
--- /dev/null
+++ b/frontend/src/react/stores/app/dbSchema.ts
@@ -0,0 +1,268 @@
+import { create as createProto } from "@bufbuild/protobuf";
+import { createContextValues } from "@connectrpc/connect";
+import { databaseServiceClientConnect } from "@/connect";
+import { silentContextKey } from "@/connect/context-key";
+import { UNKNOWN_ID } from "@/types/const";
+import {
+ type DatabaseMetadata,
+ DatabaseMetadataSchema,
+ type ExtensionMetadata,
+ type ExternalTableMetadata,
+ ExternalTableMetadataSchema,
+ type FunctionMetadata,
+ GetDatabaseMetadataRequestSchema,
+ type SchemaMetadata,
+ type TableMetadata,
+ TableMetadataSchema,
+ type ViewMetadata,
+ ViewMetadataSchema,
+} from "@/types/proto-es/v1/database_service_pb";
+import { UNKNOWN_INSTANCE_NAME } from "@/types/v1/instance";
+import { extractDatabaseResourceName } from "@/utils";
+import type { AppSliceCreator, DBSchemaSlice } from "./types";
+
+const ensureDatabaseResourceName = (name: string) =>
+ extractDatabaseResourceName(name).database;
+
+const ensureDatabaseMetadataResourceName = (name: string) =>
+ `${ensureDatabaseResourceName(name)}/metadata`;
+
+const cacheKey = (metadataName: string, filter: string, limit: number) =>
+ `${metadataName}::${filter}::${limit}`;
+
+// Module-level singleton placeholders for not-found lookups. Reusing the
+// same reference keeps `useAppStore((s) => s.getXxxMetadata(...))`
+// selectors stable across renders so React's `Object.is` check doesn't
+// fire on every unrelated store update. The legacy Pinia store created a
+// fresh proto each call, but Pinia consumers wrapped the call in
+// `usePiniaBridge` (Vue `watch`) which papered over the instability.
+const EMPTY_TABLE_METADATA: TableMetadata = createProto(
+ TableMetadataSchema,
+ {}
+);
+const EMPTY_VIEW_METADATA: ViewMetadata = createProto(ViewMetadataSchema, {});
+const EMPTY_EXTERNAL_TABLE_METADATA: ExternalTableMetadata = createProto(
+ ExternalTableMetadataSchema,
+ {}
+);
+
+// Stable empty-list singletons so `useAppStore((s) => s.getXxxList(...))`
+// selectors don't return a fresh array on every call (which would trip
+// Zustand's `Object.is` snapshot check and trigger React re-renders on
+// every unrelated store update). Mutation in place is contractually
+// forbidden — consumers must `.concat` / spread to derive new arrays.
+const EMPTY_SCHEMA_LIST: SchemaMetadata[] = [];
+const EMPTY_TABLE_LIST: TableMetadata[] = [];
+const EMPTY_VIEW_LIST: ViewMetadata[] = [];
+const EMPTY_EXTERNAL_TABLE_LIST: ExternalTableMetadata[] = [];
+const EMPTY_FUNCTION_LIST: FunctionMetadata[] = [];
+const EMPTY_EXTENSION_LIST: ExtensionMetadata[] = [];
+
+const isUnknownDatabase = (database: string): boolean => {
+ const { databaseName, instanceName } = extractDatabaseResourceName(database);
+ return (
+ databaseName === String(UNKNOWN_ID) || instanceName === String(UNKNOWN_ID)
+ );
+};
+
+export const createDBSchemaSlice: AppSliceCreator<DBSchemaSlice> = (
+ set,
+ get
+) => ({
+ metadataByName: {},
+ metadataRequests: {},
+
+ getDatabaseMetadata: (database) => {
+ const metadataName = ensureDatabaseMetadataResourceName(database);
+ const cached = get().metadataByName[cacheKey(metadataName, "", 0)];
+ return (
+ cached ?? createProto(DatabaseMetadataSchema, { name: metadataName })
+ );
+ },
+
+ getCachedDatabaseMetadata: (database) => {
+ const metadataName = ensureDatabaseMetadataResourceName(database);
+ return get().metadataByName[cacheKey(metadataName, "", 0)];
+ },
+
+ getSchemaList: (database) => {
+ return (
+ get().getCachedDatabaseMetadata(database)?.schemas ?? EMPTY_SCHEMA_LIST
+ );
+ },
+
+ getSchemaMetadata: ({ database, schema }) => {
+ const metadata = get().getDatabaseMetadata(database);
+ return metadata.schemas.find((s) => s.name === schema);
+ },
+
+ getTableList: ({ database, schema }) => {
+ const schemas = get().getCachedDatabaseMetadata(database)?.schemas;
+ if (!schemas) return EMPTY_TABLE_LIST;
+ if (schema) {
+ return schemas.find((s) => s.name === schema)?.tables ?? EMPTY_TABLE_LIST;
+ }
+ return schemas.flatMap((s) => s.tables);
+ },
+
+ getViewList: ({ database, schema }) => {
+ const schemas = get().getCachedDatabaseMetadata(database)?.schemas;
+ if (!schemas) return EMPTY_VIEW_LIST;
+ if (schema) {
+ return schemas.find((s) => s.name === schema)?.views ?? EMPTY_VIEW_LIST;
+ }
+ return schemas.flatMap((s) => s.views);
+ },
+
+ getExternalTableList: ({ database, schema }) => {
+ const schemas = get().getCachedDatabaseMetadata(database)?.schemas;
+ if (!schemas) return EMPTY_EXTERNAL_TABLE_LIST;
+ if (schema) {
+ return (
+ schemas.find((s) => s.name === schema)?.externalTables ??
+ EMPTY_EXTERNAL_TABLE_LIST
+ );
+ }
+ return schemas.flatMap((s) => s.externalTables);
+ },
+
+ getFunctionList: ({ database, schema }) => {
+ const schemas = get().getCachedDatabaseMetadata(database)?.schemas;
+ if (!schemas) return EMPTY_FUNCTION_LIST;
+ if (schema) {
+ return (
+ schemas.find((s) => s.name === schema)?.functions ?? EMPTY_FUNCTION_LIST
+ );
+ }
+ return schemas.flatMap((s) => s.functions);
+ },
+
+ getExtensionList: (database) => {
+ return (
+ get().getCachedDatabaseMetadata(database)?.extensions ??
+ EMPTY_EXTENSION_LIST
+ );
+ },
+
+ removeDatabaseMetadataCache: (database) => {
+ const metadataName = ensureDatabaseMetadataResourceName(database);
+ const prefix = `${metadataName}::`;
+ set((state) => {
+ const nextEntries: Record<string, DatabaseMetadata> = {};
+ for (const [key, value] of Object.entries(state.metadataByName)) {
+ if (!key.startsWith(prefix)) nextEntries[key] = value;
+ }
+ const nextRequests: Record<string, Promise<DatabaseMetadata>> = {};
+ for (const [key, value] of Object.entries(state.metadataRequests)) {
+ if (!key.startsWith(prefix)) nextRequests[key] = value;
+ }
+ return {
+ metadataByName: nextEntries,
+ metadataRequests: nextRequests,
+ };
+ });
+ },
+
+ getTableMetadata: ({ database, schema, table }) => {
+ const metadata = get().getDatabaseMetadata(database);
+ const tables = schema
+ ? (metadata.schemas.find((s) => s.name === schema)?.tables ?? [])
+ : metadata.schemas.flatMap((s) => s.tables);
+ return tables.find((t) => t.name === table) ?? EMPTY_TABLE_METADATA;
+ },
+
+ getExternalTableMetadata: ({ database, schema, externalTable }) => {
+ const metadata = get().getDatabaseMetadata(database);
+ const externalTables = schema
+ ? (metadata.schemas.find((s) => s.name === schema)?.externalTables ?? [])
+ : metadata.schemas.flatMap((s) => s.externalTables);
+ return (
+ externalTables.find((t) => t.name === externalTable) ??
+ EMPTY_EXTERNAL_TABLE_METADATA
+ );
+ },
+
+ getViewMetadata: ({ database, schema, view }) => {
+ const metadata = get().getDatabaseMetadata(database);
+ const views = schema
+ ? (metadata.schemas.find((s) => s.name === schema)?.views ?? [])
+ : metadata.schemas.flatMap((s) => s.views);
+ return views.find((v) => v.name === view) ?? EMPTY_VIEW_METADATA;
+ },
+
+ getOrFetchDatabaseMetadata: async (params) => {
+ const {
+ database,
+ skipCache = false,
+ silent = false,
+ limit = 0,
+ filter = "",
+ } = params;
+ if (isUnknownDatabase(database)) {
+ return createProto(DatabaseMetadataSchema, {
+ name: ensureDatabaseMetadataResourceName(
+ `${UNKNOWN_INSTANCE_NAME}/databases/${UNKNOWN_ID}`
+ ),
+ });
+ }
+
+ const metadataName = ensureDatabaseMetadataResourceName(database);
+ const key = cacheKey(metadataName, filter, limit);
+
+ if (!skipCache) {
+ const existing = get().metadataByName[key];
+ if (existing) return existing;
+ const pending = get().metadataRequests[key];
+ if (pending) return pending;
+ }
+
+ const request = databaseServiceClientConnect
+ .getDatabaseMetadata(
+ createProto(GetDatabaseMetadataRequestSchema, {
+ name: metadataName,
+ limit,
+ filter,
+ }),
+ {
+ contextValues: createContextValues().set(silentContextKey, silent),
+ }
+ )
+ .then((metadata: DatabaseMetadata) => {
+ set((state) => {
+ const { [key]: _, ...metadataRequests } = state.metadataRequests;
+ return {
+ metadataByName: {
+ ...state.metadataByName,
+ [key]: metadata,
+ },
+ metadataRequests,
+ };
+ });
+ return metadata;
+ })
+ .catch((error) => {
+ set((state) => {
+ const { [key]: _, ...metadataRequests } = state.metadataRequests;
+ return { metadataRequests };
+ });
+ throw error;
+ });
+ set((state) => ({
+ metadataRequests: {
+ ...state.metadataRequests,
+ [key]: request,
+ },
+ }));
+ return request;
+ },
+});
+
+// Re-export types so consumers don't reach into `types.ts` for narrow
+// per-slice types.
+export type {
+ DatabaseMetadata,
+ ExternalTableMetadata,
+ SchemaMetadata,
+ TableMetadata,
+ ViewMetadata,
+};
diff --git a/frontend/src/react/stores/app/index.test.ts b/frontend/src/react/stores/app/index.test.ts
index c90a8ed0b4..0989a50d8a 100644
--- a/frontend/src/react/stores/app/index.test.ts
+++ b/frontend/src/react/stores/app/index.test.ts
@@ -108,6 +108,7 @@ const mocks = vi.hoisted(() => ({
listDatabases: vi.fn(),
listChangelogs: vi.fn(),
getChangelog: vi.fn(),
+ getDatabaseMetadata: vi.fn(),
getDatabaseGroup: vi.fn(),
listDatabaseGroups: vi.fn(),
getSheet: vi.fn(),
@@ -191,6 +192,7 @@ vi.mock("@/connect", () => ({
listDatabases: mocks.listDatabases,
listChangelogs: mocks.listChangelogs,
getChangelog: mocks.getChangelog,
+ getDatabaseMetadata: mocks.getDatabaseMetadata,
},
databaseGroupServiceClientConnect: {
getDatabaseGroup: mocks.getDatabaseGroup,
@@ -1831,4 +1833,83 @@ describe("useAppStore", () => {
);
window.removeEventListener(ReactShellBridgeEvent.quickstartReset, listener);
});
+
+ test("caches database metadata and reuses inflight request", async () => {
+ const {
+ DatabaseMetadataSchema,
+ SchemaMetadataSchema,
+ TableMetadataSchema,
+ } = await import("@/types/proto-es/v1/database_service_pb");
+ const metadata = createProto(DatabaseMetadataSchema, {
+ name: "instances/i1/databases/db1/metadata",
+ schemas: [
+ createProto(SchemaMetadataSchema, {
+ name: "public",
+ tables: [createProto(TableMetadataSchema, { name: "users" })],
+ }),
+ ],
+ });
+ mocks.getDatabaseMetadata.mockResolvedValue(metadata);
+ const store = createAppStore();
+
+ const [first, second] = await Promise.all([
+ store
+ .getState()
+ .getOrFetchDatabaseMetadata({ database: "instances/i1/databases/db1" }),
+ store
+ .getState()
+ .getOrFetchDatabaseMetadata({ database: "instances/i1/databases/db1" }),
+ ]);
+
+ expect(first).toBe(metadata);
+ expect(second).toBe(metadata);
+ // Concurrent calls dedupe through `metadataRequests`.
+ expect(mocks.getDatabaseMetadata).toHaveBeenCalledTimes(1);
+
+ // Sync derived getters resolve through the cached metadata.
+ expect(
+ store.getState().getTableMetadata({
+ database: "instances/i1/databases/db1",
+ schema: "public",
+ table: "users",
+ }).name
+ ).toBe("users");
+ // Unknown table falls back to an empty TableMetadata placeholder
+ // (mirrors the legacy Pinia store's behavior).
+ expect(
+ store.getState().getTableMetadata({
+ database: "instances/i1/databases/db1",
+ schema: "public",
+ table: "missing",
+ }).name
+ ).toBe("");
+ });
+
+ test("keeps metadata cache isolated by filter and limit", async () => {
+ const { DatabaseMetadataSchema, SchemaMetadataSchema } = await import(
+ "@/types/proto-es/v1/database_service_pb"
+ );
+ const fullMetadata = createProto(DatabaseMetadataSchema, {
+ name: "instances/i1/databases/db1/metadata",
+ schemas: [createProto(SchemaMetadataSchema, { name: "public" })],
+ });
+ const filteredMetadata = createProto(DatabaseMetadataSchema, {
+ name: "instances/i1/databases/db1/metadata",
+ schemas: [createProto(SchemaMetadataSchema, { name: "filtered" })],
+ });
+ mocks.getDatabaseMetadata
+ .mockResolvedValueOnce(fullMetadata)
+ .mockResolvedValueOnce(filteredMetadata);
+ const store = createAppStore();
+
+ await store
+ .getState()
+ .getOrFetchDatabaseMetadata({ database: "instances/i1/databases/db1" });
+ await store.getState().getOrFetchDatabaseMetadata({
+ database: "instances/i1/databases/db1",
+ filter: `schema == "filtered"`,
+ });
+
+ expect(mocks.getDatabaseMetadata).toHaveBeenCalledTimes(2);
+ });
});
diff --git a/frontend/src/react/stores/app/index.ts b/frontend/src/react/stores/app/index.ts
index f3971e7a5a..b3a7054d26 100644
--- a/frontend/src/react/stores/app/index.ts
+++ b/frontend/src/react/stores/app/index.ts
@@ -4,6 +4,7 @@ import { createAuthSlice } from "./auth";
import { createChangelogSlice } from "./changelog";
import { createDatabaseSlice } from "./database";
import { createDBGroupSlice } from "./dbGroup";
+import { createDBSchemaSlice } from "./dbSchema";
import { createGroupSlice } from "./group";
import { createIamSlice } from "./iam";
import { createIdentityProviderSlice } from "./identityProvider";
@@ -44,6 +45,7 @@ export const createAppStore = () =>
...createInstanceSlice(...args),
...createDatabaseSlice(...args),
...createDBGroupSlice(...args),
+ ...createDBSchemaSlice(...args),
...createSheetSlice(...args),
...createWorksheetSlice(...args),
...createInstanceRoleSlice(...args),
diff --git a/frontend/src/react/stores/app/types.ts b/frontend/src/react/stores/app/types.ts
index c13a7cfa5d..0139963a3e 100644
--- a/frontend/src/react/stores/app/types.ts
+++ b/frontend/src/react/stores/app/types.ts
@@ -14,8 +14,15 @@ import type {
Changelog,
ChangelogView,
Database,
+ DatabaseMetadata,
+ ExtensionMetadata,
+ ExternalTableMetadata,
+ FunctionMetadata,
GetChangelogRequest,
ListChangelogsRequest,
+ SchemaMetadata,
+ TableMetadata,
+ ViewMetadata,
} from "@/types/proto-es/v1/database_service_pb";
import type { Group } from "@/types/proto-es/v1/group_service_pb";
import type { IamPolicy } from "@/types/proto-es/v1/iam_policy_pb";
@@ -175,6 +182,10 @@ export type WorkspaceSlice = {
name: Setting_SettingName,
silent?: boolean
) => Promise<Setting | undefined>;
+ // Bridge: lets the legacy Pinia `useSettingV1Store.upsertSetting` push
+ // updates into the app store after a save, so still-app-store consumers
+ // (e.g. SQL editor's `OpenAIButton`) see fresh values without a refresh.
+ setSettingByName: (setting: Setting) => void;
loadSubscription: () => Promise<Subscription | undefined>;
refreshSubscription: () => Promise<Subscription | undefined>;
uploadLicense: (license: string) => Promise<Subscription | undefined>;
@@ -631,6 +642,80 @@ export type SQLSlice = {
exportData: (params: ExportRequest) => Promise<Uint8Array>;
};
+export interface GetOrFetchDatabaseMetadataParams {
+ database: string;
+ skipCache?: boolean;
+ silent?: boolean;
+ // Limit the number of returned tables per schema.
+ limit?: number;
+ // CEL filter, e.g. `schema == "public" && table.contains("user")`.
+ filter?: string;
+}
+
+export type DBSchemaSlice = {
+ // Cache key: `${metadataResourceName}::${filter}::${limit}` — mirrors the
+ // Pinia store's `[name, filter, limit]` triple so filtered/sliced fetches
+ // don't collide with full-metadata fetches.
+ metadataByName: Record<string, DatabaseMetadata>;
+ metadataRequests: Record<string, Promise<DatabaseMetadata>>;
+
+ getDatabaseMetadata: (database: string) => DatabaseMetadata;
+ // Returns the cached metadata reference (or undefined when uncached)
+ // without the fresh-placeholder fallback `getDatabaseMetadata` adds.
+ // Mirrors the legacy Pinia `getDatabaseMetadataWithoutDefault` — used by
+ // consumers (e.g. SchemaPane) that need to distinguish "not loaded
+ // yet" from "loaded but empty".
+ getCachedDatabaseMetadata: (database: string) => DatabaseMetadata | undefined;
+ getSchemaList: (database: string) => SchemaMetadata[];
+ getSchemaMetadata: (params: {
+ database: string;
+ schema: string;
+ }) => SchemaMetadata | undefined;
+ // List getters mirror the legacy Pinia store API. Each composes from
+ // the cached `DatabaseMetadata` and falls back to an empty array if
+ // metadata isn't loaded yet (matching the legacy contract).
+ getTableList: (params: {
+ database: string;
+ schema?: string;
+ }) => TableMetadata[];
+ getViewList: (params: {
+ database: string;
+ schema?: string;
+ }) => ViewMetadata[];
+ getExternalTableList: (params: {
+ database: string;
+ schema?: string;
+ }) => ExternalTableMetadata[];
+ getFunctionList: (params: {
+ database: string;
+ schema?: string;
+ }) => FunctionMetadata[];
+ getExtensionList: (database: string) => ExtensionMetadata[];
+ // Invalidates all cache entries (across filter/limit variants) for a
+ // database. Used by list pages that want a fresh metadata fetch on
+ // next access (mirrors Pinia `removeCache`).
+ removeDatabaseMetadataCache: (database: string) => void;
+ getTableMetadata: (params: {
+ database: string;
+ table: string;
+ schema?: string;
+ }) => TableMetadata;
+ getExternalTableMetadata: (params: {
+ database: string;
+ schema?: string;
+ externalTable: string;
+ }) => ExternalTableMetadata;
+ getViewMetadata: (params: {
+ database: string;
+ schema?: string;
+ view: string;
+ }) => ViewMetadata;
+
+ getOrFetchDatabaseMetadata: (
+ params: GetOrFetchDatabaseMetadataParams
+ ) => Promise<DatabaseMetadata>;
+};
+
export type AppStoreState = AuthSlice &
WorkspaceSlice &
IamSlice &
@@ -656,6 +741,7 @@ export type AppStoreState = AuthSlice &
PreferencesSlice &
SQLSlice &
IssueSlice &
- PolicySlice;
+ PolicySlice &
+ DBSchemaSlice;
export type AppSliceCreator<Slice> = StateCreator<AppStoreState, [], [], Slice>;
diff --git a/frontend/src/react/stores/app/workspace.ts b/frontend/src/react/stores/app/workspace.ts
index 7f077c68f6..5b03018512 100644
--- a/frontend/src/react/stores/app/workspace.ts
+++ b/frontend/src/react/stores/app/workspace.ts
@@ -351,6 +351,15 @@ export const createWorkspaceSlice: AppSliceCreator<WorkspaceSlice> = (
return get().settingsByName[resourceName];
},
+ setSettingByName: (setting) => {
+ set((state) => ({
+ settingsByName: {
+ ...state.settingsByName,
+ [setting.name]: setting,
+ },
+ }));
+ },
+
getOrFetchSettingByName: async (name, silent = false) => {
const resourceName = `${settingNamePrefix}${Setting_SettingName[name]}`;
const cached = get().settingsByName[resourceName];
diff --git a/frontend/src/store/modules/v1/setting.ts b/frontend/src/store/modules/v1/setting.ts
index ee7d926e89..b1cf30f458 100644
--- a/frontend/src/store/modules/v1/setting.ts
+++ b/frontend/src/store/modules/v1/setting.ts
@@ -120,6 +120,17 @@ export const useSettingV1Store = defineStore("setting_v1", () => {
});
const response = await settingServiceClientConnect.updateSetting(request);
settingMapByName.set(response.name, response);
+ // Bridge: keep the React app-store setting cache in sync so React
+ // consumers (e.g. SQL editor's `OpenAIButton`) see the fresh value
+ // without a page refresh. Dynamic-imported to avoid a static
+ // module-load cycle (the app store transitively imports `@/store`).
+ try {
+ const { useAppStore } = await import("@/react/stores/app");
+ useAppStore.getState().setSettingByName(response);
+ } catch {
+ // App store not available (some isolated test). Pinia cache is
+ // already updated above.
+ }
return response;
};
diff --git a/frontend/src/utils/v1/databaseResource.ts b/frontend/src/utils/v1/databaseResource.ts
index 0673a29b11..6c1f7387a6 100644
--- a/frontend/src/utils/v1/databaseResource.ts
+++ b/frontend/src/utils/v1/databaseResource.ts
@@ -1,5 +1,5 @@
import { flatten, isUndefined } from "lodash-es";
-import { useDBSchemaV1Store } from "@/store";
+import { useAppStore } from "@/react/stores/app";
import {
databaseNamePrefix,
instanceNamePrefix,
@@ -129,10 +129,9 @@ export const getSchemaOrTableTreeOptions = ({
// do not support table level select for MongoDB.
return [];
}
- const dbSchemaStore = useDBSchemaV1Store();
- const databaseMetadata = dbSchemaStore.getDatabaseMetadataWithoutDefault(
- database.name
- );
+ const databaseMetadata = useAppStore
+ .getState()
+ .getCachedDatabaseMetadata(database.name);
if (!databaseMetadata) {
return undefined;
}