feat(grid): add query result open modes

This commit is contained in:
二丫讲梵 authored and GitHub committed 2026-10-01 01:05:03 +08:00
1 parent 7721019218
commit 4706ffe070
19 files changed
+342 -34

No files matched your search

+28 -1
View File
@@ -59,6 +59,8 @@ import {
WandSparkles,
Camera,
AlertTriangle,
FileSpreadsheet,
Globe2,
} from "@lucide/vue";
import { Button } from "@/components/ui/button";
import { Dialog, DialogContent, DialogFooter, DialogHeader, DialogTitle } from "@/components/ui/dialog";
@@ -307,6 +309,7 @@ import { useToast } from "@/composables/useToast";
import { translateBackendError } from "@/i18n/backend-errors";
import { useNavigationTargets } from "@/composables/useNavigationTargets";
import { useDataGridExport, type MongoCopyUpdateTarget } from "@/composables/useDataGridExport";
import { isTauriRuntime } from "@/lib/backend/tauriRuntime";
import { eventTargetAllowsNativeClipboard, isPlainClipboardShortcut, readTextFromClipboard } from "@/lib/common/clipboard";
import { claimDataGridPaste, claimDataGridSelectAll, clearDataGridClipboardCopy, parseDataGridClipboard, planDataGridPaste } from "@/lib/dataGrid/dataGridClipboard";
import { parseInsertStatementPaste } from "@/lib/dataGrid/dataGridInsertPaste";
@@ -5943,6 +5946,12 @@ function exportSelectedRowsXlsx() {
return exportXlsx(rowIds);
}
function openSelectedRowsXlsx() {
const rowIds = affectedRowIds();
if (rowIds.length === 0) return openXlsx();
return openXlsx(rowIds);
}
function exportSelectedRowsXlsxWithSql() {
const rowIds = affectedRowIds();
if (rowIds.length === 0) return;
@@ -7962,6 +7971,8 @@ const {
exportHtml,
exportCurrentPageHtml,
exportXlsx,
openXlsx,
openBrowser,
exportXlsxWithSql,
exportCurrentPageXlsx,
exportCurrentPageXlsxWithSql,
@@ -11994,6 +12005,7 @@ defineExpose({
exportJson,
exportSql,
exportXlsx,
openXlsx,
exportTxt,
defaultCopyPreference: selectedCopyPreference,
defaultCopyPreferenceLabel,
@@ -12355,7 +12367,22 @@ const gridContextMenuItems = computed<ContextMenuItem[]>(() => {
},
},
}),
[exportSubmenu()],
[
exportSubmenu(),
...(isTauriRuntime()
? [
{
label: t("tableToolbox.openWith"),
icon: ExternalLink,
children: [
{ label: t("tableToolbox.openXlsx"), icon: FileSpreadsheet, action: openSelectedRowsXlsx },
{ label: t("tableToolbox.browserFiltered"), icon: Globe2, action: () => openBrowser(undefined) },
{ label: t("tableToolbox.browserSelected"), icon: Globe2, disabled: !hasRowSelection.value, action: () => openBrowser(affectedRowIds()) },
],
},
]
: []),
],
previewItems,
// 右键刷新:与工具栏刷新按钮/Mod+R 走同一个 onToolbarRefresh,方便
// 习惯 Navicat 等工具在数据页右键刷新的用户(#7273)。
@@ -221,6 +221,7 @@ type DataGridHandle = DataGridColumnLayoutHandle & {
exportJson: () => Promise<void>;
exportSql: () => Promise<void>;
exportXlsx: () => Promise<void>;
openXlsx: () => Promise<void>;
};
type SearchableBrowserHandle = {
@@ -15,6 +15,8 @@ vi.mock("@tauri-apps/plugin-dialog", () => ({
vi.mock("@/lib/backend/api", () => ({
startQueryResultExport: vi.fn(),
cancelQueryResultExport: vi.fn(),
createQueryResultTempFile: vi.fn().mockResolvedValue("/tmp/dbx-query-results/result.xlsx"),
openQueryResultTempFile: vi.fn(),
}));
vi.mock("@/composables/useToast", () => ({
@@ -167,3 +169,21 @@ describe("query result SQL export progress", () => {
expect(api.startQueryResultExport).toHaveBeenCalledWith(expect.objectContaining({ format: "json", sql: "SELECT id, name FROM users" }), expect.any(Function));
});
});
describe("open query result as XLSX", () => {
afterEach(() => vi.unstubAllGlobals());
it.each(["Done", "Cancelled"] as const)("only opens a completed export (%s)", async (status) => {
vi.clearAllMocks();
vi.stubGlobal("document", undefined);
vi.mocked(api.startQueryResultExport).mockImplementation(async (request, onProgress) => {
const progress = { exportId: request.exportId, tableName: "", rowsExported: 1, totalRows: 1, status, errorMessage: null };
onProgress(progress);
return progress;
});
await useDataGridExport(createOptions()).openXlsx();
expect(api.startQueryResultExport).toHaveBeenCalledWith(expect.objectContaining({ format: "xlsx", filePath: "/tmp/dbx-query-results/result.xlsx" }), expect.any(Function));
if (status === "Done") expect(api.openQueryResultTempFile).toHaveBeenCalledWith("/tmp/dbx-query-results/result.xlsx");
else expect(api.openQueryResultTempFile).not.toHaveBeenCalled();
});
});
@@ -1063,22 +1063,26 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
});
}
async function exportHtml(rowIds?: number[]) {
async function exportHtml(rowIds?: number[], openAfterExport = false) {
await runExclusiveExport(async () => {
try {
let outputPath = exportFileName("export", "html");
if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({
defaultPath: outputPath,
filters: [{ name: "HTML", extensions: ["html"] }],
});
if (!path) return;
outputPath = path as string;
if (openAfterExport) outputPath = await api.createQueryResultTempFile("html");
else {
const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({
defaultPath: outputPath,
filters: [{ name: "HTML", extensions: ["html"] }],
});
if (!path) return;
outputPath = path as string;
}
}
const result = await resultToExport(rowIds);
await api.exportQueryResultHtml(outputPath, currentExportTitle(), result.columns, result.rows);
toast(t("grid.exported"));
if (openAfterExport && isTauriRuntime()) await api.openQueryResultTempFile(outputPath);
} catch (e: any) {
toast(t("grid.exportFailed", { message: translateBackendError(t, e) }), 5000);
}
@@ -1120,24 +1124,24 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
});
}
async function exportXlsxResult(rowIds: number[] | undefined, includeSqlSheet: boolean) {
async function exportXlsxResult(rowIds: number[] | undefined, includeSqlSheet: boolean, openAfterExport = false) {
const exportOptions = await showXlsxHeaderDialog();
if (exportOptions === null) return;
await runExclusiveExport(async () => {
try {
if (await exportQueryResultViaBackend("xlsx", rowIds, includeSqlSheet, exportOptions.headerMode, exportOptions.autoFilter)) return;
if (await exportFullTableDataViaBackend("xlsx", rowIds, exportOptions.headerMode, exportOptions.autoFilter)) return;
if (await exportQueryResultViaBackend("xlsx", rowIds, includeSqlSheet, exportOptions.headerMode, exportOptions.autoFilter, undefined, openAfterExport)) return;
if (await exportFullTableDataViaBackend("xlsx", rowIds, exportOptions.headerMode, exportOptions.autoFilter, undefined, openAfterExport)) return;
let outputPath = exportFileName("export", "xlsx");
if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({
defaultPath: outputPath,
filters: [{ name: "Excel", extensions: ["xlsx"] }],
});
if (!path) return;
outputPath = path as string;
if (openAfterExport) outputPath = await api.createQueryResultTempFile("xlsx");
else {
const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ defaultPath: outputPath, filters: [{ name: "Excel", extensions: ["xlsx"] }] });
if (!path) return;
outputPath = path as string;
}
}
const needsFullExport = rowIds === undefined && !!fullExportResult && !hasCompleteLocalResult?.value;
if (needsFullExport && exportProgressDialog && exportProgressState) {
@@ -1190,6 +1194,9 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
};
}
toast(t("grid.exported"));
if (openAfterExport && isTauriRuntime()) {
await api.openQueryResultTempFile(outputPath);
}
} catch (e: any) {
if (exportProgressState) {
exportProgressState.value = {
@@ -1207,6 +1214,14 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
await exportXlsxResult(rowIds, false);
}
async function openXlsx(rowIds?: number[]) {
await exportXlsxResult(rowIds, false, true);
}
async function openBrowser(rowIds?: number[]) {
await exportHtml(rowIds, true);
}
async function exportXlsxWithSql(rowIds?: number[]) {
await exportXlsxResult(rowIds, true);
}
@@ -1322,7 +1337,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
return excludeColumns ? { excludePrimaryKeys: true, primaryKeys: excludeColumns } : {};
}
async function exportFullTableDataViaBackend(format: "csv" | "xlsx" | "json" | "markdown" | "sql" | "txt", rowIds?: number[], headerMode: XlsxHeaderMode = "name", autoFilter = true, sqlExportOptions?: SqlExportOptions): Promise<boolean> {
async function exportFullTableDataViaBackend(format: "csv" | "xlsx" | "json" | "markdown" | "sql" | "txt", rowIds?: number[], headerMode: XlsxHeaderMode = "name", autoFilter = true, sqlExportOptions?: SqlExportOptions, openAfterExport = false): Promise<boolean> {
const meta = tableMeta.value;
// The backend table exporter currently builds two-part table names. External
// Doris/StarRocks catalogs need the data-tab paginator's three-part SQL.
@@ -1335,7 +1350,9 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
const extension = splitSqlOutput ? "zip" : (fmt?.ext ?? format);
const filterName = splitSqlOutput ? "ZIP" : (fmt?.label ?? format.toUpperCase());
let outputPath = exportFileName(meta.tableName || "export", extension, { preferFallback: true });
if (isTauriRuntime()) {
if (openAfterExport && isTauriRuntime()) {
outputPath = await api.createQueryResultTempFile(extension);
} else if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({
defaultPath: outputPath,
@@ -1424,6 +1441,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
);
if (progress.status === "Done") {
toast(t("grid.exported"));
if (openAfterExport && isTauriRuntime()) await api.openQueryResultTempFile(outputPath);
}
} finally {
if (exportCancelHandler) exportCancelHandler.value = null;
@@ -1433,7 +1451,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
return true;
}
async function exportQueryResultViaBackend(format: "csv" | "xlsx" | "json" | "txt" | "sql", rowIds?: number[], includeSqlSheet = false, headerMode: XlsxHeaderMode = "name", autoFilter = true, sqlExportOptions?: SqlExportOptions): Promise<boolean> {
async function exportQueryResultViaBackend(format: "csv" | "xlsx" | "json" | "txt" | "sql", rowIds?: number[], includeSqlSheet = false, headerMode: XlsxHeaderMode = "name", autoFilter = true, sqlExportOptions?: SqlExportOptions, openAfterExport = false): Promise<boolean> {
if (rowIds !== undefined || context.value !== "results" || !queryResultExportRequest) {
return false;
}
@@ -1447,13 +1465,13 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
const filterName = fmt?.label ?? format.toUpperCase();
let outputPath = exportFileName("query-result", extension);
if (isTauriRuntime()) {
const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({
defaultPath: outputPath,
filters: [{ name: filterName, extensions: [extension] }],
});
if (!path) return true;
outputPath = path as string;
if (openAfterExport) outputPath = await api.createQueryResultTempFile(extension);
else {
const { save } = await import("@tauri-apps/plugin-dialog");
const path = await save({ defaultPath: outputPath, filters: [{ name: filterName, extensions: [extension] }] });
if (!path) return true;
outputPath = path as string;
}
}
const exportId = uuid();
@@ -1523,6 +1541,9 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
});
if (terminalProgress.status === "Done") {
toast(t("grid.exported"));
if (openAfterExport && isTauriRuntime()) {
await api.openQueryResultTempFile(outputPath);
}
}
} catch (error) {
const errorMessage = error instanceof Error ? error.message : String(error);
@@ -1778,6 +1799,8 @@ export function useDataGridExport(options: UseDataGridExportOptions) {
exportTxt,
exportCurrentPageTxt,
exportXlsx,
openXlsx,
openBrowser,
exportXlsxWithSql,
exportCurrentPageXlsx,
exportCurrentPageXlsxWithSql,
+5
View File
@@ -7336,6 +7336,11 @@ export default {
cancelledLabel: "Cancelled; rows already written remain in the table",
},
tableToolbox: {
browser: "Web preview",
browserFiltered: "Web preview (current result)",
browserSelected: "Web preview (selected rows)",
openWith: "Open with",
openXlsx: "Open as XLSX",
title: "Data Tools",
generateData: "Generate Data",
importData: "Import Data",
+5
View File
@@ -6659,6 +6659,11 @@ export default withEnglishFallback({
cancelledLabel: "Cancelado; las filas ya insertadas permanecen en la tabla",
},
tableToolbox: {
browser: "Vista previa web",
browserFiltered: "Vista previa web (resultado actual)",
browserSelected: "Vista previa web (filas seleccionadas)",
openWith: "Abrir con",
openXlsx: "Abrir como XLSX",
title: "Herramientas de datos",
generateData: "Generar datos",
importData: "Importar datos",
+5
View File
@@ -6581,6 +6581,11 @@ export default withEnglishFallback({
cancelledLabel: "Annullato; le righe già scritte restano nella tabella",
},
tableToolbox: {
browser: "Anteprima web",
browserFiltered: "Anteprima web (risultato corrente)",
browserSelected: "Anteprima web (righe selezionate)",
openWith: "Apri con",
openXlsx: "Apri come XLSX",
title: "Strumenti dati",
generateData: "Genera dati",
importData: "Importa dati",
+5
View File
@@ -6612,6 +6612,11 @@ export default withEnglishFallback({
cancelledLabel: "キャンセルしました。書き込み済みの行はテーブルに残ります",
},
tableToolbox: {
browser: "ウェブプレビュー",
browserFiltered: "ウェブプレビュー(現在の結果)",
browserSelected: "ウェブプレビュー(選択した行)",
openWith: "アプリで開く",
openXlsx: "XLSXとして開く",
title: "データツール",
generateData: "データを生成",
importData: "データをインポート",
+5
View File
@@ -6313,6 +6313,11 @@ export default withEnglishFallback({
cancelledLabel: "취소되었습니다. 이미 삽입된 행은 테이블에 남습니다",
},
tableToolbox: {
browser: "웹 미리보기",
browserFiltered: "웹 미리보기 (현재 결과)",
browserSelected: "웹 미리보기 (선택한 행)",
openWith: "다음으로 열기",
openXlsx: "XLSX로 열기",
title: "데이터 도구",
generateData: "데이터 생성",
importData: "데이터 가져오기",
+5
View File
@@ -6583,6 +6583,11 @@ export default withEnglishFallback({
cancelledLabel: "Cancelado; as linhas já gravadas permanecem na tabela",
},
tableToolbox: {
browser: "Visualização web",
browserFiltered: "Visualização web (resultado atual)",
browserSelected: "Visualização web (linhas selecionadas)",
openWith: "Abrir com",
openXlsx: "Abrir como XLSX",
title: "Ferramentas de dados",
generateData: "Gerar dados",
importData: "Importar dados",
+5
View File
@@ -7749,6 +7749,11 @@ export default withEnglishFallback({
cancelledLabel: "Отменено; уже записанные строки остаются в таблице",
},
tableToolbox: {
browser: "Веб-просмотр",
browserFiltered: "Веб-просмотр (текущий результат)",
browserSelected: "Веб-просмотр (выбранные строки)",
openWith: "Открыть с помощью",
openXlsx: "Открыть как XLSX",
title: "Инструменты данных",
generateData: "Генерировать данные",
importData: "Импорт данных",
+5
View File
@@ -7303,6 +7303,11 @@ export default withEnglishFallback({
cancelledLabel: "已取消,已写入的行保留在表中",
},
tableToolbox: {
browser: "网页预览",
browserFiltered: "网页预览(当前结果)",
browserSelected: "网页预览(选中行)",
openWith: "打开方式",
openXlsx: "打开为 XLSX",
title: "数据工具",
generateData: "生成数据",
importData: "导入数据",
+5
View File
@@ -5898,6 +5898,11 @@ export default withEnglishFallback({
cancelledLabel: "已取消,已寫入的列保留在表中",
},
tableToolbox: {
browser: "網頁預覽",
browserFiltered: "網頁預覽(目前結果)",
browserSelected: "網頁預覽(選取的列)",
openWith: "開啟方式",
openXlsx: "開啟為 XLSX",
title: "數據工具",
generateData: "產生資料",
importData: "匯入資料",
+2
View File
@@ -578,6 +578,8 @@ export const startTableExport = forward("startTableExport");
export const cancelTableExport = forward("cancelTableExport");
export const startQueryResultExport = forward("startQueryResultExport");
export const cancelQueryResultExport = forward("cancelQueryResultExport");
export const openQueryResultTempFile = forward("openQueryResultTempFile");
export const createQueryResultTempFile = forward("createQueryResultTempFile");
// Redis
export const redisListDatabases = forward("redisListDatabases");
+8
View File
@@ -3427,6 +3427,10 @@ export async function cancelQueryResultExport(exportId: string, executionId?: st
});
}
export async function createQueryResultTempFile(_extension = "xlsx"): Promise<string> {
throw new Error("Opening query results in an external application is only available in the desktop app");
}
export async function exportQueryResultCsv(filePath: string, columns: string[], rows: readonly (readonly XlsxCellValue[])[], csvQuoteMode: CsvQuoteMode = "all", nullLiteral?: string): Promise<void> {
const { formatCsv } = await import("@/lib/export/exportFormats");
const content = formatCsv(columns, rows as (string | number | boolean | null)[][], csvQuoteMode, nullLiteral);
@@ -5468,3 +5472,7 @@ export async function setPluginUiStorage(_pluginId: string, _key: string, _value
export async function deletePluginUiStorage(_pluginId: string, _key: string): Promise<void> {
throw new Error("Plugin UI storage is not available in the web backend");
}
export async function openQueryResultTempFile(_path: string): Promise<void> {
throw new Error("Opening query results requires the desktop app");
}
+8
View File
@@ -6130,6 +6130,10 @@ export async function cancelQueryResultExport(exportId: string, executionId?: st
});
}
export async function createQueryResultTempFile(extension = "xlsx"): Promise<string> {
return invoke("create_query_result_temp_file", { extension });
}
export async function beginDatabaseBackupSnapshot(connectionId: string, database: string, exportId?: string): Promise<DatabaseBackupSnapshot> {
return invoke("begin_database_backup_snapshot", { connectionId, database, exportId: exportId || null });
}
@@ -6267,3 +6271,7 @@ export async function exportQueryResultHtml(filePath: string, title: string | un
export * from "@/lib/backend/mq-tauri";
export * from "@/lib/backend/mqtt-tauri";
export * from "@/lib/backend/nacos-tauri";
export async function openQueryResultTempFile(path: string): Promise<void> {
return invoke("open_query_result_temp_file", { path });
}