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。

refactor(grid): extract column formatter workflow

t8y2ed20ed275d21
diff --git a/apps/desktop/src/components/grid/DataGrid.vue b/apps/desktop/src/components/grid/DataGrid.vue
index 19d70c39db..b4cea4e0f9 100644
--- a/apps/desktop/src/components/grid/DataGrid.vue
+++ b/apps/desktop/src/components/grid/DataGrid.vue
@@ -82,7 +82,7 @@ import TemporalCellEditor from "@/components/grid/TemporalCellEditor.vue";
import EnumCellEditor from "@/components/grid/EnumCellEditor.vue";
import DataGridReadonlyTextSelection from "@/components/grid/DataGridReadonlyTextSelection.vue";
import GridSnapshotDialog from "@/components/grid/GridSnapshotDialog.vue";
-import type { QueryResult, ColumnInfo, ConstraintInfo, DatabaseType, ForeignKeyInfo, IndexInfo, ReferenceKeyInfo, TriggerInfo, TableInfoTab, QueryResultSourceColumnRef, QueryPageJumpProgress } from "@/types/database";
+import type { QueryResult, ColumnInfo, ConstraintInfo, DatabaseType, ForeignKeyInfo, IndexInfo, TriggerInfo, TableInfoTab, QueryResultSourceColumnRef, QueryPageJumpProgress } from "@/types/database";
import { isQueryExecutionErrorResult } from "@/lib/query/queryResultError";
import { tableObjectSourceKind } from "@/lib/table/tableObjectSourceKind";
import { tableColumnDefaultDisplayValue } from "@/lib/table/tableColumnDefaultPresentation";
@@ -179,23 +179,7 @@ import {
type DataGridCellDetail,
} from "@/lib/dataGrid/dataGridDetail";
import { adjacentDataGridDetailIndex, type DataGridDetailNavigationDelta } from "@/lib/dataGrid/dataGridDetailNavigation";
-import {
- applyColumnFormatter,
- columnFormatterKeys,
- defaultIoTDBTimestampFormatter,
- DataGridDateTimePatterns,
- displayTimeZoneOption,
- formatIoTDBTimestampEditorValue,
- getSupportedTimeZoneOptions,
- iotdbTimestampFractionDigits,
- iotdbTimestampPrecision,
- normalizeColumnFormatter,
- parseIoTDBTimestampEditorValue,
- resolveColumnFormatter,
- type ColumnFormatterConfig,
- type DateTimeFormatterUnit,
- type ForeignKeyDisplayFilterConfig,
-} from "@/lib/dataGrid/columnFormatter";
+import { applyColumnFormatter, DataGridDateTimePatterns, displayTimeZoneOption, formatIoTDBTimestampEditorValue, iotdbTimestampFractionDigits, iotdbTimestampPrecision, parseIoTDBTimestampEditorValue, type ColumnFormatterConfig } from "@/lib/dataGrid/columnFormatter";
import { temporalCellEditorConfig, type TemporalCellEditorConfig } from "@/lib/dataGrid/dataGridTemporalEditor";
import { BOOLEAN_CELL_EDITOR_VALUES, booleanCellEditorValue, isBooleanCellValue, isBooleanColumnType, isPointInBooleanCheckbox, nextBooleanCellValue, normalizeBooleanCellValue, parseBooleanCellEditorValue } from "@/lib/dataGrid/dataGridBooleanColumn";
import { resolveDataGridColumnNullability, resolveDataGridColumnsByResultIndex } from "@/lib/dataGrid/dataGridColumnMetadata";
@@ -307,14 +291,10 @@ import {
foreignKeyDisplayLookupRequestKey,
foreignKeyDisplayMapFromResult,
formatForeignKeyDisplayValue,
- manualReferenceColumnValidation,
manualReferenceKeyColumnIsUnique,
- manualReferenceKeyColumns,
- reconcileManualReferenceColumn,
singleColumnForeignKey,
splitForeignKeyDisplayValues,
type ForeignKeyDisplayConfig,
- type ManualReferenceMetadataStatus,
} from "@/lib/dataGrid/dataGridForeignKeyDisplay";
import { useToast } from "@/composables/useToast";
@@ -389,12 +369,7 @@ import { appendDebugLog, isDebugLoggingEnabled } from "@/lib/backend/debugLog";
import { formatShortcut } from "@/lib/editor/shortcutRegistry";
import { queryTimeoutSecsForConnection } from "@/lib/sql/queryTimeout";
import { SearchableSelect } from "@/components/ui/searchable-select";
-import timezone from "dayjs/plugin/timezone";
-import utc from "dayjs/plugin/utc";
-import dayjs from "dayjs";
-
-dayjs.extend(utc);
-dayjs.extend(timezone);
+import { useDataGridColumnFormatter } from "@/composables/useDataGridColumnFormatter";
const SqlPreviewPanel = defineAsyncComponent(() => import("@/components/editor/SqlPreviewPanel.vue"));
const ImagePreviewDialog = defineAsyncComponent(() => import("@/components/grid/ImagePreviewDialog.vue"));
@@ -1223,65 +1198,11 @@ const draftStructuredWhereInput = ref("");
const filterEditorView = computed(() => settingsStore.editorSettings.dataGridFilterEditorView);
const structuredFilterCount = computed(() => structuredFilterRules.value.filter((rule) => !rule.disabled && !!rule.columnName && filterModeHasCompleteValue(rule.mode, rule.rawValue, rule.rawEndValue)).length);
const hasStructuredFilters = computed(() => !!combineWhereInputs(undefined, appliedStructuredWhereInput.value));
-const formatterOpenColumn = ref<number | null>(null);
-type FormatterDraftKind = Exclude<ColumnFormatterConfig["kind"], "custom-ref" | "iotdb-timestamp">;
-const CUSTOM_FORMATTER_NEW = "__new";
-const formatterKind = ref<FormatterDraftKind>("datetime");
-const formatterDateUnit = ref<DateTimeFormatterUnit>("auto");
-const formatterDatetimePattern = ref<string>("YYYY-MM-DD HH:mm:ss");
-const formatterDateTimezone = ref<string>(dayjs.tz.guess() || "UTC");
-const timezoneOptions = getSupportedTimeZoneOptions(Intl as typeof Intl & { supportedValuesOf?: (key: "timeZone") => string[] }, formatterDateTimezone.value);
-const formatterJsonPath = ref("$.user.name");
-const formatterMaskPrefix = ref(4);
-const formatterMaskSuffix = ref(4);
-const formatterCustomId = ref(CUSTOM_FORMATTER_NEW);
-const formatterCustomCapturedDeleteVersion = ref<number>();
-const formatterCustomName = ref("");
-const formatterCustomTemplate = ref("${value}");
-const formatterCustomDeleteOpen = ref(false);
-const formatterCustomDeleteLoading = ref(false);
-const formatterCustomDeleteId = ref("");
-const formatterCustomDeleteName = ref("");
-const formatterForeignKeyRefSchema = ref("");
-const formatterForeignKeyRefTable = ref("");
-const formatterForeignKeyRefColumn = ref("");
-const formatterForeignKeyDisplayColumn = ref("");
-const formatterForeignKeyManual = ref(false);
-const formatterForeignKeySchemas = ref<string[]>([]);
-const formatterForeignKeyTables = ref<string[]>([]);
-const formatterForeignKeyColumns = ref<ColumnInfo[]>([]);
-const formatterForeignKeyReferenceKeys = ref<ReferenceKeyInfo[]>([]);
-const formatterForeignKeyReferenceMetadataStatus = ref<ManualReferenceMetadataStatus>("loading");
-const formatterForeignKeySchemasLoading = ref(false);
-const formatterForeignKeyTablesLoading = ref(false);
-const formatterForeignKeyColumnsLoading = ref(false);
-const formatterForeignKeyTargetError = ref("");
-const formatterForeignKeyColumnsError = ref("");
-const formatterForeignKeyReferenceMetadataError = ref("");
-const formatterForeignKeyFilterEnabled = ref(false);
-const formatterForeignKeyFilterColumn = ref("");
-const formatterForeignKeyFilterMode = ref<DataGridContextFilterMode>("equals");
-const formatterForeignKeyFilterValue = ref("");
-const formatterForeignKeyFilterEndValue = ref("");
-let formatterForeignKeyColumnsRequest = 0;
-let formatterForeignKeyTargetRequest = 0;
interface ForeignKeyDisplayLabelState {
keyDataType?: string;
labels: Map<string, string>;
}
-const formatterForeignKeyReferenceFilter = computed<ForeignKeyDisplayFilterConfig | undefined>(() =>
- formatterForeignKeyFilterEnabled.value
- ? {
- column: formatterForeignKeyFilterColumn.value,
- mode: formatterForeignKeyFilterMode.value,
- value: formatterForeignKeyFilterValue.value,
- endValue: formatterForeignKeyFilterEndValue.value,
- }
- : undefined,
-);
-const formatterForeignKeyReferenceColumns = computed(() => (formatterForeignKeyManual.value ? manualReferenceKeyColumns(formatterForeignKeyColumns.value, formatterForeignKeyReferenceKeys.value, formatterForeignKeyReferenceFilter.value) : formatterForeignKeyColumns.value));
-const formatterForeignKeyReferenceValidation = computed(() => manualReferenceColumnValidation(formatterForeignKeyColumns.value, formatterForeignKeyReferenceKeys.value, formatterForeignKeyRefColumn.value, formatterForeignKeyReferenceMetadataStatus.value, formatterForeignKeyReferenceFilter.value));
const foreignKeyDisplayLabels = shallowRef(new Map<number, ForeignKeyDisplayLabelState>());
const foreignKeyDisplayRequests = createForeignKeyDisplayRequestCoordinator();
@@ -1290,10 +1211,6 @@ function formatForeignKeyCellDisplay(value: CellValue, columnIndex: number): str
return formatForeignKeyDisplayValue(value, state?.labels, state?.keyDataType);
}
-const savedCustomFormatters = computed(() => {
- return Object.values(settingsStore.editorSettings.customColumnFormatters).sort((a, b) => a.name.localeCompare(b.name));
-});
-
function localFilterKey(value: CellValue): string {
return dataGridLocalFilterKey(value);
}
@@ -1640,303 +1557,6 @@ watch(
},
);
-function formatterKeysForColumn(columnIndex: number): string[] {
- const resultColumn = props.result.columns[columnIndex];
- if (!props.connectionId || !resultColumn) return [];
- return columnFormatterKeys({
- connectionId: props.connectionId,
- database: props.database,
- schema: props.schema,
- databaseType: resolvedDatabaseType.value,
- resultColumn,
- sourceColumn: props.sourceColumns?.[columnIndex],
- displaySource: props.queryDisplaySourceColumns?.[columnIndex],
- tableMeta: props.tableMeta,
- });
-}
-
-function formatterKeyForColumn(columnIndex: number): string | null {
- return formatterKeysForColumn(columnIndex)[0] ?? null;
-}
-
-function savedColumnFormatterEntry(columnIndex: number): { key: string; formatter: ColumnFormatterConfig } | undefined {
- for (const key of formatterKeysForColumn(columnIndex)) {
- const formatter = settingsStore.editorSettings.columnFormatters[key];
- if (formatter) return { key, formatter };
- }
- return undefined;
-}
-
-function columnFormatter(columnIndex: number): ColumnFormatterConfig | undefined {
- const columnType = props.result.column_types?.[columnIndex] ?? tableColumnForGridColumn(columnIndex)?.data_type;
- const savedFormatter = savedColumnFormatterEntry(columnIndex)?.formatter;
- const configured = resolveColumnFormatter(savedFormatter, settingsStore.editorSettings.customColumnFormatters, {
- pattern: settingsStore.editorSettings.globalDateTimeDisplayFormat,
- columnType,
- });
- if (savedFormatter && configured) return configured;
- return defaultIoTDBTimestampFormatter(resolvedDatabaseType.value, columnType, resolvedConnectionConfig.value?.url_params) ?? configured;
-}
-
-function savedColumnFormatter(columnIndex: number): ColumnFormatterConfig | undefined {
- return savedColumnFormatterEntry(columnIndex)?.formatter;
-}
-
-function columnHasFormatter(columnIndex: number): boolean {
- return !!columnFormatter(columnIndex);
-}
-
-function currentFormatterDraft(): ColumnFormatterConfig {
- if (formatterKind.value === "json-path") {
- return { kind: "json-path", path: formatterJsonPath.value.trim() || "$" };
- }
- if (formatterKind.value === "mask") {
- return {
- kind: "mask",
- prefix: Math.max(0, Math.floor(Number(formatterMaskPrefix.value) || 0)),
- suffix: Math.max(0, Math.floor(Number(formatterMaskSuffix.value) || 0)),
- };
- }
- if (formatterKind.value === "custom-template") {
- return {
- kind: "custom-template",
- template: formatterCustomTemplate.value.trim() || "${value}",
- };
- }
- if (formatterKind.value === "foreign-key-display") {
- return {
- kind: "foreign-key-display",
- referenceMode: formatterForeignKeyManual.value ? "manual" : "foreign-key",
- refSchema: formatterForeignKeyRefSchema.value || undefined,
- refTable: formatterForeignKeyRefTable.value,
- refColumn: formatterForeignKeyRefColumn.value,
- displayColumn: formatterForeignKeyDisplayColumn.value,
- filter: formatterForeignKeyFilterEnabled.value
- ? {
- column: formatterForeignKeyFilterColumn.value,
- mode: formatterForeignKeyFilterMode.value,
- value: formatterForeignKeyFilterValue.value,
- endValue: formatterForeignKeyFilterEndValue.value,
- }
- : undefined,
- };
- }
- return {
- kind: "datetime",
- unit: formatterDateUnit.value,
- pattern: formatterDatetimePattern.value,
- timezone: formatterDateTimezone.value,
- };
-}
-
-function loadFormatterDraft(formatter: ColumnFormatterConfig | undefined) {
- formatterForeignKeyManual.value = false;
- formatterForeignKeyRefSchema.value = "";
- formatterForeignKeyRefTable.value = "";
- formatterForeignKeyRefColumn.value = "";
- formatterForeignKeyDisplayColumn.value = "";
- formatterForeignKeySchemas.value = [];
- formatterForeignKeyTables.value = [];
- formatterForeignKeyColumns.value = [];
- formatterForeignKeyReferenceKeys.value = [];
- formatterForeignKeyReferenceMetadataStatus.value = "loading";
- formatterForeignKeyTargetError.value = "";
- formatterForeignKeyColumnsError.value = "";
- formatterForeignKeyReferenceMetadataError.value = "";
- formatterForeignKeyFilterEnabled.value = false;
- formatterForeignKeyFilterColumn.value = "";
- formatterForeignKeyFilterMode.value = "equals";
- formatterForeignKeyFilterValue.value = "";
- formatterForeignKeyFilterEndValue.value = "";
- const draft = formatter ?? {
- kind: "datetime",
- unit: "auto" as const,
- pattern: "YYYY-MM-DD HH:mm:ss" as const,
- timezone: dayjs.tz.guess(),
- };
- formatterKind.value = draft.kind === "custom-ref" ? "custom-template" : draft.kind === "iotdb-timestamp" ? "datetime" : draft.kind;
- if (draft.kind === "datetime") {
- formatterDateUnit.value = draft.unit;
- formatterDatetimePattern.value = draft.pattern;
- formatterDateTimezone.value = draft.timezone || dayjs.tz.guess() || "UTC";
- } else if (draft.kind === "iotdb-timestamp") {
- formatterDateUnit.value = "milliseconds";
- formatterDatetimePattern.value = "YYYY-MM-DDTHH:mm:ss.SSSZ";
- formatterDateTimezone.value = draft.timezone;
- } else if (draft.kind === "json-path") {
- formatterJsonPath.value = draft.path;
- } else if (draft.kind === "mask") {
- formatterMaskPrefix.value = draft.prefix;
- formatterMaskSuffix.value = draft.suffix;
- } else if (draft.kind === "custom-ref") {
- const saved = settingsStore.editorSettings.customColumnFormatters[draft.formatterId];
- formatterCustomId.value = saved ? saved.id : CUSTOM_FORMATTER_NEW;
- formatterCustomCapturedDeleteVersion.value = saved ? settingsStore.customColumnFormatterDeleteVersion(saved.id) : undefined;
- formatterCustomName.value = saved?.name ?? "";
- formatterCustomTemplate.value = saved?.template ?? "${value}";
- } else if (draft.kind === "custom-template") {
- formatterCustomId.value = CUSTOM_FORMATTER_NEW;
- formatterCustomCapturedDeleteVersion.value = undefined;
- formatterCustomName.value = "";
- formatterCustomTemplate.value = draft.template;
- } else if (draft.kind === "foreign-key-display") {
- formatterForeignKeyManual.value = draft.referenceMode === "manual";
- formatterForeignKeyRefSchema.value = draft.refSchema ?? "";
- formatterForeignKeyRefTable.value = draft.refTable;
- formatterForeignKeyRefColumn.value = draft.refColumn;
- formatterForeignKeyDisplayColumn.value = draft.displayColumn;
- formatterForeignKeyFilterEnabled.value = !!draft.filter;
- formatterForeignKeyFilterColumn.value = draft.filter?.column ?? "";
- formatterForeignKeyFilterMode.value = draft.filter?.mode ?? "equals";
- formatterForeignKeyFilterValue.value = draft.filter?.value ?? "";
- formatterForeignKeyFilterEndValue.value = draft.filter?.endValue ?? "";
- }
-}
-
-function formatterForeignKeyForColumn(columnIndex: number): ForeignKeyInfo | undefined {
- return singleColumnForeignKey(cellForeignKeyAssociation(columnIndex));
-}
-
-async function loadFormatterForeignKeyColumns(columnIndex: number) {
- const request = ++formatterForeignKeyColumnsRequest;
- formatterForeignKeyColumns.value = [];
- formatterForeignKeyReferenceKeys.value = [];
- formatterForeignKeyReferenceMetadataStatus.value = "loading";
- formatterForeignKeyColumnsError.value = "";
- formatterForeignKeyReferenceMetadataError.value = "";
- if (!props.connectionId || !formatterForeignKeyRefTable.value) return;
- formatterForeignKeyColumnsLoading.value = true;
- try {
- const schema = formatterForeignKeyRefSchema.value || props.tableMeta?.schema || props.schema || props.database || "";
- const manual = formatterForeignKeyManual.value;
- const [columnsResult, referenceKeysResult] = await Promise.allSettled([
- api.getColumns(props.connectionId, props.database || "", schema, formatterForeignKeyRefTable.value, props.tableMeta?.catalog),
- manual ? api.listReferenceKeys(props.connectionId, props.database || "", schema, formatterForeignKeyRefTable.value, props.tableMeta?.catalog) : Promise.resolve([] as ReferenceKeyInfo[]),
- ]);
- if (request !== formatterForeignKeyColumnsRequest || formatterOpenColumn.value !== columnIndex) return;
- if (columnsResult.status === "rejected") throw columnsResult.reason;
- const columns = columnsResult.value;
- formatterForeignKeyColumns.value = columns;
- if (manual && referenceKeysResult.status === "rejected") {
- formatterForeignKeyReferenceMetadataStatus.value = "unavailable";
- formatterForeignKeyReferenceMetadataError.value = String(referenceKeysResult.reason?.message || referenceKeysResult.reason);
- } else {
- formatterForeignKeyReferenceKeys.value = referenceKeysResult.status === "fulfilled" ? referenceKeysResult.value : [];
- formatterForeignKeyReferenceMetadataStatus.value = "available";
- }
- const referenceColumns = manualReferenceKeyColumns(columns, formatterForeignKeyReferenceKeys.value, formatterForeignKeyReferenceFilter.value);
- const foreignKey = formatterForeignKeyForColumn(columnIndex);
- if (manual) {
- formatterForeignKeyRefColumn.value = reconcileManualReferenceColumn(formatterForeignKeyRefColumn.value, referenceColumns, formatterForeignKeyReferenceMetadataStatus.value);
- } else if (!formatterForeignKeyRefColumn.value || !columns.some((column) => column.name === formatterForeignKeyRefColumn.value)) {
- formatterForeignKeyRefColumn.value = foreignKey?.ref_column ?? "";
- }
- if (!formatterForeignKeyDisplayColumn.value || !columns.some((column) => column.name === formatterForeignKeyDisplayColumn.value)) {
- formatterForeignKeyDisplayColumn.value = columns.find((column) => column.name !== formatterForeignKeyRefColumn.value)?.name ?? columns[0]?.name ?? "";
- }
- if (formatterForeignKeyFilterEnabled.value && !columns.some((column) => column.name === formatterForeignKeyFilterColumn.value)) formatterForeignKeyFilterColumn.value = "";
- } catch (error: any) {
- if (request === formatterForeignKeyColumnsRequest) formatterForeignKeyColumnsError.value = String(error?.message || error);
- } finally {
- if (request === formatterForeignKeyColumnsRequest) formatterForeignKeyColumnsLoading.value = false;
- }
-}
-
-function formatterForeignKeyDefaultSchema() {
- return formatterForeignKeyRefSchema.value || props.tableMeta?.schema || props.schema || props.database || "";
-}
-
-async function loadFormatterManualReferenceTables(columnIndex: number, request = ++formatterForeignKeyTargetRequest) {
- formatterForeignKeyTables.value = [];
- formatterForeignKeyTargetError.value = "";
- if (!props.connectionId) return;
- formatterForeignKeyTablesLoading.value = true;
- try {
- const tables = await api.listTables(props.connectionId, props.database || "", formatterForeignKeyRefSchema.value, undefined, undefined, undefined, undefined, props.tableMeta?.catalog);
- if (request !== formatterForeignKeyTargetRequest || formatterOpenColumn.value !== columnIndex) return;
- formatterForeignKeyTables.value = [...new Set(tables.map((table) => table.name))].sort((left, right) => left.localeCompare(right));
- if (formatterForeignKeyRefTable.value && !formatterForeignKeyTables.value.includes(formatterForeignKeyRefTable.value)) formatterForeignKeyTables.value.unshift(formatterForeignKeyRefTable.value);
- if (formatterForeignKeyRefTable.value) await loadFormatterForeignKeyColumns(columnIndex);
- } catch (error: any) {
- if (request === formatterForeignKeyTargetRequest) formatterForeignKeyTargetError.value = String(error?.message || error);
- } finally {
- if (request === formatterForeignKeyTargetRequest) formatterForeignKeyTablesLoading.value = false;
- }
-}
-
-async function loadFormatterManualReferenceOptions(columnIndex: number) {
- const request = ++formatterForeignKeyTargetRequest;
- formatterForeignKeySchemas.value = [];
- formatterForeignKeySchemasLoading.value = true;
- formatterForeignKeyTargetError.value = "";
- try {
- const schemas = props.connectionId ? await api.listSchemas(props.connectionId, props.database || "") : [];
- if (request !== formatterForeignKeyTargetRequest || formatterOpenColumn.value !== columnIndex) return;
- const selectedSchema = formatterForeignKeyDefaultSchema();
- formatterForeignKeyRefSchema.value = selectedSchema;
- formatterForeignKeySchemas.value = [...new Set([selectedSchema, ...schemas].filter(Boolean))].sort((left, right) => left.localeCompare(right));
- } catch (error: any) {
- if (request !== formatterForeignKeyTargetRequest) return;
- const selectedSchema = formatterForeignKeyDefaultSchema();
- formatterForeignKeyRefSchema.value = selectedSchema;
- formatterForeignKeySchemas.value = selectedSchema ? [selectedSchema] : [];
- formatterForeignKeyTargetError.value = String(error?.message || error);
- } finally {
- if (request === formatterForeignKeyTargetRequest) formatterForeignKeySchemasLoading.value = false;
- }
- if (request === formatterForeignKeyTargetRequest) await loadFormatterManualReferenceTables(columnIndex, request);
-}
-
-function selectFormatterForeignKeySchema(value: string, columnIndex: number) {
- formatterForeignKeyColumnsRequest += 1;
- formatterForeignKeyRefSchema.value = value;
- formatterForeignKeyRefTable.value = "";
- formatterForeignKeyRefColumn.value = "";
- formatterForeignKeyDisplayColumn.value = "";
- formatterForeignKeyFilterColumn.value = "";
- formatterForeignKeyColumns.value = [];
- formatterForeignKeyReferenceKeys.value = [];
- formatterForeignKeyReferenceMetadataStatus.value = "loading";
- formatterForeignKeyReferenceMetadataError.value = "";
- void loadFormatterManualReferenceTables(columnIndex);
-}
-
-function selectFormatterForeignKeyTable(value: string, columnIndex: number) {
- formatterForeignKeyTargetRequest += 1;
- formatterForeignKeyRefTable.value = value;
- formatterForeignKeyRefColumn.value = "";
- formatterForeignKeyDisplayColumn.value = "";
- formatterForeignKeyFilterColumn.value = "";
- formatterForeignKeyReferenceKeys.value = [];
- formatterForeignKeyReferenceMetadataStatus.value = "loading";
- formatterForeignKeyReferenceMetadataError.value = "";
- void loadFormatterForeignKeyColumns(columnIndex);
-}
-
-function selectFormatterForeignKeyFilterMode(value: DataGridContextFilterMode) {
- formatterForeignKeyFilterMode.value = value;
- if (!filterModeNeedsValue(value)) formatterForeignKeyFilterValue.value = formatterForeignKeyFilterEndValue.value = "";
- else if (!filterModeUsesRange(value)) formatterForeignKeyFilterEndValue.value = "";
-}
-
-async function openColumnFormatter(columnIndex: number) {
- const savedFormatter = savedColumnFormatter(columnIndex);
- loadFormatterDraft(savedFormatter);
- formatterOpenColumn.value = columnIndex;
- await fetchForeignKeys();
- const foreignKey = formatterForeignKeyForColumn(columnIndex);
- if (savedFormatter?.kind === "foreign-key-display" && savedFormatter.referenceMode === "manual") {
- formatterForeignKeyManual.value = true;
- await loadFormatterManualReferenceOptions(columnIndex);
- } else if (foreignKey) {
- formatterForeignKeyManual.value = false;
- formatterForeignKeyRefSchema.value = foreignKey.ref_schema || props.tableMeta?.schema || props.schema || "";
- formatterForeignKeyRefTable.value = foreignKey.ref_table;
- formatterForeignKeyRefColumn.value = foreignKey.ref_column;
- await loadFormatterForeignKeyColumns(columnIndex);
- }
-}
-
function openCompactColumnFormatter(columnIndex: number) {
headerActionMenuOpenColumn.value = null;
guardHeaderPanelDismiss();
@@ -1948,142 +1568,6 @@ function openCompactColumnFormatter(columnIndex: number) {
});
}
-function closeColumnFormatter() {
- formatterForeignKeyColumnsRequest += 1;
- formatterForeignKeyTargetRequest += 1;
- formatterOpenColumn.value = null;
-}
-
-function handleColumnFormatterOpenChange(value: boolean, columnIndex: number) {
- if (value) {
- openColumnFormatter(columnIndex);
- } else if (!shouldIgnoreHeaderPanelClose(columnIndex, formatterOpenColumn.value)) {
- closeColumnFormatter();
- }
-}
-
-async function saveColumnFormatter(columnIndex: number) {
- const key = formatterKeyForColumn(columnIndex);
- if (!key) return;
- try {
- let formatter = currentFormatterDraft();
- if (formatterKind.value === "custom-template" && formatterCustomName.value.trim()) {
- const id = formatterCustomId.value === CUSTOM_FORMATTER_NEW ? createCustomFormatterId() : formatterCustomId.value;
- const saved = await settingsStore.upsertCustomColumnFormatter(
- {
- id,
- name: formatterCustomName.value,
- template: formatterCustomTemplate.value,
- },
- formatterCustomCapturedDeleteVersion.value,
- );
- if (!saved) {
- selectCustomFormatter(CUSTOM_FORMATTER_NEW);
- return;
- }
- formatter = { kind: "custom-ref", formatterId: saved.id };
- }
- settingsStore.updateColumnFormatter(key, formatter);
- closeColumnFormatter();
- } catch (error) {
- toast(t("grid.tableOperationFailed", { message: translateBackendError(t, error) }), 5000);
- }
-}
-
-function clearColumnFormatter(columnIndex: number) {
- // Clear every candidate key: MySQL-family columns can carry both the shared
- // empty-schema spelling and the legacy query-side mirrored-schema spelling,
- // and either surface must leave the column unformatted everywhere.
- const keys = formatterKeysForColumn(columnIndex);
- if (!keys.length) return;
- for (const key of keys) settingsStore.updateColumnFormatter(key, undefined);
- closeColumnFormatter();
-}
-
-function formatterDraftIsSavable(): boolean {
- const formatter = normalizeColumnFormatter(currentFormatterDraft());
- if (!formatter || formatter.kind !== "foreign-key-display" || formatter.referenceMode !== "manual") return !!formatter;
- return formatterForeignKeyReferenceValidation.value === "valid";
-}
-
-function selectFormatterKind(value: FormatterDraftKind, columnIndex: number) {
- formatterKind.value = value;
- if (value !== "foreign-key-display") return;
- const foreignKey = formatterForeignKeyForColumn(columnIndex);
- formatterForeignKeyManual.value = !foreignKey;
- if (foreignKey) {
- formatterForeignKeyRefSchema.value = foreignKey.ref_schema || props.tableMeta?.schema || props.schema || "";
- formatterForeignKeyRefTable.value = foreignKey.ref_table;
- formatterForeignKeyRefColumn.value = foreignKey.ref_column;
- void loadFormatterForeignKeyColumns(columnIndex);
- } else {
- formatterForeignKeyRefSchema.value = formatterForeignKeyDefaultSchema();
- formatterForeignKeyRefTable.value = "";
- formatterForeignKeyRefColumn.value = "";
- formatterForeignKeyDisplayColumn.value = "";
- formatterForeignKeyFilterEnabled.value = false;
- void loadFormatterManualReferenceOptions(columnIndex);
- }
-}
-
-function selectCustomFormatter(value: string) {
- formatterCustomId.value = value;
- if (value === CUSTOM_FORMATTER_NEW) {
- formatterCustomCapturedDeleteVersion.value = undefined;
- formatterCustomName.value = "";
- formatterCustomTemplate.value = "${value}";
- return;
- }
- const saved = settingsStore.editorSettings.customColumnFormatters[value];
- if (!saved) return;
- formatterCustomCapturedDeleteVersion.value = settingsStore.customColumnFormatterDeleteVersion(saved.id);
- formatterCustomName.value = saved.name;
- formatterCustomTemplate.value = saved.template;
-}
-
-function requestDeleteCustomFormatter() {
- if (formatterCustomId.value === CUSTOM_FORMATTER_NEW) return;
- const saved = settingsStore.editorSettings.customColumnFormatters[formatterCustomId.value];
- if (!saved) return;
- formatterCustomDeleteId.value = saved.id;
- formatterCustomDeleteName.value = saved.name;
- formatterCustomDeleteOpen.value = true;
-}
-
-async function confirmDeleteCustomFormatter() {
- const id = formatterCustomDeleteId.value;
- if (!id || formatterCustomDeleteLoading.value) return;
- formatterCustomDeleteLoading.value = true;
- try {
- await settingsStore.deleteCustomColumnFormatter(id);
- if (formatterCustomId.value === id) selectCustomFormatter(CUSTOM_FORMATTER_NEW);
- formatterCustomDeleteOpen.value = false;
- formatterCustomDeleteId.value = "";
- formatterCustomDeleteName.value = "";
- } catch (error) {
- toast(t("grid.tableOperationFailed", { message: translateBackendError(t, error) }), 5000);
- } finally {
- formatterCustomDeleteLoading.value = false;
- }
-}
-
-function createCustomFormatterId(): string {
- return `fmt_${uuid()}`;
-}
-
-function formatterPreviewRows(columnIndex: number) {
- const formatter = resolveColumnFormatter(currentFormatterDraft(), settingsStore.editorSettings.customColumnFormatters);
- return displayRowRefs.value.slice(0, 5).map((_, index) => {
- const item = displayItemAt(index);
- const value = item?.data[columnIndex] ?? null;
- return {
- index: index + 1,
- raw: displayCellValue(value),
- formatted: formatter?.kind === "foreign-key-display" ? formatForeignKeyCellDisplay(value, columnIndex) : applyColumnFormatter(value, formatter),
- };
- });
-}
-
function toggleLocalFilterValue(key: string) {
const draft = localFilterDraft.value;
if (!draft) return;
@@ -5173,6 +4657,79 @@ function displayRowIndexById(rowId: number): number {
const displayItems = computed<RowItem[]>(() => displayRowRefs.value.map(rowItemFromDisplayRef));
+const {
+ formatterOpenColumn,
+ formatterKind,
+ formatterDateUnit,
+ formatterDatetimePattern,
+ formatterDateTimezone,
+ timezoneOptions,
+ formatterJsonPath,
+ formatterMaskPrefix,
+ formatterMaskSuffix,
+ formatterCustomId,
+ formatterCustomName,
+ formatterCustomTemplate,
+ formatterCustomDeleteOpen,
+ formatterCustomDeleteLoading,
+ formatterCustomDeleteName,
+ formatterForeignKeyRefSchema,
+ formatterForeignKeyRefTable,
+ formatterForeignKeyRefColumn,
+ formatterForeignKeyDisplayColumn,
+ formatterForeignKeyManual,
+ formatterForeignKeySchemas,
+ formatterForeignKeyTables,
+ formatterForeignKeyColumns,
+ formatterForeignKeyReferenceMetadataStatus,
+ formatterForeignKeySchemasLoading,
+ formatterForeignKeyTablesLoading,
+ formatterForeignKeyColumnsLoading,
+ formatterForeignKeyTargetError,
+ formatterForeignKeyColumnsError,
+ formatterForeignKeyReferenceMetadataError,
+ formatterForeignKeyFilterEnabled,
+ formatterForeignKeyFilterColumn,
+ formatterForeignKeyFilterMode,
+ formatterForeignKeyFilterValue,
+ formatterForeignKeyFilterEndValue,
+ formatterForeignKeyReferenceColumns,
+ formatterForeignKeyReferenceValidation,
+ savedCustomFormatters,
+ formatterKeyForColumn,
+ savedColumnFormatter,
+ columnFormatter,
+ columnHasFormatter,
+ openColumnFormatter,
+ closeColumnFormatter,
+ handleColumnFormatterOpenChange,
+ saveColumnFormatter,
+ clearColumnFormatter,
+ formatterDraftIsSavable,
+ selectFormatterKind,
+ selectFormatterForeignKeySchema,
+ selectFormatterForeignKeyTable,
+ selectFormatterForeignKeyFilterMode,
+ selectCustomFormatter,
+ requestDeleteCustomFormatter,
+ confirmDeleteCustomFormatter,
+ formatterPreviewRows,
+ CUSTOM_FORMATTER_NEW,
+} = useDataGridColumnFormatter({
+ props,
+ settingsStore,
+ resolvedDatabaseType,
+ resolvedConnectionUrlParams: computed(() => resolvedConnectionConfig.value?.url_params),
+ tableColumnForGridColumn,
+ foreignKeyForColumn: (columnIndex) => singleColumnForeignKey(cellForeignKeyAssociation(columnIndex)),
+ fetchForeignKeys,
+ displayRowRefs,
+ displayItemAt,
+ shouldIgnoreHeaderPanelClose,
+ formatForeignKeyCellDisplay,
+ toast,
+});
+
watch(
() => displayRowCount.value,
(length) => {
@@ -11683,6 +11240,10 @@ function cellForeignKeyAssociation(actualColIdx: number): ForeignKeyAssociation
return columnForeignKeyMap.value.get(columnName.toLowerCase()) ?? null;
}
+function formatterForeignKeyForColumn(columnIndex: number): ForeignKeyInfo | undefined {
+ return singleColumnForeignKey(cellForeignKeyAssociation(columnIndex));
+}
+
function savedForeignKeyDisplayConfig(columnIndex: number): ForeignKeyDisplayConfig | undefined {
const formatter = savedColumnFormatter(columnIndex);
if (formatter?.kind !== "foreign-key-display") return undefined;
diff --git a/apps/desktop/src/components/grid/__tests__/DataGridColumnFormatterKeys.spec.ts b/apps/desktop/src/components/grid/__tests__/DataGridColumnFormatterKeys.spec.ts
index 62c60f19b6..867dfa4050 100644
--- a/apps/desktop/src/components/grid/__tests__/DataGridColumnFormatterKeys.spec.ts
+++ b/apps/desktop/src/components/grid/__tests__/DataGridColumnFormatterKeys.spec.ts
@@ -2,28 +2,29 @@ import { readFileSync } from "node:fs";
import { describe, expect, it } from "vitest";
const dataGridSource = readFileSync(new URL("../DataGrid.vue", import.meta.url), "utf8");
+const formatterSource = readFileSync(new URL("../../../composables/useDataGridColumnFormatter.ts", import.meta.url), "utf8");
-function functionSource(name: string): string {
- const start = dataGridSource.indexOf(`function ${name}`);
+function functionSource(source: string, name: string): string {
+ const start = source.indexOf(`function ${name}`);
expect(start).toBeGreaterThanOrEqual(0);
- const end = dataGridSource.indexOf("\nfunction ", start + 1);
- return dataGridSource.slice(start, end < 0 ? undefined : end);
+ const end = source.indexOf("\n function ", start + 1);
+ return source.slice(start, end < 0 ? undefined : end);
}
describe("DataGrid column formatter keys", () => {
it("derives every key list from the shared canonical key builder", () => {
- const keysSource = functionSource("formatterKeysForColumn");
+ const keysSource = functionSource(formatterSource, "formatterKeysForColumn");
expect(keysSource).toContain("return columnFormatterKeys({");
- expect(keysSource).toContain("databaseType: resolvedDatabaseType.value");
+ expect(keysSource).toContain("databaseType: options.resolvedDatabaseType.value");
expect(keysSource).toContain("displaySource: props.queryDisplaySourceColumns?.[columnIndex]");
// Saves keep writing the single canonical keys[0] spelling.
- const saveSource = functionSource("saveColumnFormatter");
+ const saveSource = functionSource(formatterSource, "saveColumnFormatter");
expect(saveSource).toContain("const key = formatterKeyForColumn(columnIndex);");
expect(saveSource).toContain("settingsStore.updateColumnFormatter(key, formatter);");
});
it("clears every candidate key so either surface leaves the column unformatted", () => {
- const clearSource = functionSource("clearColumnFormatter");
+ const clearSource = functionSource(formatterSource, "clearColumnFormatter");
expect(clearSource).toContain("const keys = formatterKeysForColumn(columnIndex);");
expect(clearSource).toContain("if (!keys.length) return;");
expect(clearSource).toContain("for (const key of keys) settingsStore.updateColumnFormatter(key, undefined);");
diff --git a/apps/desktop/src/composables/useDataGridColumnFormatter.ts b/apps/desktop/src/composables/useDataGridColumnFormatter.ts
new file mode 100644
index 0000000000..76e454530f
--- /dev/null
+++ b/apps/desktop/src/composables/useDataGridColumnFormatter.ts
@@ -0,0 +1,590 @@
+import { computed, ref, type ComputedRef } from "vue";
+import { useI18n } from "vue-i18n";
+import dayjs from "dayjs";
+import timezone from "dayjs/plugin/timezone";
+import utc from "dayjs/plugin/utc";
+import * as api from "@/lib/backend/api";
+import { translateBackendError } from "@/i18n/backend-errors";
+import { uuid } from "@/lib/common/utils";
+import {
+ applyColumnFormatter,
+ columnFormatterKeys,
+ defaultIoTDBTimestampFormatter,
+ DataGridDateTimePatterns,
+ displayTimeZoneOption,
+ getSupportedTimeZoneOptions,
+ normalizeColumnFormatter,
+ resolveColumnFormatter,
+ type ColumnFormatterConfig,
+ type DateTimeFormatterUnit,
+ type ForeignKeyDisplayFilterConfig,
+} from "@/lib/dataGrid/columnFormatter";
+import { filterModeNeedsValue, filterModeUsesRange } from "@/lib/dataGrid/dataGridColumnFilter";
+import type { DataGridContextFilterMode } from "@/lib/dataGrid/dataGridSql";
+import { displayCellValue, type CellValue } from "@/lib/dataGrid/cellValue";
+import { manualReferenceColumnValidation, manualReferenceKeyColumns, reconcileManualReferenceColumn, type ManualReferenceMetadataStatus } from "@/lib/dataGrid/dataGridForeignKeyDisplay";
+import type { ColumnInfo, DatabaseType, ForeignKeyInfo, QueryResultSourceColumnRef, ReferenceKeyInfo } from "@/types/database";
+import { useSettingsStore } from "@/stores/settingsStore";
+
+dayjs.extend(utc);
+dayjs.extend(timezone);
+
+export const CUSTOM_FORMATTER_NEW = "__new";
+
+type FormatterDraftKind = Exclude<ColumnFormatterConfig["kind"], "custom-ref" | "iotdb-timestamp">;
+type SettingsStore = ReturnType<typeof useSettingsStore>;
+
+interface FormatterResult {
+ columns: string[];
+ column_types?: Array<string | null | undefined>;
+ rows: CellValue[][];
+}
+
+interface FormatterTableMeta {
+ catalog?: string;
+ database?: string;
+ schema?: string;
+ tableName: string;
+}
+
+export interface DataGridColumnFormatterProps {
+ result: FormatterResult;
+ connectionId?: string;
+ database?: string;
+ executionDatabase?: string;
+ schema?: string;
+ sourceColumns?: Array<string | undefined>;
+ queryDisplaySourceColumns?: Array<QueryResultSourceColumnRef | undefined>;
+ tableMeta?: FormatterTableMeta;
+}
+
+export interface DataGridColumnFormatterOptions {
+ props: DataGridColumnFormatterProps;
+ settingsStore: SettingsStore;
+ resolvedDatabaseType: ComputedRef<DatabaseType | undefined>;
+ resolvedConnectionUrlParams: ComputedRef<string | undefined>;
+ tableColumnForGridColumn: (columnIndex: number) => ColumnInfo | undefined;
+ foreignKeyForColumn: (columnIndex: number) => ForeignKeyInfo | undefined;
+ fetchForeignKeys: () => Promise<void>;
+ displayRowRefs: ComputedRef<readonly unknown[]>;
+ displayItemAt: (rowIndex: number) => { data: CellValue[] } | undefined;
+ shouldIgnoreHeaderPanelClose: (columnIndex: number, openColumn: number | null) => boolean;
+ formatForeignKeyCellDisplay: (value: CellValue, columnIndex: number) => string;
+ toast?: (message: string, duration?: number) => void;
+}
+
+export function useDataGridColumnFormatter(options: DataGridColumnFormatterOptions) {
+ const { t } = useI18n();
+ const { props, settingsStore } = options;
+ const formatterOpenColumn = ref<number | null>(null);
+ const formatterKind = ref<FormatterDraftKind>("datetime");
+ const formatterDateUnit = ref<DateTimeFormatterUnit>("auto");
+ const formatterDatetimePattern = ref("YYYY-MM-DD HH:mm:ss");
+ const formatterDateTimezone = ref(dayjs.tz.guess() || "UTC");
+ const timezoneOptions = getSupportedTimeZoneOptions(Intl as typeof Intl & { supportedValuesOf?: (key: "timeZone") => string[] }, formatterDateTimezone.value);
+ const formatterJsonPath = ref("$.user.name");
+ const formatterMaskPrefix = ref(4);
+ const formatterMaskSuffix = ref(4);
+ const formatterCustomId = ref(CUSTOM_FORMATTER_NEW);
+ const formatterCustomCapturedDeleteVersion = ref<number>();
+ const formatterCustomName = ref("");
+ const formatterCustomTemplate = ref("${value}");
+ const formatterCustomDeleteOpen = ref(false);
+ const formatterCustomDeleteLoading = ref(false);
+ const formatterCustomDeleteId = ref("");
+ const formatterCustomDeleteName = ref("");
+ const formatterForeignKeyRefSchema = ref("");
+ const formatterForeignKeyRefTable = ref("");
+ const formatterForeignKeyRefColumn = ref("");
+ const formatterForeignKeyDisplayColumn = ref("");
+ const formatterForeignKeyManual = ref(false);
+ const formatterForeignKeySchemas = ref<string[]>([]);
+ const formatterForeignKeyTables = ref<string[]>([]);
+ const formatterForeignKeyColumns = ref<ColumnInfo[]>([]);
+ const formatterForeignKeyReferenceKeys = ref<ReferenceKeyInfo[]>([]);
+ const formatterForeignKeyReferenceMetadataStatus = ref<ManualReferenceMetadataStatus>("loading");
+ const formatterForeignKeySchemasLoading = ref(false);
+ const formatterForeignKeyTablesLoading = ref(false);
+ const formatterForeignKeyColumnsLoading = ref(false);
+ const formatterForeignKeyTargetError = ref("");
+ const formatterForeignKeyColumnsError = ref("");
+ const formatterForeignKeyReferenceMetadataError = ref("");
+ const formatterForeignKeyFilterEnabled = ref(false);
+ const formatterForeignKeyFilterColumn = ref("");
+ const formatterForeignKeyFilterMode = ref<DataGridContextFilterMode>("equals");
+ const formatterForeignKeyFilterValue = ref("");
+ const formatterForeignKeyFilterEndValue = ref("");
+ let formatterForeignKeyColumnsRequest = 0;
+ let formatterForeignKeyTargetRequest = 0;
+
+ const formatterForeignKeyReferenceFilter = computed<ForeignKeyDisplayFilterConfig | undefined>(() =>
+ formatterForeignKeyFilterEnabled.value
+ ? {
+ column: formatterForeignKeyFilterColumn.value,
+ mode: formatterForeignKeyFilterMode.value,
+ value: formatterForeignKeyFilterValue.value,
+ endValue: formatterForeignKeyFilterEndValue.value,
+ }
+ : undefined,
+ );
+ const formatterForeignKeyReferenceColumns = computed(() => (formatterForeignKeyManual.value ? manualReferenceKeyColumns(formatterForeignKeyColumns.value, formatterForeignKeyReferenceKeys.value, formatterForeignKeyReferenceFilter.value) : formatterForeignKeyColumns.value));
+ const formatterForeignKeyReferenceValidation = computed(() => manualReferenceColumnValidation(formatterForeignKeyColumns.value, formatterForeignKeyReferenceKeys.value, formatterForeignKeyRefColumn.value, formatterForeignKeyReferenceMetadataStatus.value, formatterForeignKeyReferenceFilter.value));
+ const savedCustomFormatters = computed(() => Object.values(settingsStore.editorSettings.customColumnFormatters).sort((left, right) => left.name.localeCompare(right.name)));
+
+ function formatterKeysForColumn(columnIndex: number): string[] {
+ const resultColumn = props.result.columns[columnIndex];
+ if (!props.connectionId || !resultColumn) return [];
+ return columnFormatterKeys({
+ connectionId: props.connectionId,
+ database: props.database,
+ schema: props.schema,
+ databaseType: options.resolvedDatabaseType.value,
+ resultColumn,
+ sourceColumn: props.sourceColumns?.[columnIndex],
+ displaySource: props.queryDisplaySourceColumns?.[columnIndex],
+ tableMeta: props.tableMeta,
+ });
+ }
+
+ function formatterKeyForColumn(columnIndex: number): string | null {
+ return formatterKeysForColumn(columnIndex)[0] ?? null;
+ }
+
+ function savedColumnFormatterEntry(columnIndex: number): { key: string; formatter: ColumnFormatterConfig } | undefined {
+ for (const key of formatterKeysForColumn(columnIndex)) {
+ const formatter = settingsStore.editorSettings.columnFormatters[key];
+ if (formatter) return { key, formatter };
+ }
+ return undefined;
+ }
+
+ function columnFormatter(columnIndex: number): ColumnFormatterConfig | undefined {
+ const columnType = props.result.column_types?.[columnIndex] ?? options.tableColumnForGridColumn(columnIndex)?.data_type;
+ const savedFormatter = savedColumnFormatterEntry(columnIndex)?.formatter;
+ const configured = resolveColumnFormatter(savedFormatter, settingsStore.editorSettings.customColumnFormatters, {
+ pattern: settingsStore.editorSettings.globalDateTimeDisplayFormat,
+ columnType,
+ });
+ if (savedFormatter && configured) return configured;
+ return defaultIoTDBTimestampFormatter(options.resolvedDatabaseType.value, columnType, options.resolvedConnectionUrlParams.value) ?? configured;
+ }
+
+ function savedColumnFormatter(columnIndex: number): ColumnFormatterConfig | undefined {
+ return savedColumnFormatterEntry(columnIndex)?.formatter;
+ }
+
+ function columnHasFormatter(columnIndex: number): boolean {
+ return !!columnFormatter(columnIndex);
+ }
+
+ function currentFormatterDraft(): ColumnFormatterConfig {
+ if (formatterKind.value === "json-path") return { kind: "json-path", path: formatterJsonPath.value.trim() || "$" };
+ if (formatterKind.value === "mask") {
+ return { kind: "mask", prefix: Math.max(0, Math.floor(Number(formatterMaskPrefix.value) || 0)), suffix: Math.max(0, Math.floor(Number(formatterMaskSuffix.value) || 0)) };
+ }
+ if (formatterKind.value === "custom-template") return { kind: "custom-template", template: formatterCustomTemplate.value.trim() || "${value}" };
+ if (formatterKind.value === "foreign-key-display") {
+ return {
+ kind: "foreign-key-display",
+ referenceMode: formatterForeignKeyManual.value ? "manual" : "foreign-key",
+ refSchema: formatterForeignKeyRefSchema.value || undefined,
+ refTable: formatterForeignKeyRefTable.value,
+ refColumn: formatterForeignKeyRefColumn.value,
+ displayColumn: formatterForeignKeyDisplayColumn.value,
+ filter: formatterForeignKeyFilterEnabled.value
+ ? {
+ column: formatterForeignKeyFilterColumn.value,
+ mode: formatterForeignKeyFilterMode.value,
+ value: formatterForeignKeyFilterValue.value,
+ endValue: formatterForeignKeyFilterEndValue.value,
+ }
+ : undefined,
+ };
+ }
+ return { kind: "datetime", unit: formatterDateUnit.value, pattern: formatterDatetimePattern.value, timezone: formatterDateTimezone.value };
+ }
+
+ function loadFormatterDraft(formatter: ColumnFormatterConfig | undefined) {
+ formatterForeignKeyManual.value = false;
+ formatterForeignKeyRefSchema.value = "";
+ formatterForeignKeyRefTable.value = "";
+ formatterForeignKeyRefColumn.value = "";
+ formatterForeignKeyDisplayColumn.value = "";
+ formatterForeignKeySchemas.value = [];
+ formatterForeignKeyTables.value = [];
+ formatterForeignKeyColumns.value = [];
+ formatterForeignKeyReferenceKeys.value = [];
+ formatterForeignKeyReferenceMetadataStatus.value = "loading";
+ formatterForeignKeyTargetError.value = "";
+ formatterForeignKeyColumnsError.value = "";
+ formatterForeignKeyReferenceMetadataError.value = "";
+ formatterForeignKeyFilterEnabled.value = false;
+ formatterForeignKeyFilterColumn.value = "";
+ formatterForeignKeyFilterMode.value = "equals";
+ formatterForeignKeyFilterValue.value = "";
+ formatterForeignKeyFilterEndValue.value = "";
+ const draft = formatter ?? { kind: "datetime", unit: "auto" as const, pattern: "YYYY-MM-DD HH:mm:ss" as const, timezone: dayjs.tz.guess() };
+ formatterKind.value = draft.kind === "custom-ref" ? "custom-template" : draft.kind === "iotdb-timestamp" ? "datetime" : draft.kind;
+ if (draft.kind === "datetime") {
+ formatterDateUnit.value = draft.unit;
+ formatterDatetimePattern.value = draft.pattern;
+ formatterDateTimezone.value = draft.timezone || dayjs.tz.guess() || "UTC";
+ } else if (draft.kind === "iotdb-timestamp") {
+ formatterDateUnit.value = "milliseconds";
+ formatterDatetimePattern.value = "YYYY-MM-DDTHH:mm:ss.SSSZ";
+ formatterDateTimezone.value = draft.timezone;
+ } else if (draft.kind === "json-path") {
+ formatterJsonPath.value = draft.path;
+ } else if (draft.kind === "mask") {
+ formatterMaskPrefix.value = draft.prefix;
+ formatterMaskSuffix.value = draft.suffix;
+ } else if (draft.kind === "custom-ref") {
+ const saved = settingsStore.editorSettings.customColumnFormatters[draft.formatterId];
+ formatterCustomId.value = saved ? saved.id : CUSTOM_FORMATTER_NEW;
+ formatterCustomCapturedDeleteVersion.value = saved ? settingsStore.customColumnFormatterDeleteVersion(saved.id) : undefined;
+ formatterCustomName.value = saved?.name ?? "";
+ formatterCustomTemplate.value = saved?.template ?? "${value}";
+ } else if (draft.kind === "custom-template") {
+ formatterCustomId.value = CUSTOM_FORMATTER_NEW;
+ formatterCustomCapturedDeleteVersion.value = undefined;
+ formatterCustomName.value = "";
+ formatterCustomTemplate.value = draft.template;
+ } else if (draft.kind === "foreign-key-display") {
+ formatterForeignKeyManual.value = draft.referenceMode === "manual";
+ formatterForeignKeyRefSchema.value = draft.refSchema ?? "";
+ formatterForeignKeyRefTable.value = draft.refTable;
+ formatterForeignKeyRefColumn.value = draft.refColumn;
+ formatterForeignKeyDisplayColumn.value = draft.displayColumn;
+ formatterForeignKeyFilterEnabled.value = !!draft.filter;
+ formatterForeignKeyFilterColumn.value = draft.filter?.column ?? "";
+ formatterForeignKeyFilterMode.value = draft.filter?.mode ?? "equals";
+ formatterForeignKeyFilterValue.value = draft.filter?.value ?? "";
+ formatterForeignKeyFilterEndValue.value = draft.filter?.endValue ?? "";
+ }
+ }
+
+ function formatterForeignKeyDefaultSchema() {
+ return formatterForeignKeyRefSchema.value || props.tableMeta?.schema || props.schema || props.database || "";
+ }
+
+ async function loadFormatterForeignKeyColumns(columnIndex: number) {
+ const request = ++formatterForeignKeyColumnsRequest;
+ formatterForeignKeyColumns.value = [];
+ formatterForeignKeyReferenceKeys.value = [];
+ formatterForeignKeyReferenceMetadataStatus.value = "loading";
+ formatterForeignKeyColumnsError.value = "";
+ formatterForeignKeyReferenceMetadataError.value = "";
+ if (!props.connectionId || !formatterForeignKeyRefTable.value) return;
+ formatterForeignKeyColumnsLoading.value = true;
+ try {
+ const schema = formatterForeignKeyRefSchema.value || props.tableMeta?.schema || props.schema || props.database || "";
+ const manual = formatterForeignKeyManual.value;
+ const [columnsResult, referenceKeysResult] = await Promise.allSettled([
+ api.getColumns(props.connectionId, props.database || "", schema, formatterForeignKeyRefTable.value, props.tableMeta?.catalog),
+ manual ? api.listReferenceKeys(props.connectionId, props.database || "", schema, formatterForeignKeyRefTable.value, props.tableMeta?.catalog) : Promise.resolve([] as ReferenceKeyInfo[]),
+ ]);
+ if (request !== formatterForeignKeyColumnsRequest || formatterOpenColumn.value !== columnIndex) return;
+ if (columnsResult.status === "rejected") throw columnsResult.reason;
+ const columns = columnsResult.value;
+ formatterForeignKeyColumns.value = columns;
+ if (manual && referenceKeysResult.status === "rejected") {
+ formatterForeignKeyReferenceMetadataStatus.value = "unavailable";
+ formatterForeignKeyReferenceMetadataError.value = String(referenceKeysResult.reason?.message || referenceKeysResult.reason);
+ } else {
+ formatterForeignKeyReferenceKeys.value = referenceKeysResult.status === "fulfilled" ? referenceKeysResult.value : [];
+ formatterForeignKeyReferenceMetadataStatus.value = "available";
+ }
+ const referenceColumns = manualReferenceKeyColumns(columns, formatterForeignKeyReferenceKeys.value, formatterForeignKeyReferenceFilter.value);
+ const foreignKey = options.foreignKeyForColumn(columnIndex);
+ if (manual) {
+ formatterForeignKeyRefColumn.value = reconcileManualReferenceColumn(formatterForeignKeyRefColumn.value, referenceColumns, formatterForeignKeyReferenceMetadataStatus.value);
+ } else if (!formatterForeignKeyRefColumn.value || !columns.some((column) => column.name === formatterForeignKeyRefColumn.value)) {
+ formatterForeignKeyRefColumn.value = foreignKey?.ref_column ?? "";
+ }
+ if (!formatterForeignKeyDisplayColumn.value || !columns.some((column) => column.name === formatterForeignKeyDisplayColumn.value)) {
+ formatterForeignKeyDisplayColumn.value = columns.find((column) => column.name !== formatterForeignKeyRefColumn.value)?.name ?? columns[0]?.name ?? "";
+ }
+ if (formatterForeignKeyFilterEnabled.value && !columns.some((column) => column.name === formatterForeignKeyFilterColumn.value)) formatterForeignKeyFilterColumn.value = "";
+ } catch (error: any) {
+ if (request === formatterForeignKeyColumnsRequest) formatterForeignKeyColumnsError.value = String(error?.message || error);
+ } finally {
+ if (request === formatterForeignKeyColumnsRequest) formatterForeignKeyColumnsLoading.value = false;
+ }
+ }
+
+ async function loadFormatterManualReferenceTables(columnIndex: number, request = ++formatterForeignKeyTargetRequest) {
+ formatterForeignKeyTables.value = [];
+ formatterForeignKeyTargetError.value = "";
+ if (!props.connectionId) return;
+ formatterForeignKeyTablesLoading.value = true;
+ try {
+ const tables = await api.listTables(props.connectionId, props.database || "", formatterForeignKeyRefSchema.value, undefined, undefined, undefined, undefined, props.tableMeta?.catalog);
+ if (request !== formatterForeignKeyTargetRequest || formatterOpenColumn.value !== columnIndex) return;
+ formatterForeignKeyTables.value = [...new Set(tables.map((table) => table.name))].sort((left, right) => left.localeCompare(right));
+ if (formatterForeignKeyRefTable.value && !formatterForeignKeyTables.value.includes(formatterForeignKeyRefTable.value)) formatterForeignKeyTables.value.unshift(formatterForeignKeyRefTable.value);
+ if (formatterForeignKeyRefTable.value) await loadFormatterForeignKeyColumns(columnIndex);
+ } catch (error: any) {
+ if (request === formatterForeignKeyTargetRequest) formatterForeignKeyTargetError.value = String(error?.message || error);
+ } finally {
+ if (request === formatterForeignKeyTargetRequest) formatterForeignKeyTablesLoading.value = false;
+ }
+ }
+
+ async function loadFormatterManualReferenceOptions(columnIndex: number) {
+ const request = ++formatterForeignKeyTargetRequest;
+ formatterForeignKeySchemas.value = [];
+ formatterForeignKeySchemasLoading.value = true;
+ formatterForeignKeyTargetError.value = "";
+ try {
+ const schemas = props.connectionId ? await api.listSchemas(props.connectionId, props.database || "") : [];
+ if (request !== formatterForeignKeyTargetRequest || formatterOpenColumn.value !== columnIndex) return;
+ const selectedSchema = formatterForeignKeyDefaultSchema();
+ formatterForeignKeyRefSchema.value = selectedSchema;
+ formatterForeignKeySchemas.value = [...new Set([selectedSchema, ...schemas].filter(Boolean))].sort((left, right) => left.localeCompare(right));
+ } catch (error: any) {
+ if (request !== formatterForeignKeyTargetRequest) return;
+ const selectedSchema = formatterForeignKeyDefaultSchema();
+ formatterForeignKeyRefSchema.value = selectedSchema;
+ formatterForeignKeySchemas.value = selectedSchema ? [selectedSchema] : [];
+ formatterForeignKeyTargetError.value = String(error?.message || error);
+ } finally {
+ if (request === formatterForeignKeyTargetRequest) formatterForeignKeySchemasLoading.value = false;
+ }
+ if (request === formatterForeignKeyTargetRequest) await loadFormatterManualReferenceTables(columnIndex, request);
+ }
+
+ function selectFormatterForeignKeySchema(value: string, columnIndex: number) {
+ formatterForeignKeyColumnsRequest += 1;
+ formatterForeignKeyRefSchema.value = value;
+ formatterForeignKeyRefTable.value = "";
+ formatterForeignKeyRefColumn.value = "";
+ formatterForeignKeyDisplayColumn.value = "";
+ formatterForeignKeyFilterColumn.value = "";
+ formatterForeignKeyColumns.value = [];
+ formatterForeignKeyReferenceKeys.value = [];
+ formatterForeignKeyReferenceMetadataStatus.value = "loading";
+ formatterForeignKeyReferenceMetadataError.value = "";
+ void loadFormatterManualReferenceTables(columnIndex);
+ }
+
+ function selectFormatterForeignKeyTable(value: string, columnIndex: number) {
+ formatterForeignKeyTargetRequest += 1;
+ formatterForeignKeyRefTable.value = value;
+ formatterForeignKeyRefColumn.value = "";
+ formatterForeignKeyDisplayColumn.value = "";
+ formatterForeignKeyFilterColumn.value = "";
+ formatterForeignKeyReferenceKeys.value = [];
+ formatterForeignKeyReferenceMetadataStatus.value = "loading";
+ formatterForeignKeyReferenceMetadataError.value = "";
+ void loadFormatterForeignKeyColumns(columnIndex);
+ }
+
+ function selectFormatterForeignKeyFilterMode(value: DataGridContextFilterMode) {
+ formatterForeignKeyFilterMode.value = value;
+ if (!filterModeNeedsValue(value)) formatterForeignKeyFilterValue.value = formatterForeignKeyFilterEndValue.value = "";
+ else if (!filterModeUsesRange(value)) formatterForeignKeyFilterEndValue.value = "";
+ }
+
+ async function openColumnFormatter(columnIndex: number) {
+ const savedFormatter = savedColumnFormatter(columnIndex);
+ loadFormatterDraft(savedFormatter);
+ formatterOpenColumn.value = columnIndex;
+ await options.fetchForeignKeys();
+ const foreignKey = options.foreignKeyForColumn(columnIndex);
+ if (savedFormatter?.kind === "foreign-key-display" && savedFormatter.referenceMode === "manual") {
+ formatterForeignKeyManual.value = true;
+ await loadFormatterManualReferenceOptions(columnIndex);
+ } else if (foreignKey) {
+ formatterForeignKeyManual.value = false;
+ formatterForeignKeyRefSchema.value = foreignKey.ref_schema || props.tableMeta?.schema || props.schema || "";
+ formatterForeignKeyRefTable.value = foreignKey.ref_table;
+ formatterForeignKeyRefColumn.value = foreignKey.ref_column;
+ await loadFormatterForeignKeyColumns(columnIndex);
+ }
+ }
+
+ function closeColumnFormatter() {
+ formatterForeignKeyColumnsRequest += 1;
+ formatterForeignKeyTargetRequest += 1;
+ formatterOpenColumn.value = null;
+ }
+
+ function handleColumnFormatterOpenChange(value: boolean, columnIndex: number) {
+ if (value) void openColumnFormatter(columnIndex);
+ else if (!options.shouldIgnoreHeaderPanelClose(columnIndex, formatterOpenColumn.value)) closeColumnFormatter();
+ }
+
+ async function saveColumnFormatter(columnIndex: number) {
+ const key = formatterKeyForColumn(columnIndex);
+ if (!key) return;
+ try {
+ let formatter = currentFormatterDraft();
+ if (formatterKind.value === "custom-template" && formatterCustomName.value.trim()) {
+ const id = formatterCustomId.value === CUSTOM_FORMATTER_NEW ? `fmt_${uuid()}` : formatterCustomId.value;
+ const saved = await settingsStore.upsertCustomColumnFormatter({ id, name: formatterCustomName.value, template: formatterCustomTemplate.value }, formatterCustomCapturedDeleteVersion.value);
+ if (!saved) {
+ selectCustomFormatter(CUSTOM_FORMATTER_NEW);
+ return;
+ }
+ formatter = { kind: "custom-ref", formatterId: saved.id };
+ }
+ settingsStore.updateColumnFormatter(key, formatter);
+ closeColumnFormatter();
+ } catch (error) {
+ options.toast?.(t("grid.tableOperationFailed", { message: translateBackendError(t, error) }), 5000);
+ }
+ }
+
+ function clearColumnFormatter(columnIndex: number) {
+ const keys = formatterKeysForColumn(columnIndex);
+ if (!keys.length) return;
+ for (const key of keys) settingsStore.updateColumnFormatter(key, undefined);
+ closeColumnFormatter();
+ }
+
+ function formatterDraftIsSavable(): boolean {
+ const formatter = normalizeColumnFormatter(currentFormatterDraft());
+ if (!formatter || formatter.kind !== "foreign-key-display" || formatter.referenceMode !== "manual") return !!formatter;
+ return formatterForeignKeyReferenceValidation.value === "valid";
+ }
+
+ function selectFormatterKind(value: FormatterDraftKind, columnIndex: number) {
+ formatterKind.value = value;
+ if (value !== "foreign-key-display") return;
+ const foreignKey = options.foreignKeyForColumn(columnIndex);
+ formatterForeignKeyManual.value = !foreignKey;
+ if (foreignKey) {
+ formatterForeignKeyRefSchema.value = foreignKey.ref_schema || props.tableMeta?.schema || props.schema || "";
+ formatterForeignKeyRefTable.value = foreignKey.ref_table;
+ formatterForeignKeyRefColumn.value = foreignKey.ref_column;
+ void loadFormatterForeignKeyColumns(columnIndex);
+ } else {
+ formatterForeignKeyRefSchema.value = formatterForeignKeyDefaultSchema();
+ formatterForeignKeyRefTable.value = "";
+ formatterForeignKeyRefColumn.value = "";
+ formatterForeignKeyDisplayColumn.value = "";
+ formatterForeignKeyFilterEnabled.value = false;
+ void loadFormatterManualReferenceOptions(columnIndex);
+ }
+ }
+
+ function selectCustomFormatter(value: string) {
+ formatterCustomId.value = value;
+ if (value === CUSTOM_FORMATTER_NEW) {
+ formatterCustomCapturedDeleteVersion.value = undefined;
+ formatterCustomName.value = "";
+ formatterCustomTemplate.value = "${value}";
+ return;
+ }
+ const saved = settingsStore.editorSettings.customColumnFormatters[value];
+ if (!saved) return;
+ formatterCustomCapturedDeleteVersion.value = settingsStore.customColumnFormatterDeleteVersion(saved.id);
+ formatterCustomName.value = saved.name;
+ formatterCustomTemplate.value = saved.template;
+ }
+
+ function requestDeleteCustomFormatter() {
+ if (formatterCustomId.value === CUSTOM_FORMATTER_NEW) return;
+ const saved = settingsStore.editorSettings.customColumnFormatters[formatterCustomId.value];
+ if (!saved) return;
+ formatterCustomDeleteId.value = saved.id;
+ formatterCustomDeleteName.value = saved.name;
+ formatterCustomDeleteOpen.value = true;
+ }
+
+ async function confirmDeleteCustomFormatter() {
+ const id = formatterCustomDeleteId.value;
+ if (!id || formatterCustomDeleteLoading.value) return;
+ formatterCustomDeleteLoading.value = true;
+ try {
+ await settingsStore.deleteCustomColumnFormatter(id);
+ if (formatterCustomId.value === id) selectCustomFormatter(CUSTOM_FORMATTER_NEW);
+ formatterCustomDeleteOpen.value = false;
+ formatterCustomDeleteId.value = "";
+ formatterCustomDeleteName.value = "";
+ } catch (error) {
+ options.toast?.(t("grid.tableOperationFailed", { message: translateBackendError(t, error) }), 5000);
+ } finally {
+ formatterCustomDeleteLoading.value = false;
+ }
+ }
+
+ function formatterPreviewRows(columnIndex: number) {
+ const formatter = resolveColumnFormatter(currentFormatterDraft(), settingsStore.editorSettings.customColumnFormatters);
+ return options.displayRowRefs.value.slice(0, 5).map((_, index) => {
+ const item = options.displayItemAt(index);
+ const value = item?.data[columnIndex] ?? null;
+ return {
+ index: index + 1,
+ raw: displayCellValue(value),
+ formatted: formatter?.kind === "foreign-key-display" ? options.formatForeignKeyCellDisplay(value, columnIndex) : applyColumnFormatter(value, formatter),
+ };
+ });
+ }
+
+ return {
+ CUSTOM_FORMATTER_NEW,
+ formatterOpenColumn,
+ formatterKind,
+ formatterDateUnit,
+ formatterDatetimePattern,
+ formatterDateTimezone,
+ timezoneOptions,
+ formatterJsonPath,
+ formatterMaskPrefix,
+ formatterMaskSuffix,
+ formatterCustomId,
+ formatterCustomName,
+ formatterCustomTemplate,
+ formatterCustomDeleteOpen,
+ formatterCustomDeleteLoading,
+ formatterCustomDeleteName,
+ formatterForeignKeyRefSchema,
+ formatterForeignKeyRefTable,
+ formatterForeignKeyRefColumn,
+ formatterForeignKeyDisplayColumn,
+ formatterForeignKeyManual,
+ formatterForeignKeySchemas,
+ formatterForeignKeyTables,
+ formatterForeignKeyColumns,
+ formatterForeignKeyReferenceKeys,
+ formatterForeignKeyReferenceMetadataStatus,
+ formatterForeignKeySchemasLoading,
+ formatterForeignKeyTablesLoading,
+ formatterForeignKeyColumnsLoading,
+ formatterForeignKeyTargetError,
+ formatterForeignKeyColumnsError,
+ formatterForeignKeyReferenceMetadataError,
+ formatterForeignKeyFilterEnabled,
+ formatterForeignKeyFilterColumn,
+ formatterForeignKeyFilterMode,
+ formatterForeignKeyFilterValue,
+ formatterForeignKeyFilterEndValue,
+ formatterForeignKeyReferenceColumns,
+ formatterForeignKeyReferenceValidation,
+ formatterForeignKeyReferenceFilter,
+ savedCustomFormatters,
+ DataGridDateTimePatterns,
+ displayTimeZoneOption,
+ formatterKeysForColumn,
+ formatterKeyForColumn,
+ savedColumnFormatter,
+ columnFormatter,
+ columnHasFormatter,
+ currentFormatterDraft,
+ openColumnFormatter,
+ closeColumnFormatter,
+ handleColumnFormatterOpenChange,
+ saveColumnFormatter,
+ clearColumnFormatter,
+ formatterDraftIsSavable,
+ selectFormatterKind,
+ selectFormatterForeignKeySchema,
+ selectFormatterForeignKeyTable,
+ selectFormatterForeignKeyFilterMode,
+ selectCustomFormatter,
+ requestDeleteCustomFormatter,
+ confirmDeleteCustomFormatter,
+ formatterPreviewRows,
+ };
+}
diff --git a/apps/desktop/src/stores/connectionStore.ts b/apps/desktop/src/stores/connectionStore.ts
index 4a62ae9aa8..bae98426f6 100644
--- a/apps/desktop/src/stores/connectionStore.ts
+++ b/apps/desktop/src/stores/connectionStore.ts
@@ -4747,13 +4747,8 @@ export const useConnectionStore = defineStore("connection", () => {
async function loadMqTenants(connectionId: string, options?: LoadTreeOptions) {
const node = findConnectionNode(connectionId);
- if (!node) return;
-
- let load = beginTreeNodeLoad(node);
- try {
- await ensureConnected(connectionId);
- load = reclaimTreeNodeLoad(load, node);
- if (useCachedChildren(node, options, load)) return;
+ return runConnectionTreeMetadataLoad(connectionId, node, async (load) => {
+ if (useCachedChildren(node!, options, load)) return;
const config = getConfig(connectionId);
if (isFlatMqConnection(config)) {
@@ -4791,23 +4786,13 @@ export const useConnectionStore = defineStore("connection", () => {
}
const liveNode = treeNodeLoadTarget(load);
if (liveNode) liveNode.isExpanded = true;
- } catch (e) {
- recordMetadataLoadError(connectionId, e, load);
- throw e;
- } finally {
- finishTreeNodeLoad(load);
- }
+ });
}
async function loadNacosNamespaces(connectionId: string, options?: LoadTreeOptions) {
const node = findConnectionNode(connectionId);
- if (!node) return;
-
- let load = beginTreeNodeLoad(node);
- try {
- await ensureConnected(connectionId);
- load = reclaimTreeNodeLoad(load, node);
- if (useCachedChildren(node, options, load)) return;
+ return runConnectionTreeMetadataLoad(connectionId, node, async (load) => {
+ if (useCachedChildren(node!, options, load)) return;
const sidebarSnapshot = await api.nacosSidebarSnapshot(connectionId);
const namespaces = normalizeNacosNamespacesForDisplay(sidebarSnapshot.namespaces);
@@ -4852,12 +4837,7 @@ export const useConnectionStore = defineStore("connection", () => {
}
setChildren(targetNode, children);
targetNode.isExpanded = true;
- } catch (e) {
- recordMetadataLoadError(connectionId, e, load);
- throw e;
- } finally {
- finishTreeNodeLoad(load);
- }
+ });
}
function updateRedisDbKeyStats(connectionId: string, db: number, stats: { loaded?: number; total?: number; totalDelta?: number }) {