fix(editor): 内置 SQL 补全模板按数据库方言适配

This commit is contained in:
zhangyc authored and GitHub committed 2026-07-24 23:51:35 +08:00
1 parent 355ca7d3ad
commit 3939658ebe
7 files changed
+353 -133

No files matched your search

@@ -1,5 +1,6 @@
import { describe, it, expect } from "vitest";
import { buildSnippetItemsForTest } from "@/lib/sql/sqlCompletion";
import { buildSnippetItemsForTest, buildSqlCompletionItems } from "@/lib/sql/sqlCompletion";
import { DEFAULT_SQL_SNIPPETS, MANTICORESEARCH_SQL_SNIPPETS } from "@/lib/sql/sqlSnippetTemplates";
import type { SqlSnippet } from "@/types/database";
const TEST_SNIPPETS: SqlSnippet[] = [
@@ -14,9 +15,33 @@ const BUILTIN_CTE: SqlSnippet = { id: "builtin-cte", label: "common table expres
const BUILTIN_INSERT: SqlSnippet = { id: "builtin-ins", label: "insert into", prefix: "ins", body: "INSERT INTO table (columns)\nVALUES (values);" };
const BUILTIN_JOIN: SqlSnippet = { id: "builtin-join", label: "join", prefix: "join", body: "JOIN table ON left_column = right_column" };
const BUILTIN_CASE: SqlSnippet = { id: "builtin-case", label: "case when", prefix: "case", body: "CASE\n WHEN condition THEN value\n ELSE default\nEND" };
const BUILTIN_ALTER_TABLE: SqlSnippet = { id: "builtin-at", label: "alter table add column", prefix: "at", body: "ALTER TABLE table\nADD COLUMN column type;" };
const BUILTIN_CREATE_INDEX: SqlSnippet = { id: "builtin-ci", label: "create index", prefix: "ci", body: "CREATE INDEX idx_name\nON table (column);" };
describe("buildSnippetItems", () => {
it("keeps the global and Manticore-only built-in snippet inventories explicit", () => {
expect(DEFAULT_SQL_SNIPPETS.map(({ id, prefix }) => [id, prefix])).toEqual([
["builtin-sel", "sel"],
["builtin-ins", "ins"],
["builtin-upd", "upd"],
["builtin-cte", "cte"],
["builtin-join", "join"],
["builtin-case", "case"],
["builtin-ct", "ct"],
["builtin-ex", "ex"],
["builtin-nex", "nex"],
["builtin-at", "at"],
["builtin-ci", "ci"],
]);
expect(MANTICORESEARCH_SQL_SNIPPETS.map(({ id, prefix }) => [id, prefix])).toEqual([
["builtin-manticore-match", "match"],
["builtin-manticore-facet", "facet"],
["builtin-manticore-show-meta", "m"],
["builtin-manticore-show-tables", "tab"],
["builtin-manticore-call-pq", "p"],
]);
});
it("returns matching snippet by prefix", () => {
const items = buildSnippetItemsForTest("sel", TEST_SNIPPETS);
expect(items).toHaveLength(1);
@@ -32,6 +57,49 @@ describe("buildSnippetItems", () => {
expect(items[0].apply).toBe("SELECT *\nFROM ${table}\nLIMIT 100;");
});
it.each([
["mysql", "SELECT *\nFROM table\nLIMIT 100;", "SELECT *\nFROM ${table}\nLIMIT 100;"],
["oracle", "SELECT *\nFROM table\nWHERE ROWNUM <= 100;", "SELECT *\nFROM ${table}\nWHERE ROWNUM <= 100;"],
["oceanbase-oracle", "SELECT *\nFROM table\nWHERE ROWNUM <= 100;", "SELECT *\nFROM ${table}\nWHERE ROWNUM <= 100;"],
["oscar", "SELECT *\nFROM table\nWHERE ROWNUM <= 100;", "SELECT *\nFROM ${table}\nWHERE ROWNUM <= 100;"],
["xugu", "SELECT *\nFROM table\nLIMIT 100;", "SELECT *\nFROM ${table}\nLIMIT 100;"],
["yashandb", "SELECT *\nFROM table\nLIMIT 100;", "SELECT *\nFROM ${table}\nLIMIT 100;"],
["dameng", "SELECT *\nFROM table\nFETCH FIRST 100 ROWS ONLY;", "SELECT *\nFROM ${table}\nFETCH FIRST 100 ROWS ONLY;"],
["db2", "SELECT *\nFROM table\nFETCH FIRST 100 ROWS ONLY;", "SELECT *\nFROM ${table}\nFETCH FIRST 100 ROWS ONLY;"],
["sqlserver", "SELECT TOP 100 *\nFROM table;", "SELECT TOP 100 *\nFROM ${table};"],
["access", "SELECT TOP 100 *\nFROM table;", "SELECT TOP 100 *\nFROM ${table};"],
["iris", "SELECT TOP 100 *\nFROM table;", "SELECT TOP 100 *\nFROM ${table};"],
["teradata", "SELECT TOP 100 *\nFROM table;", "SELECT TOP 100 *\nFROM ${table};"],
["informix", "SELECT FIRST 100 *\nFROM table;", "SELECT FIRST 100 *\nFROM ${table};"],
["firebird", "SELECT *\nFROM table\nROWS 100;", "SELECT *\nFROM ${table}\nROWS 100;"],
["jdbc", "SELECT *\nFROM table;", "SELECT *\nFROM ${table};"],
] as const)("uses the %s row limit syntax in the built-in select snippet", (databaseType, detail, apply) => {
const items = buildSnippetItemsForTest("sel", [BUILTIN_SELECT], undefined, databaseType);
expect(items[0].detail).toBe(detail);
expect(items[0].apply).toBe(apply);
});
it("passes the active database type through the SQL completion provider", () => {
const items = buildSqlCompletionItems("sel", 3, {
tables: [],
columnsByTable: new Map(),
databaseType: "oracle",
});
const snippet = items.find((item) => item.type === "snippet" && item.label === "select *");
expect(snippet?.detail).toBe("SELECT *\nFROM table\nWHERE ROWNUM <= 100;");
expect(snippet?.apply).toBe("SELECT *\nFROM ${table}\nWHERE ROWNUM <= 100;");
});
it("preserves a customized built-in select body instead of replacing it with a dialect default", () => {
const customized = { ...BUILTIN_SELECT, body: "SELECT *\nFROM table\nLIMIT 7;" };
const items = buildSnippetItemsForTest("sel", [customized], undefined, "oracle");
expect(items[0].detail).toBe("SELECT *\nFROM table\nLIMIT 7;");
expect(items[0].apply).toBe("SELECT *\nFROM ${table}\nLIMIT 7;");
});
it("replaces placeholder words but preserves uppercase SQL keywords", () => {
const items = buildSnippetItemsForTest("ct", [BUILTIN_CREATE_TABLE]);
@@ -44,6 +112,34 @@ describe("buildSnippetItems", () => {
expect(items[0].apply).toBe("UPDATE ${table}\nSET ${column} = ${value}\nWHERE ${condition};");
});
it("uses ALTER TABLE UPDATE for ClickHouse", () => {
const items = buildSnippetItemsForTest("upd", [BUILTIN_UPDATE], undefined, "clickhouse");
expect(items[0].detail).toBe("ALTER TABLE table\nUPDATE column = value\nWHERE condition;");
expect(items[0].apply).toBe("ALTER TABLE ${table}\nUPDATE ${column} = ${value}\nWHERE ${condition};");
});
it.each([
["mysql", "ALTER TABLE table\nADD COLUMN column type;", "ALTER TABLE ${table}\nADD COLUMN ${column} ${type};"],
["oracle", "ALTER TABLE table\nADD (column type);", "ALTER TABLE ${table}\nADD (${column} ${type});"],
["oceanbase-oracle", "ALTER TABLE table\nADD (column type);", "ALTER TABLE ${table}\nADD (${column} ${type});"],
["oscar", "ALTER TABLE table\nADD COLUMN column type;", "ALTER TABLE ${table}\nADD COLUMN ${column} ${type};"],
["yashandb", "ALTER TABLE table\nADD (column type);", "ALTER TABLE ${table}\nADD (${column} ${type});"],
["xugu", "ALTER TABLE table\nADD (column type);", "ALTER TABLE ${table}\nADD (${column} ${type});"],
["dameng", "ALTER TABLE table\nADD (column type);", "ALTER TABLE ${table}\nADD (${column} ${type});"],
["iris", "ALTER TABLE table\nADD (column type);", "ALTER TABLE ${table}\nADD (${column} ${type});"],
["informix", "ALTER TABLE table\nADD (column type);", "ALTER TABLE ${table}\nADD (${column} ${type});"],
["sqlserver", "ALTER TABLE table\nADD column type;", "ALTER TABLE ${table}\nADD ${column} ${type};"],
["kingbase", "ALTER TABLE table\nADD column type;", "ALTER TABLE ${table}\nADD ${column} ${type};"],
["cassandra", "ALTER TABLE table\nADD column type;", "ALTER TABLE ${table}\nADD ${column} ${type};"],
["teradata", "ALTER TABLE table\nADD column type;", "ALTER TABLE ${table}\nADD ${column} ${type};"],
] as const)("uses the %s ADD COLUMN syntax in the built-in alter-table snippet", (databaseType, detail, apply) => {
const items = buildSnippetItemsForTest("at", [BUILTIN_ALTER_TABLE], undefined, databaseType);
expect(items[0].detail).toBe(detail);
expect(items[0].apply).toBe(apply);
});
it("keeps keyword casing separate from editable placeholders", () => {
const items = buildSnippetItemsForTest("sel", [BUILTIN_SELECT], "lower");