Skip to content

armgit / dbx

Public Imported from GitHub
0

25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。

feat(oceanbase): show and search object comments

efeirec1095223185d
diff --git a/agents/drivers/oceanbase-oracle/src/main/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleAgent.java b/agents/drivers/oceanbase-oracle/src/main/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleAgent.java
index 80fdd611a2..afec2e0668 100644
--- a/agents/drivers/oceanbase-oracle/src/main/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleAgent.java
+++ b/agents/drivers/oceanbase-oracle/src/main/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleAgent.java
@@ -299,13 +299,15 @@ public final class OceanBaseOracleAgent extends ConfiguredJdbcAgent {
return List.of();
}
String baseSql = """
- SELECT OBJECT_NAME, OBJECT_TYPE
- FROM ALL_OBJECTS
- WHERE OWNER = ? AND OBJECT_TYPE IN (%s)
+ SELECT o.OBJECT_NAME, o.OBJECT_TYPE, c.COMMENTS
+ FROM ALL_OBJECTS o
+ LEFT JOIN ALL_TAB_COMMENTS c ON c.OWNER = o.OWNER AND c.TABLE_NAME = o.OBJECT_NAME
+ AND o.OBJECT_TYPE IN ('TABLE', 'VIEW')
+ WHERE o.OWNER = ? AND o.OBJECT_TYPE IN (%s)
""".stripIndent().trim();
MetadataSql query = oceanBaseMetadataSql(
String.format(baseSql, placeholders(objectTypes.size())),
- "OBJECT_NAME, OBJECT_TYPE",
+ "OBJECT_NAME, OBJECT_TYPE, COMMENTS",
"OBJECT_NAME",
"""
ORDER BY CASE OBJECT_TYPE
@@ -335,7 +337,7 @@ public final class OceanBaseOracleAgent extends ConfiguredJdbcAgent {
while (rs.next()) {
String objectType = rs.getString(2);
result.add(new ObjectInfo(rs.getString(1),
- "PACKAGE BODY".equals(objectType) ? "PACKAGE_BODY" : objectType, owner, null));
+ "PACKAGE BODY".equals(objectType) ? "PACKAGE_BODY" : objectType, owner, rs.getString(3)));
}
}
}
@@ -681,8 +683,11 @@ public final class OceanBaseOracleAgent extends ConfiguredJdbcAgent {
args.addAll(objectTypes);
String sql = baseSql;
if (constraints.hasFilter()) {
- sql += " AND UPPER(" + nameColumn + ") LIKE ? ESCAPE '\\'";
- args.add(constraints.fuzzyLikePattern().toUpperCase(Locale.ROOT));
+ sql += " AND (UPPER(" + nameColumn + ") LIKE ? ESCAPE '\\'"
+ + " OR UPPER(c.COMMENTS) LIKE ? ESCAPE '\\')";
+ String pattern = constraints.fuzzyLikePattern().toUpperCase(Locale.ROOT);
+ args.add(pattern);
+ args.add(pattern);
}
sql += "\n" + orderSql;
if (constraints.hasLimit()) {
diff --git a/agents/drivers/oceanbase-oracle/src/test/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleAgentTest.java b/agents/drivers/oceanbase-oracle/src/test/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleAgentTest.java
index ffc78b2f80..285d2594c4 100644
--- a/agents/drivers/oceanbase-oracle/src/test/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleAgentTest.java
+++ b/agents/drivers/oceanbase-oracle/src/test/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleAgentTest.java
@@ -430,9 +430,9 @@ class OceanBaseOracleAgentTest {
List<String> sql = new ArrayList<>();
OceanBaseOracleAgent agent = new OceanBaseOracleAgent();
TestSupport.setPrivateConnection(agent, preparedConnection(sql, resultSet(
- new String[]{"OBJECT_NAME", "OBJECT_TYPE"},
+ new String[]{"OBJECT_NAME", "OBJECT_TYPE", "COMMENTS"},
new Object[][]{
- {"FORMAT_USER", "FUNCTION"}
+ {"FORMAT_USER", "FUNCTION", null}
}
)));
diff --git a/agents/drivers/oceanbase-oracle/src/test/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleObjectListTest.java b/agents/drivers/oceanbase-oracle/src/test/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleObjectListTest.java
index cde227038d..acf22de33a 100644
--- a/agents/drivers/oceanbase-oracle/src/test/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleObjectListTest.java
+++ b/agents/drivers/oceanbase-oracle/src/test/java/com/dbx/agent/oceanbaseoracle/OceanBaseOracleObjectListTest.java
@@ -23,6 +23,44 @@ import java.util.List;
import static org.junit.jupiter.api.Assertions.*;
class OceanBaseOracleObjectListTest {
+ @Test
+ void tableAndViewCommentsSurviveObjectListing() {
+ JdbcFixture jdbc = new JdbcFixture();
+ jdbc.rows(row("T", "TABLE", "订单备注"), row("V", "VIEW", "Customer view"),
+ row("EMPTY", "TABLE", ""), row("NO_COMMENT", "VIEW", null));
+
+ assertEquals(List.of(
+ new ObjectInfo("T", "TABLE", "APP", "订单备注"),
+ new ObjectInfo("V", "VIEW", "APP", "Customer view"),
+ new ObjectInfo("EMPTY", "TABLE", "APP", ""),
+ new ObjectInfo("NO_COMMENT", "VIEW", "APP", null)
+ ), jdbc.agent.listObjects("APP"));
+ }
+
+ @ParameterizedTest
+ @ValueSource(strings = {"订单", "Customer", "'", "%", "_", "\\"})
+ void commentOnlyMatchesAreBoundBeforePaging(String filter) {
+ JdbcFixture jdbc = new JdbcFixture();
+ JdbcCall call = jdbc.rows(row("Z_LATE", "TABLE", "prefix " + filter + " suffix"));
+ MetadataListConstraints constraints = constraints(filter, 1, 2, "TABLE");
+
+ assertEquals(List.of(new ObjectInfo("Z_LATE", "TABLE", "Mixed.Owner", "prefix " + filter + " suffix")),
+ jdbc.agent.listObjects("Mixed.Owner", constraints));
+
+ assertTrue(call.sql.contains("OR UPPER(c.COMMENTS) LIKE ? ESCAPE '\\'"), call.sql);
+ assertTrue(call.sql.indexOf("UPPER(c.COMMENTS)") < call.sql.indexOf("WHERE ROWNUM <= ?"), call.sql);
+ String pattern = switch (filter) {
+ case "订单" -> "%订%单%";
+ case "Customer" -> "%C%U%S%T%O%M%E%R%";
+ case "'" -> "%'%";
+ case "%" -> "%\\%%";
+ case "_" -> "%\\_%";
+ default -> "%\\\\%";
+ };
+ assertEquals(List.of("Mixed.Owner", "TABLE", pattern, pattern, 3, 2), call.args);
+ call.assertClosed();
+ }
+
@Test
void defaultListsIncludeBothPackageTypesAndKeepExistingTypeOrder() {
JdbcFixture jdbc = new JdbcFixture();
@@ -105,7 +143,7 @@ class OceanBaseOracleObjectListTest {
pages.addAll(jdbc.agent.listObjects("APP",
constraints("k_'%", 1, offset, "PACKAGE", "PACKAGE_BODY")));
- assertEquals(List.of("APP", "PACKAGE", "PACKAGE BODY", "%K%\\_%'%\\%%", offset + 1, offset), call.args);
+ assertEquals(List.of("APP", "PACKAGE", "PACKAGE BODY", "%K%\\_%'%\\%%", "%K%\\_%'%\\%%", offset + 1, offset), call.args);
assertTrue(call.sql.contains("UPPER(OBJECT_NAME) LIKE ? ESCAPE '\\'"), call.sql);
assertTrue(call.sql.contains("ROWNUM <= ?"), call.sql);
assertTrue(call.sql.contains("WHERE DBX_RN > ?"), call.sql);
@@ -355,7 +393,8 @@ class OceanBaseOracleObjectListTest {
}
yield cursor[0] < rows.length;
}
- case "getString" -> rows[cursor[0]][(Integer) values[0] - 1];
+ case "getString" -> (Integer) values[0] <= rows[cursor[0]].length
+ ? rows[cursor[0]][(Integer) values[0] - 1] : null;
case "close" -> {
resultClosed = true;
yield null;
diff --git a/apps/desktop/src/components/objects/__tests__/ObjectBrowser.oceanbaseCommentSearch.component.spec.ts b/apps/desktop/src/components/objects/__tests__/ObjectBrowser.oceanbaseCommentSearch.component.spec.ts
new file mode 100644
index 0000000000..e7b7b8e548
--- /dev/null
+++ b/apps/desktop/src/components/objects/__tests__/ObjectBrowser.oceanbaseCommentSearch.component.spec.ts
@@ -0,0 +1,131 @@
+// @vitest-environment happy-dom
+
+import { createApp, defineComponent, h, nextTick, ref, type App } from "vue";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import ObjectBrowser from "@/components/objects/ObjectBrowser.vue";
+import { invalidateObjectBrowserRowsCache } from "@/lib/table/objectBrowserRowsCache";
+import type { ConnectionConfig, ObjectBrowserViewMode, ObjectInfo } from "@/types/database";
+
+const mocks = vi.hoisted(() => ({
+ listObjects: vi.fn(),
+ viewMode: "list" as ObjectBrowserViewMode,
+}));
+
+vi.mock("@/lib/backend/api", () => ({
+ listObjects: (...args: unknown[]) => mocks.listObjects(...args),
+ listSchemas: vi.fn().mockResolvedValue(["APP"]),
+ listObjectStatistics: vi.fn().mockResolvedValue([]),
+}));
+vi.mock("@/stores/connectionStore", () => ({
+ useConnectionStore: () => ({
+ getConfig: () => connection,
+ ensureConnected: vi.fn().mockResolvedValue(undefined),
+ orderByPinnedTreeNodes: (rows: unknown[]) => rows,
+ }),
+}));
+vi.mock("@/stores/queryStore", () => ({ useQueryStore: () => ({}) }));
+vi.mock("@/stores/settingsStore", () => ({
+ useSettingsStore: () => ({
+ editorSettings: {
+ shortcuts: { refreshData: "F5" },
+ objectBrowserViewMode: mocks.viewMode,
+ objectBrowserShowCheckbox: false,
+ },
+ }),
+}));
+vi.mock("vue-i18n", () => ({ useI18n: () => ({ t: (key: string) => key, locale: ref("en-US") }) }));
+vi.mock("@/i18n", () => ({ default: { install: () => undefined } }));
+vi.mock("@/composables/useSqlHighlighter", () => ({ useSqlHighlighter: () => ({ highlight: (sql: string) => sql }) }));
+vi.mock("@/composables/useToast", () => ({ useToast: () => ({ toast: vi.fn() }) }));
+vi.mock("vue-virtual-scroller", () => ({
+ RecycleScroller: defineComponent({
+ props: { items: { type: Array, default: () => [] } },
+ setup(props, { slots }) {
+ return () =>
+ h(
+ "div",
+ props.items.map((item) => slots.default?.({ item })),
+ );
+ },
+ }),
+}));
+vi.mock("@/components/ui/searchable-select", () => ({ SearchableSelect: { render: () => null } }));
+vi.mock("@/components/ui/ToolbarOverflowMenu.vue", () => ({ default: { render: () => null } }));
+vi.mock("@/components/editor/QueryEditor.vue", () => ({ default: { render: () => null } }));
+vi.mock("@/components/editor/DangerConfirmDialog.vue", () => ({ default: { render: () => null } }));
+vi.mock("@/components/objects/ProcedureExecutionDialog.vue", () => ({ default: { render: () => null } }));
+vi.mock("@/components/objects/CustomTypeInfoPanel.vue", () => ({ default: { render: () => null } }));
+vi.mock("@/components/export/XlsxHeaderDialog.vue", () => ({ default: { render: () => null } }));
+
+const connection = {
+ id: "ob-11417-comments",
+ name: "OceanBase Oracle",
+ db_type: "oceanbase-oracle",
+ database: "APP",
+ driver_profile: null,
+ url_params: null,
+ transport_layers: [],
+} as unknown as ConnectionConfig;
+
+const objects: ObjectInfo[] = [
+ { name: "O11417_TABLE", object_type: "TABLE", schema: "APP", comment: "业务 Needle 100%_" },
+ { name: "O11417_VIEW", object_type: "VIEW", schema: "APP", comment: "视图 NEEDLE 100XX" },
+ { name: "O11417_NEEDLE", object_type: "TABLE", schema: "APP", comment: null },
+ { name: "O11417_PROCEDURE", object_type: "PROCEDURE", schema: "APP", comment: null },
+];
+const mountedApps: Array<{ app: App; host: HTMLElement }> = [];
+const gridStyle = document.createElement("style");
+gridStyle.textContent = ".object-browser-grid-wrapper { padding: 8px; }";
+
+beforeEach(() => {
+ vi.clearAllMocks();
+ invalidateObjectBrowserRowsCache({});
+ mocks.listObjects.mockResolvedValue(objects);
+ document.head.append(gridStyle);
+});
+
+afterEach(() => {
+ for (const { app, host } of mountedApps.splice(0)) {
+ app.unmount();
+ host.remove();
+ }
+ invalidateObjectBrowserRowsCache({});
+ gridStyle.remove();
+});
+
+async function searchObjects(host: HTMLElement, query: string) {
+ const input = host.querySelector<HTMLInputElement>("[data-object-search-input]");
+ expect(input).not.toBeNull();
+ input!.value = query;
+ input!.dispatchEvent(new Event("input", { bubbles: true }));
+ await nextTick();
+}
+
+describe("OceanBase Oracle object comments (#11417)", () => {
+ it.each(["list", "grid"] as const)("displays and searches table/view comments in %s view", async (viewMode) => {
+ mocks.viewMode = viewMode;
+ const host = document.createElement("div");
+ document.body.append(host);
+ const app = createApp({ setup: () => () => h(ObjectBrowser, { connection, database: "APP", schema: "APP", selectedObjectFilter: "all" }) });
+ mountedApps.push({ app, host });
+ app.mount(host);
+
+ await vi.waitFor(() => expect(host.querySelector('[title="O11417_TABLE"]')).not.toBeNull());
+ expect(host.querySelector('[title="业务 Needle 100%_"]')).not.toBeNull();
+ expect(host.querySelector('[title="视图 NEEDLE 100XX"]')).not.toBeNull();
+
+ await searchObjects(host, "nEeDlE");
+ for (const name of ["O11417_TABLE", "O11417_VIEW", "O11417_NEEDLE"]) {
+ expect(host.querySelector(`[title="${name}"]`)).not.toBeNull();
+ }
+ expect(host.querySelector('[title="O11417_PROCEDURE"]')).toBeNull();
+
+ await searchObjects(host, "100%_");
+ expect(host.querySelector('[title="O11417_TABLE"]')).not.toBeNull();
+ expect(host.querySelector('[title="O11417_VIEW"]')).toBeNull();
+ expect(host.querySelector('[title="O11417_NEEDLE"]')).toBeNull();
+
+ await searchObjects(host, "");
+ expect(host.querySelector('[title="O11417_PROCEDURE"]')).not.toBeNull();
+ });
+});