feat(grid): support composite unique reference keys

This commit is contained in:
zipg authored and GitHub committed 2026-08-27 16:00:00 +08:00
1 parent cf03de122a
commit eb0994e980
19 files changed
+219 -56

No files matched your search

@@ -10,6 +10,7 @@ import {
manualReferenceColumnValidation,
manualReferenceKeyColumnIsUnique,
manualReferenceKeyColumns,
manualReferenceKeySupportsColumn,
reconcileManualReferenceColumn,
singleColumnForeignKey,
splitForeignKeyDisplayValues,
@@ -69,12 +70,48 @@ describe("dataGridForeignKeyDisplay", () => {
{ name: "Code", is_primary_key: false },
].map((column) => ({ data_type: "varchar", is_nullable: false, column_default: null, extra: null, ...column })) as ColumnInfo[];
expect(manualReferenceKeyColumns(columns, ["code"]).map((column) => column.name)).toEqual(["code"]);
expect(manualReferenceKeyColumnIsUnique(columns, ["code"], "code")).toBe(true);
expect(manualReferenceKeyColumnIsUnique(columns, ["code"], "Code")).toBe(false);
const referenceKeys = [{ columns: ["code"] }];
expect(manualReferenceKeyColumns(columns, referenceKeys).map((column) => column.name)).toEqual(["code"]);
expect(manualReferenceKeyColumnIsUnique(columns, referenceKeys, "code")).toBe(true);
expect(manualReferenceKeyColumnIsUnique(columns, referenceKeys, "Code")).toBe(false);
expect(manualReferenceKeyColumnIsUnique(columns, [], "tenant_id")).toBe(false);
});
it("supports one column of a two-column unique key only when the other column is fixed", () => {
const columns = ["dict_key", "dict_value", "label"].map((name) => ({ name, data_type: "varchar", is_nullable: false, column_default: null, is_primary_key: false, extra: null })) as ColumnInfo[];
const referenceKeys = [{ columns: ["dict_key", "dict_value"] }];
const statusFilter = { column: "dict_key", mode: "equals" as const, value: "status" };
expect(manualReferenceKeyColumns(columns, referenceKeys, statusFilter).map((column) => column.name)).toEqual(["dict_value"]);
expect(manualReferenceKeyColumnIsUnique(columns, referenceKeys, "dict_value", statusFilter)).toBe(true);
expect(manualReferenceKeyColumnIsUnique(columns, referenceKeys, "dict_key", statusFilter)).toBe(false);
});
it("requires an exact non-empty equals filter for composite reference keys", () => {
const referenceKeys = [{ columns: ["DictKey", "dict_value"] }];
expect(manualReferenceKeySupportsColumn(referenceKeys, "dict_value", { column: "DictKey", mode: "equals", value: "status" })).toBe(true);
expect(manualReferenceKeySupportsColumn(referenceKeys, "dict_value", { column: "dictkey", mode: "equals", value: "status" })).toBe(false);
expect(manualReferenceKeySupportsColumn(referenceKeys, "dict_value", { column: "DictKey", mode: "equals", value: " " })).toBe(false);
expect(manualReferenceKeySupportsColumn(referenceKeys, "dict_value", { column: "DictKey", mode: "like", value: "status" })).toBe(false);
expect(manualReferenceKeySupportsColumn(referenceKeys, "dict_value", { column: "DictKey", mode: "in", value: "status,gender" })).toBe(false);
expect(manualReferenceKeySupportsColumn(referenceKeys, "dict_value", { column: "DictKey", mode: "between", value: "a", endValue: "z" })).toBe(false);
});
it("does not infer uniqueness from a partially fixed three-column key", () => {
const threeColumnKey = [{ columns: ["tenant_id", "dict_key", "dict_value"] }];
const filter = { column: "dict_key", mode: "equals" as const, value: "status" };
expect(manualReferenceKeySupportsColumn(threeColumnKey, "dict_value", filter)).toBe(false);
});
it("accepts a column when any current key proves it unique", () => {
const referenceKeys = [{ columns: ["tenant_id", "code"] }, { columns: ["external_id"] }];
expect(manualReferenceKeySupportsColumn(referenceKeys, "code", { column: "tenant_id", mode: "equals", value: "acme" })).toBe(true);
expect(manualReferenceKeySupportsColumn(referenceKeys, "external_id")).toBe(true);
});
it("preserves saved reference columns when metadata is invalid or unavailable", () => {
const columns = [{ name: "id", data_type: "bigint", is_nullable: false, column_default: null, is_primary_key: true, extra: null }] as ColumnInfo[];
@@ -84,6 +121,7 @@ describe("dataGridForeignKeyDisplay", () => {
expect(reconcileManualReferenceColumn("", columns, "unavailable")).toBe("");
expect(manualReferenceColumnValidation(columns, [], "legacy_code", "available")).toBe("invalid");
expect(manualReferenceColumnValidation(columns, [], "legacy_code", "unavailable")).toBe("unavailable");
expect(manualReferenceColumnValidation(columns, [{ columns: ["tenant_id", "legacy_code"] }], "legacy_code", "available", { column: "tenant_id", mode: "equals", value: "" })).toBe("invalid");
});
it("deduplicates current-page keys with type-safe identities and bounded batches", () => {
+1
View File
@@ -175,6 +175,7 @@ export const getSqlServerColumnMetadata = forward("getSqlServerColumnMetadata");
export const listDataTypes = forward("listDataTypes");
export const listIndexes = forward("listIndexes");
export const listReferenceKeyColumns = forward("listReferenceKeyColumns");
export const listReferenceKeys = forward("listReferenceKeys");
export const listForeignKeys = forward("listForeignKeys");
export const listTriggers = forward("listTriggers");
export const listConstraints = forward("listConstraints");
+5
View File
@@ -21,6 +21,7 @@ import type {
ColumnInfo,
SqlServerColumnMetadata,
IndexInfo,
ReferenceKeyInfo,
ForeignKeyInfo,
TriggerInfo,
ConstraintInfo,
@@ -906,6 +907,10 @@ export async function listReferenceKeyColumns(connectionId: string, database: st
return get(`/api/schema/reference-key-columns?${qs({ connection_id: connectionId, database, schema, table, catalog })}`);
}
export async function listReferenceKeys(connectionId: string, database: string, schema: string, table: string, catalog?: string): Promise<ReferenceKeyInfo[]> {
return get(`/api/schema/reference-keys?${qs({ connection_id: connectionId, database, schema, table, catalog })}`);
}
export async function listForeignKeys(connectionId: string, database: string, schema: string, table: string, catalog?: string): Promise<ForeignKeyInfo[]> {
return get(`/api/schema/foreign-keys?${qs({ connection_id: connectionId, database, schema, table, catalog })}`);
}
+11
View File
@@ -37,6 +37,7 @@ import type {
ColumnInfo,
SqlServerColumnMetadata,
IndexInfo,
ReferenceKeyInfo,
ForeignKeyInfo,
TriggerInfo,
ConstraintInfo,
@@ -1807,6 +1808,16 @@ export async function listReferenceKeyColumns(connectionId: string, database: st
});
}
export async function listReferenceKeys(connectionId: string, database: string, schema: string, table: string, catalog?: string): Promise<ReferenceKeyInfo[]> {
return invoke("list_reference_keys", {
connectionId,
database,
schema,
table,
catalog,
});
}
export async function listForeignKeys(connectionId: string, database: string, schema: string, table: string, catalog?: string): Promise<ForeignKeyInfo[]> {
return invoke("list_foreign_keys", {
connectionId,
@@ -2,7 +2,7 @@ import { displayCellValue, type CellValue } from "@/lib/dataGrid/cellValue";
import type { ColumnFormatterConfig, ForeignKeyDisplayFilterConfig } from "@/lib/dataGrid/columnFormatter";
import { isNumericColumnType } from "@/lib/dataGrid/dataGridColumnType";
import type { ForeignKeyAssociation } from "@/lib/dataGrid/dataGridForeignKeyNavigation";
import type { ColumnInfo, ForeignKeyInfo, QueryResult } from "@/types/database";
import type { ColumnInfo, ForeignKeyInfo, QueryResult, ReferenceKeyInfo } from "@/types/database";
export type ForeignKeyDisplayConfig = Extract<ColumnFormatterConfig, { kind: "foreign-key-display" }>;
@@ -169,19 +169,29 @@ export function foreignKeyDisplayConfigIsUsable(config: ForeignKeyDisplayConfig,
export type ManualReferenceMetadataStatus = "loading" | "available" | "unavailable";
export type ManualReferenceColumnValidation = "pending" | "valid" | "invalid" | "unavailable";
export function manualReferenceKeyColumns(columns: readonly ColumnInfo[], referenceKeyColumnNames: readonly string[]): ColumnInfo[] {
const uniqueColumnNames = new Set(referenceKeyColumnNames);
return columns.filter((column) => uniqueColumnNames.has(column.name));
export function manualReferenceKeySupportsColumn(referenceKeys: readonly ReferenceKeyInfo[], columnName: string, filter?: ForeignKeyDisplayFilterConfig): boolean {
if (!columnName) return false;
return referenceKeys.some((key) => {
if (!key.columns.includes(columnName)) return false;
if (key.columns.length === 1) return true;
if (key.columns.length !== 2 || filter?.mode !== "equals" || !filter.value?.trim()) return false;
const otherColumn = key.columns.find((column) => column !== columnName);
return !!otherColumn && filter.column === otherColumn;
});
}
export function manualReferenceKeyColumnIsUnique(columns: readonly ColumnInfo[], referenceKeyColumnNames: readonly string[], columnName: string): boolean {
return !!columnName && manualReferenceKeyColumns(columns, referenceKeyColumnNames).some((column) => column.name === columnName);
export function manualReferenceKeyColumns(columns: readonly ColumnInfo[], referenceKeys: readonly ReferenceKeyInfo[], filter?: ForeignKeyDisplayFilterConfig): ColumnInfo[] {
return columns.filter((column) => manualReferenceKeySupportsColumn(referenceKeys, column.name, filter));
}
export function manualReferenceColumnValidation(columns: readonly ColumnInfo[], referenceKeyColumnNames: readonly string[], columnName: string, metadataStatus: ManualReferenceMetadataStatus): ManualReferenceColumnValidation {
export function manualReferenceKeyColumnIsUnique(columns: readonly ColumnInfo[], referenceKeys: readonly ReferenceKeyInfo[], columnName: string, filter?: ForeignKeyDisplayFilterConfig): boolean {
return !!columns.some((column) => column.name === columnName) && manualReferenceKeySupportsColumn(referenceKeys, columnName, filter);
}
export function manualReferenceColumnValidation(columns: readonly ColumnInfo[], referenceKeys: readonly ReferenceKeyInfo[], columnName: string, metadataStatus: ManualReferenceMetadataStatus, filter?: ForeignKeyDisplayFilterConfig): ManualReferenceColumnValidation {
if (metadataStatus === "loading") return "pending";
if (metadataStatus === "unavailable") return "unavailable";
return manualReferenceKeyColumnIsUnique(columns, referenceKeyColumnNames, columnName) ? "valid" : "invalid";
return manualReferenceKeyColumnIsUnique(columns, referenceKeys, columnName, filter) ? "valid" : "invalid";
}
export function reconcileManualReferenceColumn(currentColumn: string, referenceColumns: readonly ColumnInfo[], metadataStatus: ManualReferenceMetadataStatus): string {