diff --git a/apps/desktop/src/components/grid/DataGrid.vue b/apps/desktop/src/components/grid/DataGrid.vue index 6eeb350730..8b823e205e 100644 --- a/apps/desktop/src/components/grid/DataGrid.vue +++ b/apps/desktop/src/components/grid/DataGrid.vue @@ -295,10 +295,11 @@ interface DataGridProps { totalRowCountLoading?: boolean; loading?: boolean; cacheKey?: string; + exportSql?: string; onExecuteSql?: (sql: string) => Promise; fullExportResult?: (onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => Promise; - queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" | "txt" }) => Promise; - allExportResults?: Array<{ sheetName: string; result: QueryResult }>; + queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" | "txt"; includeSqlSheet?: boolean }) => Promise; + allExportResults?: Array<{ sheetName: string; result: QueryResult; sql?: string }>; exportFileBaseName?: string; customSaveHandler?: import("@/composables/useDataGridEditor").CustomSaveHandler; queryEditabilityReason?: QueryEditabilityReason; @@ -4855,6 +4856,12 @@ function exportSelectedRowsXlsx() { return exportXlsx(rowIds); } +function exportSelectedRowsXlsxWithSql() { + const rowIds = affectedRowIds(); + if (rowIds.length === 0) return; + return exportXlsxWithSql(rowIds); +} + function exportSelectedRowsJson() { const rowIds = affectedRowIds(); if (rowIds.length === 0) return; @@ -6553,8 +6560,11 @@ const { exportMarkdown, exportCurrentPageMarkdown, exportXlsx, + exportXlsxWithSql, exportCurrentPageXlsx, + exportCurrentPageXlsxWithSql, exportAllResultsXlsx, + exportAllResultsXlsxWithSql, exportSql, exportCurrentPageSql, exportTxt, @@ -6564,6 +6574,7 @@ const { columns: visibleColumns, displayItems: visibleDisplayItems, sql: computed(() => props.sql), + exportSql: computed(() => props.exportSql), tableMeta: computed(() => (props.tableMeta ? { ...props.tableMeta } : undefined)), copyInsertTargetLabel: computed(() => props.tableMeta?.tableName ?? props.customSaveHandler?.targetLabel), databaseType: computed(() => props.databaseType), @@ -6606,11 +6617,13 @@ const pageSizeMenuItems = computed(() => const exportMenuItems = computed(() => { const hasFullResultExport = !!props.fullExportResult; - const allResultItems = (props.allExportResults?.length ?? 0) > 1 ? [{ value: "all-results-xlsx", label: t("grid.exportAllResultsXlsx"), separatorBefore: true }] : []; + const canIncludeSql = props.context === "results" && !!(props.exportSql || props.sql)?.trim(); + const allResultItems = (props.allExportResults?.length ?? 0) > 1 ? [{ value: "all-results-xlsx", label: t("grid.exportAllResultsXlsx"), separatorBefore: true }, ...(canIncludeSql ? [{ value: "all-results-xlsx-with-sql", label: t("grid.exportAllResultsXlsxWithSql") }] : [])] : []; const selectedItems = isMultiRow.value ? [ { value: "selected-csv", label: t("grid.exportSelectedRowsCsv"), separatorBefore: true }, { value: "selected-xlsx", label: t("grid.exportSelectedRowsXlsx") }, + ...(canIncludeSql ? [{ value: "selected-xlsx-with-sql", label: t("grid.exportSelectedRowsXlsxWithSql") }] : []), { value: "selected-json", label: t("grid.exportSelectedRowsJson") }, { value: "selected-markdown", label: t("grid.exportSelectedRowsMarkdown") }, { value: "selected-sql", label: t("grid.exportSelectedRowsSql") }, @@ -6622,6 +6635,7 @@ const exportMenuItems = computed(() => { return [ { value: "csv", label: t("grid.exportCsv") }, { value: "xlsx", label: t("grid.exportXlsx") }, + ...(canIncludeSql ? [{ value: "xlsx-with-sql", label: t("grid.exportXlsxWithSql") }] : []), { value: "json", label: t("grid.exportJson") }, { value: "markdown", label: t("grid.exportMarkdown") }, { value: "sql", label: t("grid.exportSql") }, @@ -6634,12 +6648,14 @@ const exportMenuItems = computed(() => { return [ { value: "page-csv", label: t("grid.exportCurrentPageCsv") }, { value: "page-xlsx", label: t("grid.exportCurrentPageXlsx") }, + ...(canIncludeSql ? [{ value: "page-xlsx-with-sql", label: t("grid.exportCurrentPageXlsxWithSql") }] : []), { value: "page-json", label: t("grid.exportCurrentPageJson") }, { value: "page-markdown", label: t("grid.exportCurrentPageMarkdown") }, { value: "page-sql", label: t("grid.exportCurrentPageSql") }, { value: "page-txt", label: t("grid.exportCurrentPageTxt") }, { value: "csv", label: t("grid.exportCurrentResultCsv"), separatorBefore: true }, { value: "xlsx", label: t("grid.exportCurrentResultXlsx") }, + ...(canIncludeSql ? [{ value: "xlsx-with-sql", label: t("grid.exportCurrentResultXlsxWithSql") }] : []), { value: "json", label: t("grid.exportCurrentResultJson") }, { value: "markdown", label: t("grid.exportCurrentResultMarkdown") }, { value: "sql", label: t("grid.exportCurrentResultSql") }, @@ -6657,19 +6673,23 @@ function selectExportMenuItem(value: string) { const actions: Record void> = { "page-csv": exportCurrentPageCsv, "page-xlsx": exportCurrentPageXlsx, + "page-xlsx-with-sql": exportCurrentPageXlsxWithSql, "page-json": exportCurrentPageJson, "page-markdown": exportCurrentPageMarkdown, "page-sql": exportCurrentPageSql, "page-txt": exportCurrentPageTxt, csv: exportCsv, xlsx: exportXlsx, + "xlsx-with-sql": exportXlsxWithSql, "all-results-xlsx": exportAllResultsXlsx, + "all-results-xlsx-with-sql": exportAllResultsXlsxWithSql, json: exportJson, markdown: exportMarkdown, sql: exportSql, txt: exportTxt, "selected-csv": exportSelectedRowsCsv, "selected-xlsx": exportSelectedRowsXlsx, + "selected-xlsx-with-sql": exportSelectedRowsXlsxWithSql, "selected-json": exportSelectedRowsJson, "selected-markdown": exportSelectedRowsMarkdown, "selected-sql": exportSelectedRowsSql, @@ -8813,11 +8833,15 @@ function exportSubmenu(): ContextMenuItem { { label: t("grid.exportSql"), action: exportSql }, { label: t("grid.exportTxt"), action: exportTxt }, ]; + if (props.context === "results" && !!(props.exportSql || props.sql)?.trim()) { + items.splice(2, 0, { label: t("grid.exportXlsxWithSql"), action: exportXlsxWithSql }); + } if (isMultiRow.value) { items.push( { label: "", separator: true }, { label: t("grid.exportSelectedRowsCsv"), action: exportSelectedRowsCsv }, { label: t("grid.exportSelectedRowsXlsx"), action: exportSelectedRowsXlsx }, + ...(props.context === "results" && !!(props.exportSql || props.sql)?.trim() ? [{ label: t("grid.exportSelectedRowsXlsxWithSql"), action: exportSelectedRowsXlsxWithSql }] : []), { label: t("grid.exportSelectedRowsJson"), action: exportSelectedRowsJson }, { label: t("grid.exportSelectedRowsMarkdown"), action: exportSelectedRowsMarkdown }, { label: t("grid.exportSelectedRowsSql"), action: exportSelectedRowsSql }, diff --git a/apps/desktop/src/components/layout/ContentArea.vue b/apps/desktop/src/components/layout/ContentArea.vue index 087f141ad1..1f60193503 100644 --- a/apps/desktop/src/components/layout/ContentArea.vue +++ b/apps/desktop/src/components/layout/ContentArea.vue @@ -64,7 +64,7 @@ import { useConnectionStore } from "@/stores/connectionStore"; import { TABLE_FONT_SIZE_MAX, TABLE_FONT_SIZE_MIN, useSettingsStore, type DataGridSearchMode } from "@/stores/settingsStore"; import { useToast } from "@/composables/useToast"; import { canCancelQueryExecution, queryExecutionLabelKey } from "@/lib/sql/queryExecutionState"; -import { databaseDisplayNameForTab, executionSummaryItems, resultGridCacheKey, resultRunItems, resultSourceRange, resultSqlForGrid, tabularResultItems } from "@/lib/tabs/tabPresentation"; +import { databaseDisplayNameForTab, executionSummaryItems, queryResultExecutionSql, resultGridCacheKey, resultRunItems, resultSourceRange, resultSqlForGrid, tabularResultItems } from "@/lib/tabs/tabPresentation"; import { defaultQueryResultArchiveFileName } from "@/lib/query/queryResultArchive"; import { saveQueryResultArchiveFile } from "@/lib/query/queryResultArchiveFile"; import { isTableDataEditable } from "@/lib/table/tableEditing"; @@ -320,12 +320,14 @@ const allResultExportSheets = computed(() => tabularResults.value.map((item) => ({ sheetName: item.label || t("tabs.resultN", { n: item.n }), result: item.result, + sql: item.index === props.activeTab.activeResultIndex ? queryResultExecutionSql(props.activeTab) : item.result.sourceStatement, })), ); const resultRuns = computed(() => resultRunItems(props.activeTab)); const activeResultRunItem = computed(() => resultRuns.value.find((run) => run.active)); const activeResultGridCacheKey = computed(() => resultGridCacheKey(props.activeTab)); const activeResultSql = computed(() => resultSqlForGrid(props.activeTab)); +const activeResultExportSql = computed(() => queryResultExecutionSql(props.activeTab)); const activeElasticsearchJsonResponse = computed(() => elasticsearchJsonResponseForResult(activeEffectiveDatabaseType.value, activeResultSql.value, props.activeTab.result)); const resultArchiveExporting = ref(false); const canExportResultArchive = computed(() => props.activeTab.mode === "query" && (!!props.activeTab.result || !!props.activeTab.results?.length || !!props.activeTab.resultRuns?.length)); @@ -1112,6 +1114,7 @@ defineExpose({ focusSearch, refreshData, handleModRTarget, requestQueryEditorExe :sort-mode="activeTab.resultSortMode" :initial-order-by-input="activeTab.orderByInput" :sql="activeResultSql" + :export-sql="activeResultExportSql" :loading="activeTab.isExecuting" :editable="!!activeTab.queryAnalysis || !!mongoQueryResultSaveHandler" :source-columns="activeTab.querySourceColumns" @@ -1133,7 +1136,7 @@ defineExpose({ focusSearch, refreshData, handleModRTarget, requestQueryEditorExe :total-row-count-loading="activeTab.resultTotalRowCountLoading" :on-execute-sql="async (sql: string) => emit('executeSql', sql)" :full-export-result="(onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => queryStore.fetchTabResultForExport(activeTab.id, onProgress)" - :query-result-export-request="(options: { exportId: string; filePath: string; format: 'csv' | 'xlsx' | 'txt' }) => queryStore.buildQueryResultExportRequest(activeTab.id, options)" + :query-result-export-request="(options: { exportId: string; filePath: string; format: 'csv' | 'xlsx' | 'txt'; includeSqlSheet?: boolean }) => queryStore.buildQueryResultExportRequest(activeTab.id, options)" :all-export-results="allResultExportSheets" :export-file-base-name="activeTab.title" @update:order-by-input="(v: string) => (activeTab.orderByInput = v)" diff --git a/apps/desktop/src/composables/useDataGridExport.ts b/apps/desktop/src/composables/useDataGridExport.ts index fdc66729b7..3e39f4cac9 100644 --- a/apps/desktop/src/composables/useDataGridExport.ts +++ b/apps/desktop/src/composables/useDataGridExport.ts @@ -16,6 +16,7 @@ import { buildMongoCopyDocumentFromOriginal, buildMongoCopyInsertDocument, forma import type { DatabaseType, QueryResult } from "@/types/database"; import type { QueryResultExportRequest } from "@/lib/backend/api"; import { DBX_ROWID_COLUMN } from "@/lib/table/tableEditing"; +import { buildXlsxSqlWorksheet } from "@/lib/export/xlsxSqlSheet"; /** * Format metadata for backend table exports. Each entry maps a format key @@ -51,6 +52,7 @@ export interface UseDataGridExportOptions { columns: ComputedRef; displayItems: ComputedRef; sql: ComputedRef; + exportSql?: ComputedRef; tableMeta: ComputedRef; copyInsertTargetLabel?: ComputedRef; databaseType: ComputedRef; @@ -71,7 +73,7 @@ export interface UseDataGridExportOptions { selectedRowIds: Ref> | ComputedRef>; hasRowSelection: ComputedRef; fullExportResult?: (onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => Promise; - queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" | "txt" }) => Promise; + queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" | "txt"; includeSqlSheet?: boolean }) => Promise; /** * True when the in-memory result already holds the complete result set — * i.e. the query ran without server-side pagination, was not truncated, and @@ -89,7 +91,7 @@ export interface UseDataGridExportOptions { * silently change what "export all data" produces. */ completeLocalResult?: ComputedRef; - allExportResults?: ComputedRef | undefined>; + allExportResults?: ComputedRef | undefined>; currentResultLabel?: ComputedRef; exportFileBaseName?: ComputedRef; exportProgressDialog?: Ref; @@ -152,6 +154,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) { columns, displayItems, sql, + exportSql: resultExportSql, tableMeta, copyInsertTargetLabel, sourceColumns, @@ -221,6 +224,27 @@ export function useDataGridExport(options: UseDataGridExportOptions) { return currentResultLabel?.value || tableMeta.value?.tableName || "Export"; } + function currentExportSql(): string | undefined { + return resultExportSql?.value || sql.value; + } + + async function writeXlsxResult(outputPath: string, result: { columns: string[]; columnTypes: string[]; rows: CellValue[][] }, includeSqlSheet: boolean) { + const sqlWorksheet = includeSqlSheet ? buildXlsxSqlWorksheet([{ sql: currentExportSql() || "" }]) : undefined; + if (!sqlWorksheet) { + await api.exportQueryResultXlsx(outputPath, currentXlsxSheetName(), result.columns, result.columnTypes, result.rows); + return; + } + await api.exportQueryResultsXlsx(outputPath, [ + { + sheetName: currentXlsxSheetName(), + columns: result.columns, + columnTypes: result.columnTypes, + rows: result.rows, + }, + sqlWorksheet, + ]); + } + function targetedRows(): RowItem[] { if (hasRowSelection.value && selectedRowIds.value.size > 0) { return displayItems.value.filter((item) => selectedRowIds.value.has(item.id) && !item.isDraft); @@ -870,10 +894,10 @@ export function useDataGridExport(options: UseDataGridExportOptions) { }); } - async function exportXlsx(rowIds?: number[]) { + async function exportXlsxResult(rowIds: number[] | undefined, includeSqlSheet: boolean) { await runExclusiveExport(async () => { try { - if (await exportQueryResultViaBackend("xlsx", rowIds)) return; + if (await exportQueryResultViaBackend("xlsx", rowIds, includeSqlSheet)) return; if (await exportFullTableDataViaBackend("xlsx", rowIds)) return; let outputPath = exportFileName("export", "xlsx"); @@ -917,7 +941,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) { totalRows: result.rows.length, }; } - await api.exportQueryResultXlsx(outputPath, currentXlsxSheetName(), result.columns, result.columnTypes, result.rows); + await writeXlsxResult(outputPath, result, includeSqlSheet); if (needsFullExport && exportProgressState) { exportProgressState.value = { ...exportProgressState.value, @@ -940,7 +964,15 @@ export function useDataGridExport(options: UseDataGridExportOptions) { }); } - async function exportCurrentPageXlsx() { + async function exportXlsx(rowIds?: number[]) { + await exportXlsxResult(rowIds, false); + } + + async function exportXlsxWithSql(rowIds?: number[]) { + await exportXlsxResult(rowIds, true); + } + + async function exportCurrentPageXlsxResult(includeSqlSheet: boolean) { await runExclusiveExport(async () => { try { let outputPath = exportFileName("export-page", "xlsx", { page: true }); @@ -954,7 +986,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) { outputPath = path as string; } const result = await resultToExport(undefined, undefined, false); - await api.exportQueryResultXlsx(outputPath, currentXlsxSheetName(), result.columns, result.columnTypes, result.rows); + await writeXlsxResult(outputPath, result, includeSqlSheet); toast(t("grid.exported")); } catch (e: any) { toast(t("grid.exportFailed", { message: e?.message || String(e) }), 5000); @@ -962,7 +994,15 @@ export function useDataGridExport(options: UseDataGridExportOptions) { }); } - async function exportAllResultsXlsx() { + async function exportCurrentPageXlsx() { + await exportCurrentPageXlsxResult(false); + } + + async function exportCurrentPageXlsxWithSql() { + await exportCurrentPageXlsxResult(true); + } + + async function exportAllResultsXlsxResult(includeSqlSheet: boolean) { await runExclusiveExport(async () => { try { const sheets = (allExportResults?.value ?? []).filter((sheet) => sheet.result.columns.length > 0); @@ -979,15 +1019,14 @@ export function useDataGridExport(options: UseDataGridExportOptions) { outputPath = path as string; } - await api.exportQueryResultsXlsx( - outputPath, - sheets.map((sheet) => ({ - sheetName: sheet.sheetName, - columns: sheet.result.columns, - columnTypes: sheet.result.column_types ?? [], - rows: sheet.result.rows, - })), - ); + const worksheets = sheets.map((sheet) => ({ + sheetName: sheet.sheetName, + columns: sheet.result.columns, + columnTypes: sheet.result.column_types ?? [], + rows: sheet.result.rows, + })); + const sqlWorksheet = includeSqlSheet ? buildXlsxSqlWorksheet(sheets.map((sheet) => ({ resultName: sheet.sheetName, sql: sheet.sql || sheet.result.sourceStatement || "" }))) : undefined; + await api.exportQueryResultsXlsx(outputPath, sqlWorksheet ? [...worksheets, sqlWorksheet] : worksheets); toast(t("grid.exported")); } catch (e: any) { toast(t("grid.exportFailed", { message: e?.message || String(e) }), 5000); @@ -995,6 +1034,14 @@ export function useDataGridExport(options: UseDataGridExportOptions) { }); } + async function exportAllResultsXlsx() { + await exportAllResultsXlsxResult(false); + } + + async function exportAllResultsXlsxWithSql() { + await exportAllResultsXlsxResult(true); + } + async function exportFullTableDataViaBackend(format: "csv" | "xlsx" | "json" | "markdown" | "sql" | "txt", rowIds?: number[]): Promise { const meta = tableMeta.value; // The backend table exporter currently builds two-part table names. External @@ -1078,7 +1125,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) { return true; } - async function exportQueryResultViaBackend(format: "csv" | "xlsx" | "txt", rowIds?: number[]): Promise { + async function exportQueryResultViaBackend(format: "csv" | "xlsx" | "txt", rowIds?: number[], includeSqlSheet = false): Promise { if (rowIds !== undefined || context.value !== "results" || !queryResultExportRequest) { return false; } @@ -1101,7 +1148,7 @@ export function useDataGridExport(options: UseDataGridExportOptions) { } const exportId = uuid(); - const request = await queryResultExportRequest({ exportId, filePath: outputPath, format }); + const request = await queryResultExportRequest({ exportId, filePath: outputPath, format, includeSqlSheet }); if (!request) throw new Error("Unable to build query result export request"); if (exportProgressState) { @@ -1246,8 +1293,11 @@ export function useDataGridExport(options: UseDataGridExportOptions) { exportTxt, exportCurrentPageTxt, exportXlsx, + exportXlsxWithSql, exportCurrentPageXlsx, + exportCurrentPageXlsxWithSql, exportAllResultsXlsx, + exportAllResultsXlsxWithSql, exportSql, exportCurrentPageSql, copySql, diff --git a/apps/desktop/src/i18n/locales/en.ts b/apps/desktop/src/i18n/locales/en.ts index a83f700a05..4a8ca188ef 100644 --- a/apps/desktop/src/i18n/locales/en.ts +++ b/apps/desktop/src/i18n/locales/en.ts @@ -726,25 +726,30 @@ export default { export: "Export", exportCsv: "Export CSV", exportXlsx: "Export XLSX", + exportXlsxWithSql: "Export XLSX with SQL", exportCurrentPageCsv: "Export Current Page as CSV", exportCurrentPageXlsx: "Export Current Page as XLSX", + exportCurrentPageXlsxWithSql: "Export Current Page as XLSX with SQL", exportCurrentPageJson: "Export Current Page as JSON", exportCurrentPageMarkdown: "Export Current Page as Markdown", exportCurrentPageSql: "Export Current Page as SQL INSERT", exportCurrentPageTxt: "Export Current Page as TXT", exportCurrentResultCsv: "Export Current Result Set All Data as CSV", exportCurrentResultXlsx: "Export Current Result Set All Data as XLSX", + exportCurrentResultXlsxWithSql: "Export Current Result Set All Data as XLSX with SQL", exportCurrentResultJson: "Export Current Result Set All Data as JSON", exportCurrentResultMarkdown: "Export Current Result Set All Data as Markdown", exportCurrentResultSql: "Export Current Result Set All Data as SQL INSERT", exportCurrentResultTxt: "Export Current Result Set All Data as TXT", exportAllResultsXlsx: "Export This Run's All Result Sets as XLSX", + exportAllResultsXlsxWithSql: "Export This Run's All Result Sets as XLSX with SQL", exportJson: "Export JSON", exportMarkdown: "Export Markdown", exportSql: "Export SQL INSERT", exportTxt: "Export TXT", exportSelectedRowsCsv: "Export Selected Rows as CSV", exportSelectedRowsXlsx: "Export Selected Rows as XLSX", + exportSelectedRowsXlsxWithSql: "Export Selected Rows as XLSX with SQL", exportSelectedRowsJson: "Export Selected Rows as JSON", exportSelectedRowsMarkdown: "Export Selected Rows as Markdown", exportSelectedRowsSql: "Export Selected Rows as SQL INSERT", diff --git a/apps/desktop/src/i18n/locales/es.ts b/apps/desktop/src/i18n/locales/es.ts index b1373e64c9..6a273d278d 100644 --- a/apps/desktop/src/i18n/locales/es.ts +++ b/apps/desktop/src/i18n/locales/es.ts @@ -675,25 +675,30 @@ export default withEnglishFallback({ export: "Exportar", exportCsv: "Exportar CSV", exportXlsx: "Exportar XLSX", + exportXlsxWithSql: "Exportar XLSX con SQL", exportCurrentPageCsv: "Exportar página actual como CSV", exportCurrentPageXlsx: "Exportar página actual como XLSX", + exportCurrentPageXlsxWithSql: "Exportar página actual como XLSX con SQL", exportCurrentPageJson: "Exportar página actual como JSON", exportCurrentPageMarkdown: "Exportar página actual como Markdown", exportCurrentPageSql: "Exportar página actual como SQL INSERT", exportCurrentPageTxt: "Exportar página actual como TXT", exportCurrentResultCsv: "Exportar todos los datos del resultado actual como CSV", exportCurrentResultXlsx: "Exportar todos los datos del resultado actual como XLSX", + exportCurrentResultXlsxWithSql: "Exportar todos los datos del resultado actual como XLSX con SQL", exportCurrentResultJson: "Exportar todos los datos del resultado actual como JSON", exportCurrentResultMarkdown: "Exportar todos los datos del resultado actual como Markdown", exportCurrentResultSql: "Exportar todos los datos del resultado actual como SQL INSERT", exportCurrentResultTxt: "Exportar todos los datos del resultado actual como TXT", exportAllResultsXlsx: "Exportar todos los resultados de esta ejecución como XLSX", + exportAllResultsXlsxWithSql: "Exportar todos los resultados de esta ejecución como XLSX con SQL", exportJson: "Exportar JSON", exportMarkdown: "Exportar Markdown", exportSql: "Exportar SQL INSERT", exportTxt: "Exportar TXT", exportSelectedRowsCsv: "Exportar filas seleccionadas como CSV", exportSelectedRowsXlsx: "Exportar filas seleccionadas como XLSX", + exportSelectedRowsXlsxWithSql: "Exportar filas seleccionadas como XLSX con SQL", exportSelectedRowsJson: "Exportar filas seleccionadas como JSON", exportSelectedRowsMarkdown: "Exportar filas seleccionadas como Markdown", exportSelectedRowsSql: "Exportar filas seleccionadas como SQL INSERT", diff --git a/apps/desktop/src/i18n/locales/it.ts b/apps/desktop/src/i18n/locales/it.ts index c8c503b5a0..55f657c00a 100644 --- a/apps/desktop/src/i18n/locales/it.ts +++ b/apps/desktop/src/i18n/locales/it.ts @@ -673,25 +673,30 @@ export default withEnglishFallback({ export: "Esporta", exportCsv: "Esporta CSV", exportXlsx: "Esporta XLSX", + exportXlsxWithSql: "Esporta XLSX con SQL", exportCurrentPageCsv: "Esporta pagina corrente come CSV", exportCurrentPageXlsx: "Esporta pagina corrente come XLSX", + exportCurrentPageXlsxWithSql: "Esporta pagina corrente come XLSX con SQL", exportCurrentPageJson: "Esporta pagina corrente come JSON", exportCurrentPageMarkdown: "Esporta pagina corrente come Markdown", exportCurrentPageSql: "Esporta pagina corrente come SQL INSERT", exportCurrentPageTxt: "Esporta pagina corrente come TXT", exportCurrentResultCsv: "Esporta tutti i dati del risultato corrente come CSV", exportCurrentResultXlsx: "Esporta tutti i dati del risultato corrente come XLSX", + exportCurrentResultXlsxWithSql: "Esporta tutti i dati del risultato corrente come XLSX con SQL", exportCurrentResultJson: "Esporta tutti i dati del risultato corrente come JSON", exportCurrentResultMarkdown: "Esporta tutti i dati del risultato corrente come Markdown", exportCurrentResultSql: "Esporta tutti i dati del risultato corrente come SQL INSERT", exportCurrentResultTxt: "Esporta tutti i dati del risultato corrente come TXT", exportAllResultsXlsx: "Esporta tutti i set di risultati di questa esecuzione come XLSX", + exportAllResultsXlsxWithSql: "Esporta tutti i set di risultati di questa esecuzione come XLSX con SQL", exportJson: "Esporta JSON", exportMarkdown: "Esporta Markdown", exportSql: "Esporta SQL INSERT", exportTxt: "Esporta TXT", exportSelectedRowsCsv: "Esporta Righe Selezionate come CSV", exportSelectedRowsXlsx: "Esporta Righe Selezionate come XLSX", + exportSelectedRowsXlsxWithSql: "Esporta Righe Selezionate come XLSX con SQL", exportSelectedRowsJson: "Esporta Righe Selezionate come JSON", exportSelectedRowsMarkdown: "Esporta Righe Selezionate come Markdown", exportSelectedRowsSql: "Esporta Righe Selezionate come SQL INSERT", diff --git a/apps/desktop/src/i18n/locales/ja.ts b/apps/desktop/src/i18n/locales/ja.ts index 52bb66b6aa..6da6290a47 100644 --- a/apps/desktop/src/i18n/locales/ja.ts +++ b/apps/desktop/src/i18n/locales/ja.ts @@ -672,25 +672,30 @@ export default withEnglishFallback({ export: "エクスポート", exportCsv: "CSVエクスポート", exportXlsx: "XLSXエクスポート", + exportXlsxWithSql: "SQL付きXLSXをエクスポート", exportCurrentPageCsv: "現在のページをCSVでエクスポート", exportCurrentPageXlsx: "現在のページをXLSXでエクスポート", + exportCurrentPageXlsxWithSql: "現在のページをSQL付きXLSXでエクスポート", exportCurrentPageJson: "現在のページをJSONでエクスポート", exportCurrentPageMarkdown: "現在のページをMarkdownでエクスポート", exportCurrentPageSql: "現在のページをSQL INSERTでエクスポート", exportCurrentPageTxt: "現在のページをTXTでエクスポート", exportCurrentResultCsv: "現在の結果セット全データをCSVでエクスポート", exportCurrentResultXlsx: "現在の結果セット全データをXLSXでエクスポート", + exportCurrentResultXlsxWithSql: "現在の結果セット全データをSQL付きXLSXでエクスポート", exportCurrentResultJson: "現在の結果セット全データをJSONでエクスポート", exportCurrentResultMarkdown: "現在の結果セット全データをMarkdownでエクスポート", exportCurrentResultSql: "現在の結果セット全データをSQL INSERTでエクスポート", exportCurrentResultTxt: "現在の結果セット全データをTXTでエクスポート", exportAllResultsXlsx: "今回実行の全結果セットをXLSXでエクスポート", + exportAllResultsXlsxWithSql: "今回実行の全結果セットをSQL付きXLSXでエクスポート", exportJson: "JSONエクスポート", exportMarkdown: "Markdownエクスポート", exportSql: "SQL INSERTエクスポート", exportTxt: "TXTエクスポート", exportSelectedRowsCsv: "選択行をCSVでエクスポート", exportSelectedRowsXlsx: "選択行をXLSXでエクスポート", + exportSelectedRowsXlsxWithSql: "選択行をSQL付きXLSXでエクスポート", exportSelectedRowsJson: "選択行をJSONでエクスポート", exportSelectedRowsMarkdown: "選択行をMarkdownでエクスポート", exportSelectedRowsSql: "選択行をSQL INSERTでエクスポート", diff --git a/apps/desktop/src/i18n/locales/pt-BR.ts b/apps/desktop/src/i18n/locales/pt-BR.ts index ecb162d147..b2e1a88070 100644 --- a/apps/desktop/src/i18n/locales/pt-BR.ts +++ b/apps/desktop/src/i18n/locales/pt-BR.ts @@ -675,25 +675,30 @@ export default withEnglishFallback({ export: "Exportar", exportCsv: "Exportar CSV", exportXlsx: "Exportar XLSX", + exportXlsxWithSql: "Exportar XLSX com SQL", exportCurrentPageCsv: "Exportar página atual como CSV", exportCurrentPageXlsx: "Exportar página atual como XLSX", + exportCurrentPageXlsxWithSql: "Exportar página atual como XLSX com SQL", exportCurrentPageJson: "Exportar página atual como JSON", exportCurrentPageMarkdown: "Exportar página atual como Markdown", exportCurrentPageSql: "Exportar página atual como SQL INSERT", exportCurrentPageTxt: "Exportar página atual como TXT", exportCurrentResultCsv: "Exportar todos os dados do resultado atual como CSV", exportCurrentResultXlsx: "Exportar todos os dados do resultado atual como XLSX", + exportCurrentResultXlsxWithSql: "Exportar todos os dados do resultado atual como XLSX com SQL", exportCurrentResultJson: "Exportar todos os dados do resultado atual como JSON", exportCurrentResultMarkdown: "Exportar todos os dados do resultado atual como Markdown", exportCurrentResultSql: "Exportar todos os dados do resultado atual como SQL INSERT", exportCurrentResultTxt: "Exportar todos os dados do resultado atual como TXT", exportAllResultsXlsx: "Exportar todos os conjuntos de resultados desta execução como XLSX", + exportAllResultsXlsxWithSql: "Exportar todos os conjuntos de resultados desta execução como XLSX com SQL", exportJson: "Exportar JSON", exportMarkdown: "Exportar Markdown", exportSql: "Exportar SQL INSERT", exportTxt: "Exportar TXT", exportSelectedRowsCsv: "Exportar Linhas Selecionadas como CSV", exportSelectedRowsXlsx: "Exportar Linhas Selecionadas como XLSX", + exportSelectedRowsXlsxWithSql: "Exportar Linhas Selecionadas como XLSX com SQL", exportSelectedRowsJson: "Exportar Linhas Selecionadas como JSON", exportSelectedRowsMarkdown: "Exportar Linhas Selecionadas como Markdown", exportSelectedRowsSql: "Exportar Linhas Selecionadas como SQL INSERT", diff --git a/apps/desktop/src/i18n/locales/zh-CN.ts b/apps/desktop/src/i18n/locales/zh-CN.ts index 1c243db319..bd6d11e629 100644 --- a/apps/desktop/src/i18n/locales/zh-CN.ts +++ b/apps/desktop/src/i18n/locales/zh-CN.ts @@ -727,25 +727,30 @@ export default withEnglishFallback({ export: "导出", exportCsv: "导出 CSV", exportXlsx: "导出 XLSX", + exportXlsxWithSql: "导出 XLSX(含 SQL)", exportCurrentPageCsv: "导出当前页 CSV", exportCurrentPageXlsx: "导出当前页 XLSX", + exportCurrentPageXlsxWithSql: "导出当前页 XLSX(含 SQL)", exportCurrentPageJson: "导出当前页 JSON", exportCurrentPageMarkdown: "导出当前页 Markdown", exportCurrentPageSql: "导出当前页 SQL INSERT", exportCurrentPageTxt: "导出当前页 TXT", exportCurrentResultCsv: "导出当前结果集全部数据 CSV", exportCurrentResultXlsx: "导出当前结果集全部数据 XLSX", + exportCurrentResultXlsxWithSql: "导出当前结果集全部数据 XLSX(含 SQL)", exportCurrentResultJson: "导出当前结果集全部数据 JSON", exportCurrentResultMarkdown: "导出当前结果集全部数据 Markdown", exportCurrentResultSql: "导出当前结果集全部数据 SQL INSERT", exportCurrentResultTxt: "导出当前结果集全部数据 TXT", exportAllResultsXlsx: "导出本次执行全部结果集为 XLSX", + exportAllResultsXlsxWithSql: "导出本次执行全部结果集为 XLSX(含 SQL)", exportJson: "导出 JSON", exportMarkdown: "导出 Markdown", exportSql: "导出 SQL INSERT", exportTxt: "导出 TXT", exportSelectedRowsCsv: "导出选中行为 CSV", exportSelectedRowsXlsx: "导出选中行为 XLSX", + exportSelectedRowsXlsxWithSql: "导出选中行为 XLSX(含 SQL)", exportSelectedRowsJson: "导出选中行为 JSON", exportSelectedRowsMarkdown: "导出选中行为 Markdown", exportSelectedRowsSql: "导出选中行为 SQL INSERT", diff --git a/apps/desktop/src/i18n/locales/zh-TW.ts b/apps/desktop/src/i18n/locales/zh-TW.ts index ead172c169..321040aa3c 100644 --- a/apps/desktop/src/i18n/locales/zh-TW.ts +++ b/apps/desktop/src/i18n/locales/zh-TW.ts @@ -674,25 +674,30 @@ export default withEnglishFallback({ export: "匯出", exportCsv: "匯出 CSV", exportXlsx: "匯出 XLSX", + exportXlsxWithSql: "匯出 XLSX(含 SQL)", exportCurrentPageCsv: "匯出目前頁 CSV", exportCurrentPageXlsx: "匯出目前頁 XLSX", + exportCurrentPageXlsxWithSql: "匯出目前頁 XLSX(含 SQL)", exportCurrentPageJson: "匯出目前頁 JSON", exportCurrentPageMarkdown: "匯出目前頁 Markdown", exportCurrentPageSql: "匯出目前頁 SQL INSERT", exportCurrentPageTxt: "匯出目前頁 TXT", exportCurrentResultCsv: "匯出目前結果集全部資料 CSV", exportCurrentResultXlsx: "匯出目前結果集全部資料 XLSX", + exportCurrentResultXlsxWithSql: "匯出目前結果集全部資料 XLSX(含 SQL)", exportCurrentResultJson: "匯出目前結果集全部資料 JSON", exportCurrentResultMarkdown: "匯出目前結果集全部資料 Markdown", exportCurrentResultSql: "匯出目前結果集全部資料 SQL INSERT", exportCurrentResultTxt: "匯出目前結果集全部資料 TXT", exportAllResultsXlsx: "匯出本次執行全部結果集為 XLSX", + exportAllResultsXlsxWithSql: "匯出本次執行全部結果集為 XLSX(含 SQL)", exportJson: "匯出 JSON", exportMarkdown: "匯出 Markdown", exportSql: "匯出 SQL INSERT", exportTxt: "匯出 TXT", exportSelectedRowsCsv: "匯出選取資料列為 CSV", exportSelectedRowsXlsx: "匯出選取資料列為 XLSX", + exportSelectedRowsXlsxWithSql: "匯出選取資料列為 XLSX(含 SQL)", exportSelectedRowsJson: "匯出選取資料列為 JSON", exportSelectedRowsMarkdown: "匯出選取資料列為 Markdown", exportSelectedRowsSql: "匯出選取資料列為 SQL INSERT", diff --git a/apps/desktop/src/lib/backend/http.ts b/apps/desktop/src/lib/backend/http.ts index 6f9aeed05a..cee2a84bb8 100644 --- a/apps/desktop/src/lib/backend/http.ts +++ b/apps/desktop/src/lib/backend/http.ts @@ -1720,7 +1720,7 @@ export async function exportQueryResultXlsx(filePath: string, sheetName: string URL.revokeObjectURL(url); } -export async function exportQueryResultsXlsx(filePath: string, worksheets: readonly { sheetName?: string; columns: string[]; columnTypes?: string[]; rows: readonly (readonly XlsxCellValue[])[] }[]): Promise { +export async function exportQueryResultsXlsx(filePath: string, worksheets: readonly { sheetName?: string; columns: readonly string[]; columnTypes?: readonly string[]; rows: readonly (readonly XlsxCellValue[])[] }[]): Promise { const { buildXlsxWorkbookMulti } = await import("@/lib/export/xlsxExport"); const workbook = buildXlsxWorkbookMulti(worksheets); const fileName = filePath.split(/[\\/]/).pop() || "export.xlsx"; diff --git a/apps/desktop/src/lib/backend/tauri.ts b/apps/desktop/src/lib/backend/tauri.ts index 5243ee56c0..c58b965721 100644 --- a/apps/desktop/src/lib/backend/tauri.ts +++ b/apps/desktop/src/lib/backend/tauri.ts @@ -2279,6 +2279,7 @@ export interface QueryResultExportRequest { useAgentCursor: boolean; filePath: string; format: "csv" | "xlsx" | "txt"; + includeSqlSheet?: boolean; pageSize: number; rowLimit?: number | null; totalRows?: number | null; @@ -2425,7 +2426,7 @@ export async function exportQueryResultXlsx(filePath: string, sheetName: string }); } -export async function exportQueryResultsXlsx(filePath: string, worksheets: readonly { sheetName?: string; columns: string[]; columnTypes?: string[]; rows: readonly (readonly XlsxCellValue[])[] }[]): Promise { +export async function exportQueryResultsXlsx(filePath: string, worksheets: readonly { sheetName?: string; columns: readonly string[]; columnTypes?: readonly string[]; rows: readonly (readonly XlsxCellValue[])[] }[]): Promise { return invoke("export_query_results_xlsx", { request: { filePath, diff --git a/apps/desktop/src/lib/export/xlsxSqlSheet.ts b/apps/desktop/src/lib/export/xlsxSqlSheet.ts new file mode 100644 index 0000000000..9776c5a0ad --- /dev/null +++ b/apps/desktop/src/lib/export/xlsxSqlSheet.ts @@ -0,0 +1,51 @@ +const EXCEL_CELL_CHARACTER_LIMIT = 32_767; + +export interface XlsxSqlStatement { + resultName?: string; + sql: string; +} + +export interface XlsxSqlWorksheet { + sheetName: "SQL"; + columns: string[]; + rows: Array>; +} + +function splitExcelCellText(value: string): string[] { + if (value.length <= EXCEL_CELL_CHARACTER_LIMIT) return [value]; + + const chunks: string[] = []; + let start = 0; + while (start < value.length) { + let end = Math.min(start + EXCEL_CELL_CHARACTER_LIMIT, value.length); + if (end < value.length) { + const lastCodeUnit = value.charCodeAt(end - 1); + const nextCodeUnit = value.charCodeAt(end); + if (lastCodeUnit >= 0xd800 && lastCodeUnit <= 0xdbff && nextCodeUnit >= 0xdc00 && nextCodeUnit <= 0xdfff) { + end -= 1; + } + } + chunks.push(value.slice(start, end)); + start = end; + } + return chunks; +} + +export function buildXlsxSqlWorksheet(statements: readonly XlsxSqlStatement[]): XlsxSqlWorksheet | undefined { + const available = statements.filter((statement) => statement.sql.trim().length > 0); + if (available.length === 0) return undefined; + + if (available.length === 1) { + return { + sheetName: "SQL", + columns: ["SQL"], + rows: splitExcelCellText(available[0].sql).map((sql) => [sql]), + }; + } + + return { + sheetName: "SQL", + columns: ["Result", "SQL"], + rows: available.flatMap((statement, index) => splitExcelCellText(statement.sql).map((sql) => [statement.resultName || `Result ${index + 1}`, sql])), + }; +} diff --git a/apps/desktop/src/stores/queryStore.ts b/apps/desktop/src/stores/queryStore.ts index 8650c814f1..426073d1df 100644 --- a/apps/desktop/src/stores/queryStore.ts +++ b/apps/desktop/src/stores/queryStore.ts @@ -72,6 +72,7 @@ interface BuildQueryResultExportRequestOptions { exportId: string; filePath: string; format: "csv" | "xlsx" | "txt"; + includeSqlSheet?: boolean; } type DroppedTableObjectType = "TABLE" | "VIEW" | "MATERIALIZED_VIEW"; @@ -3844,6 +3845,7 @@ export const useQueryStore = defineStore("query", () => { useAgentCursor, filePath: options.filePath, format: options.format, + includeSqlSheet: options.format === "xlsx" && options.includeSqlSheet === true, pageSize: settings.exportBatchSize, rowLimit, totalRows, diff --git a/crates/dbx-core/src/query_result_export.rs b/crates/dbx-core/src/query_result_export.rs index f2651dca2a..cd168acf21 100644 --- a/crates/dbx-core/src/query_result_export.rs +++ b/crates/dbx-core/src/query_result_export.rs @@ -1,6 +1,6 @@ use serde::{Deserialize, Serialize}; use std::fs::File; -use std::io::{BufWriter, Write}; +use std::io::{BufWriter, Seek, Write}; use std::sync::{ atomic::{AtomicBool, Ordering}, Arc, @@ -21,7 +21,10 @@ use crate::query_result_sql::{ }; use crate::table_export::TableExportProgress; use crate::transfer::keyset_pagination_sql; -use crate::xlsx_export::{finish_streaming_xlsx_workbook, start_streaming_xlsx_workbook}; +use crate::xlsx_export::{ + finish_streaming_xlsx_workbook, start_streaming_xlsx_workbook_with_trailing_sheets, StreamingXlsxWriter, + XlsxWorksheetData, +}; use serde_json::Value; use sqlparser::ast::{GroupByExpr, ObjectNamePart, OrderByKind, SelectItem, SetExpr, Statement, TableFactor}; use sqlparser::dialect::GenericDialect; @@ -34,6 +37,7 @@ const XLSX_ROW_LIMIT_ERROR: &str = "XLSX 最多支持 1,048,575 行数据,请 const STREAMING_PAGINATION_UNSUPPORTED_ERROR: &str = "当前查询暂不支持流式导出,请简化查询或使用受支持的驱动。"; const AGENT_SESSION_MISSING_ERROR: &str = "查询结果流式导出需要驱动返回结果集会话,但当前驱动未返回 session_id。"; const STREAM_PROGRESS_TIME_INTERVAL: Duration = Duration::from_secs(1); +const EXCEL_CELL_CHARACTER_LIMIT: usize = 32_767; async fn disconnect_with_timeout( connection: C, @@ -62,6 +66,8 @@ pub struct QueryResultExportRequest { pub use_agent_cursor: bool, pub file_path: String, pub format: String, + #[serde(default)] + pub include_sql_sheet: bool, pub page_size: usize, #[serde(default, skip_serializing_if = "Option::is_none")] pub row_limit: Option, @@ -77,6 +83,48 @@ pub struct QueryResultExportRequest { pub execution_id: Option, } +fn split_excel_cell_text(value: &str) -> Vec { + let mut chunks = Vec::new(); + let mut current = String::new(); + let mut utf16_len = 0; + for character in value.chars() { + let character_utf16_len = character.len_utf16(); + if utf16_len + character_utf16_len > EXCEL_CELL_CHARACTER_LIMIT { + chunks.push(current); + current = String::new(); + utf16_len = 0; + } + current.push(character); + utf16_len += character_utf16_len; + } + if !current.is_empty() || chunks.is_empty() { + chunks.push(current); + } + chunks +} + +fn query_sql_worksheets(request: &QueryResultExportRequest) -> Vec { + if !request.include_sql_sheet || request.sql.trim().is_empty() { + return Vec::new(); + } + vec![XlsxWorksheetData { + sheet_name: Some("SQL".to_string()), + columns: vec!["SQL".to_string()], + column_types: Vec::new(), + rows: split_excel_cell_text(&request.sql).into_iter().map(|sql| vec![Value::String(sql)]).collect(), + }] +} + +fn start_query_result_xlsx_workbook( + writer: W, + request: &QueryResultExportRequest, + columns: &[String], + column_types: &[String], +) -> Result, String> { + let trailing_sheets = query_sql_worksheets(request); + start_streaming_xlsx_workbook_with_trailing_sheets(writer, Some("Result"), columns, column_types, &trailing_sheets) +} + fn progress( request: &QueryResultExportRequest, rows_exported: u64, @@ -535,9 +583,9 @@ async fn export_query_result_core_inner( if xlsx.is_none() { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - xlsx = Some(start_streaming_xlsx_workbook( + xlsx = Some(start_query_result_xlsx_workbook( BufWriter::new(xlsx_file), - Some("Result"), + request, &columns, &column_types, )?); @@ -601,7 +649,7 @@ async fn export_query_result_core_inner( buf.flush().map_err(|e| format!("Failed to flush XLSX file: {e}"))?; } else { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - let writer = start_streaming_xlsx_workbook(BufWriter::new(xlsx_file), Some("Result"), &columns, &column_types)?; + let writer = start_query_result_xlsx_workbook(BufWriter::new(xlsx_file), request, &columns, &column_types)?; let mut buf = finish_streaming_xlsx_workbook(writer).map_err(|e| format!("Failed to finalize XLSX file: {e}"))?; buf.flush().map_err(|e| format!("Failed to flush XLSX file: {e}"))?; @@ -693,9 +741,9 @@ async fn try_export_postgres_query_result_stream( } else { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - xlsx = Some(start_streaming_xlsx_workbook( + xlsx = Some(start_query_result_xlsx_workbook( BufWriter::new(xlsx_file), - Some("Result"), + request, &columns, &column_types, )?); @@ -713,12 +761,8 @@ async fn try_export_postgres_query_result_stream( } else { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - xlsx = Some(start_streaming_xlsx_workbook( - BufWriter::new(xlsx_file), - Some("Result"), - &columns, - &[], - )?); + xlsx = + Some(start_query_result_xlsx_workbook(BufWriter::new(xlsx_file), request, &columns, &[])?); if let Some(writer) = xlsx.as_mut() { writer.write_row(&row).map_err(|e| format!("Failed to write XLSX row: {e}"))?; } @@ -755,7 +799,7 @@ async fn try_export_postgres_query_result_stream( buf.flush().map_err(|e| format!("Failed to flush XLSX file: {e}"))?; } else if format == "xlsx" { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - let writer = start_streaming_xlsx_workbook(BufWriter::new(xlsx_file), Some("Result"), &columns, &[])?; + let writer = start_query_result_xlsx_workbook(BufWriter::new(xlsx_file), request, &columns, &[])?; let mut buf = finish_streaming_xlsx_workbook(writer).map_err(|e| format!("Failed to finalize XLSX file: {e}"))?; buf.flush().map_err(|e| format!("Failed to flush XLSX file: {e}"))?; @@ -908,9 +952,9 @@ async fn try_export_mysql_query_result_stream( } else { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - xlsx = Some(start_streaming_xlsx_workbook( + xlsx = Some(start_query_result_xlsx_workbook( BufWriter::new(xlsx_file), - Some("Result"), + request, &columns, &column_types, )?); @@ -928,12 +972,8 @@ async fn try_export_mysql_query_result_stream( } else { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - xlsx = Some(start_streaming_xlsx_workbook( - BufWriter::new(xlsx_file), - Some("Result"), - &columns, - &[], - )?); + xlsx = + Some(start_query_result_xlsx_workbook(BufWriter::new(xlsx_file), request, &columns, &[])?); if let Some(writer) = xlsx.as_mut() { writer.write_row(&row).map_err(|e| format!("Failed to write XLSX row: {e}"))?; } @@ -1016,7 +1056,7 @@ async fn try_export_mysql_query_result_stream( buf.flush().map_err(|e| format!("Failed to flush XLSX file: {e}"))?; } else if format == "xlsx" { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - let writer = start_streaming_xlsx_workbook(BufWriter::new(xlsx_file), Some("Result"), &columns, &[])?; + let writer = start_query_result_xlsx_workbook(BufWriter::new(xlsx_file), request, &columns, &[])?; let mut buf = finish_streaming_xlsx_workbook(writer).map_err(|e| format!("Failed to finalize XLSX file: {e}"))?; buf.flush().map_err(|e| format!("Failed to flush XLSX file: {e}"))?; @@ -1108,9 +1148,9 @@ async fn try_export_clickhouse_query_result_stream( } else { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - xlsx = Some(start_streaming_xlsx_workbook( + xlsx = Some(start_query_result_xlsx_workbook( BufWriter::new(xlsx_file), - Some("Result"), + request, &columns, &column_types, )?); @@ -1128,12 +1168,8 @@ async fn try_export_clickhouse_query_result_stream( } else { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - xlsx = Some(start_streaming_xlsx_workbook( - BufWriter::new(xlsx_file), - Some("Result"), - &columns, - &[], - )?); + xlsx = + Some(start_query_result_xlsx_workbook(BufWriter::new(xlsx_file), request, &columns, &[])?); if let Some(writer) = xlsx.as_mut() { writer.write_row(&row).map_err(|e| format!("Failed to write XLSX row: {e}"))?; } @@ -1192,7 +1228,7 @@ async fn try_export_clickhouse_query_result_stream( buf.flush().map_err(|e| format!("Failed to flush XLSX file: {e}"))?; } else if format == "xlsx" { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - let writer = start_streaming_xlsx_workbook(BufWriter::new(xlsx_file), Some("Result"), &columns, &[])?; + let writer = start_query_result_xlsx_workbook(BufWriter::new(xlsx_file), request, &columns, &[])?; let mut buf = finish_streaming_xlsx_workbook(writer).map_err(|e| format!("Failed to finalize XLSX file: {e}"))?; buf.flush().map_err(|e| format!("Failed to flush XLSX file: {e}"))?; @@ -1271,12 +1307,8 @@ async fn try_export_sqlserver_query_result_stream( } else { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - xlsx = Some(start_streaming_xlsx_workbook( - BufWriter::new(xlsx_file), - Some("Result"), - &columns, - &[], - )?); + xlsx = + Some(start_query_result_xlsx_workbook(BufWriter::new(xlsx_file), request, &columns, &[])?); } } crate::db::sqlserver::SqlServerStreamItem::Row(row) => { @@ -1291,12 +1323,8 @@ async fn try_export_sqlserver_query_result_stream( } else { let xlsx_file = File::create(&request.file_path).map_err(|e| format!("Failed to create XLSX file: {e}"))?; - xlsx = Some(start_streaming_xlsx_workbook( - BufWriter::new(xlsx_file), - Some("Result"), - &columns, - &[], - )?); + xlsx = + Some(start_query_result_xlsx_workbook(BufWriter::new(xlsx_file), request, &columns, &[])?); if let Some(writer) = xlsx.as_mut() { writer.write_row(row).map_err(|e| format!("Failed to write XLSX row: {e}"))?; } @@ -1358,6 +1386,7 @@ mod tests { use_agent_cursor: false, file_path: "out.csv".to_string(), format: format.to_string(), + include_sql_sheet: false, page_size: 1000, row_limit, total_rows, @@ -1403,6 +1432,46 @@ mod tests { assert!(req.total_rows.is_some_and(|total| total > XLSX_MAX_DATA_ROWS as u64)); } + #[test] + fn xlsx_sql_sheet_uses_the_effective_export_sql_and_splits_long_cells() { + let mut req = request("xlsx", None, None); + req.include_sql_sheet = true; + req.sql = format!("SELECT '{}'", "x".repeat(EXCEL_CELL_CHARACTER_LIMIT * 2)); + + let worksheets = query_sql_worksheets(&req); + assert_eq!(worksheets.len(), 1); + assert_eq!(worksheets[0].sheet_name.as_deref(), Some("SQL")); + assert_eq!(worksheets[0].columns, ["SQL"]); + assert_eq!(worksheets[0].rows.len(), 3); + assert!(worksheets[0].rows.iter().all(|row| row[0] + .as_str() + .is_some_and(|value| value.encode_utf16().count() <= EXCEL_CELL_CHARACTER_LIMIT))); + assert_eq!(worksheets[0].rows.iter().filter_map(|row| row[0].as_str()).collect::(), req.sql); + } + + #[test] + fn xlsx_sql_sheet_splits_on_utf16_boundaries_without_splitting_surrogate_pairs() { + let mut req = request("xlsx", None, None); + req.include_sql_sheet = true; + let bmp_prefix = "x".repeat(EXCEL_CELL_CHARACTER_LIMIT - 1); + req.sql = format!("{bmp_prefix}😀tail"); + + let worksheets = query_sql_worksheets(&req); + let rows = &worksheets[0].rows; + assert_eq!(rows.len(), 2); + assert_eq!(rows[0][0].as_str(), Some(bmp_prefix.as_str())); + assert_eq!(rows[1][0].as_str(), Some("😀tail")); + assert!(rows.iter().all(|row| row[0] + .as_str() + .is_some_and(|value| value.encode_utf16().count() <= EXCEL_CELL_CHARACTER_LIMIT))); + assert_eq!(rows.iter().filter_map(|row| row[0].as_str()).collect::(), req.sql); + } + + #[test] + fn xlsx_sql_sheet_is_opt_in() { + assert!(query_sql_worksheets(&request("xlsx", None, None)).is_empty()); + } + #[test] fn sqlserver_stream_progress_is_throttled() { assert!(!should_emit_stream_progress(19_999, 0, 20_000, Duration::from_millis(100))); diff --git a/crates/dbx-core/src/xlsx_export.rs b/crates/dbx-core/src/xlsx_export.rs index 30f1ec554b..a58a69bf4a 100644 --- a/crates/dbx-core/src/xlsx_export.rs +++ b/crates/dbx-core/src/xlsx_export.rs @@ -20,6 +20,7 @@ pub struct StreamingXlsxWriter { columns: Vec, column_types: Vec, next_row_number: usize, + trailing_sheets: Vec, } /// Estimate column widths from header names only (used by the streaming path @@ -86,14 +87,32 @@ pub(crate) fn start_streaming_xlsx_workbook( columns: &[String], column_types: &[String], ) -> Result, String> { - let sheet_name = normalize_sheet_name(sheet_name); + start_streaming_xlsx_workbook_with_trailing_sheets(writer, sheet_name, columns, column_types, &[]) +} + +pub(crate) fn start_streaming_xlsx_workbook_with_trailing_sheets( + writer: W, + sheet_name: Option<&str>, + columns: &[String], + column_types: &[String], + trailing_sheets: &[XlsxWorksheetData], +) -> Result, String> { + let primary_sheet = XlsxWorksheetData { + sheet_name: sheet_name.map(str::to_string), + columns: columns.to_vec(), + column_types: column_types.to_vec(), + rows: Vec::new(), + }; + let all_sheets = std::iter::once(primary_sheet).chain(trailing_sheets.iter().cloned()).collect::>(); + let sheet_names = normalize_unique_sheet_names(&all_sheets); + let sheet_count = sheet_names.len(); let widths = estimate_header_widths(columns); let mut zip = zip::ZipWriter::new(writer); - write_zip_entry(&mut zip, "[Content_Types].xml", &content_types_xml())?; + write_zip_entry(&mut zip, "[Content_Types].xml", &content_types_xml_for_sheet_count(sheet_count))?; write_zip_entry(&mut zip, "_rels/.rels", root_rels_xml())?; - write_zip_entry(&mut zip, "xl/workbook.xml", &workbook_xml(&sheet_name))?; - write_zip_entry(&mut zip, "xl/_rels/workbook.xml.rels", &workbook_rels_xml())?; + write_zip_entry(&mut zip, "xl/workbook.xml", &workbook_xml_for_sheets(&sheet_names))?; + write_zip_entry(&mut zip, "xl/_rels/workbook.xml.rels", &workbook_rels_xml_for_sheet_count(sheet_count))?; write_zip_entry(&mut zip, "xl/styles.xml", styles_xml())?; // Begin the sheet1.xml entry with header, frozen pane, column widths and @@ -117,7 +136,13 @@ pub(crate) fn start_streaming_xlsx_workbook( zip.write_all(sheet_header.as_bytes()).map_err(|err| err.to_string())?; zip.write_all(header_row_xml(columns).as_bytes()).map_err(|err| err.to_string())?; - Ok(StreamingXlsxWriter { zip, columns: columns.to_vec(), column_types: column_types.to_vec(), next_row_number: 2 }) + Ok(StreamingXlsxWriter { + zip, + columns: columns.to_vec(), + column_types: column_types.to_vec(), + next_row_number: 2, + trailing_sheets: trailing_sheets.to_vec(), + }) } impl StreamingXlsxWriter { @@ -138,6 +163,12 @@ impl StreamingXlsxWriter { self.zip .write_all(format!("").as_bytes()) .map_err(|err| err.to_string())?; + for (index, sheet) in self.trailing_sheets.iter().enumerate() { + self.zip + .start_file(format!("xl/worksheets/sheet{}.xml", index + 2), xlsx_zip_options()) + .map_err(|err| err.to_string())?; + self.zip.write_all(worksheet_xml(sheet).as_bytes()).map_err(|err| err.to_string())?; + } self.zip.finish().map_err(|err| err.to_string()) } } @@ -386,10 +417,6 @@ fn worksheet_xml(data: &XlsxWorksheetData) -> String { ) } -fn content_types_xml() -> String { - content_types_xml_for_sheet_count(1) -} - fn content_types_xml_for_sheet_count(sheet_count: usize) -> String { let worksheet_overrides = (1..=sheet_count) .map(|index| { @@ -422,10 +449,6 @@ fn root_rels_xml() -> &'static str { ) } -fn workbook_xml(sheet_name: &str) -> String { - workbook_xml_for_sheets(&[sheet_name.to_string()]) -} - fn workbook_xml_for_sheets(sheet_names: &[String]) -> String { let sheets = sheet_names .iter() @@ -446,10 +469,6 @@ fn workbook_xml_for_sheets(sheet_names: &[String]) -> String { ) } -fn workbook_rels_xml() -> String { - workbook_rels_xml_for_sheet_count(1) -} - fn workbook_rels_xml_for_sheet_count(sheet_count: usize) -> String { let worksheet_rels = (1..=sheet_count) .map(|index| { @@ -538,7 +557,10 @@ pub fn build_xlsx_workbook_multi(sheets: &[XlsxWorksheetData]) -> Result #[cfg(test)] mod tests { - use super::{build_xlsx_workbook, build_xlsx_workbook_multi, start_streaming_xlsx_workbook, XlsxWorksheetData}; + use super::{ + build_xlsx_workbook, build_xlsx_workbook_multi, start_streaming_xlsx_workbook, + start_streaming_xlsx_workbook_with_trailing_sheets, XlsxWorksheetData, + }; use calamine::{open_workbook_auto, Reader}; use serde_json::json; use std::fs; @@ -759,4 +781,36 @@ mod tests { assert!(sheet.contains("2800.000000")); let _ = fs::remove_file(&path); } + + #[test] + fn streams_xlsx_rows_with_a_trailing_sql_worksheet() { + let path = std::env::temp_dir().join(format!("dbx-stream-sql-test-{}.xlsx", uuid::Uuid::new_v4())); + { + let file = fs::File::create(&path).expect("create temp xlsx"); + let sql_sheet = XlsxWorksheetData { + sheet_name: Some("SQL".to_string()), + columns: vec!["SQL".to_string()], + column_types: vec![], + rows: vec![vec![json!("SELECT id, name FROM users")]], + }; + let mut writer = start_streaming_xlsx_workbook_with_trailing_sheets( + file, + Some("Result"), + &["id".to_string(), "name".to_string()], + &[], + &[sql_sheet], + ) + .expect("start workbook"); + writer.write_row(&[json!(1), json!("Ada")]).expect("write row"); + drop(writer.finish().expect("finish workbook")); + } + + let mut workbook = open_workbook_auto(&path).expect("open workbook"); + assert_eq!(workbook.sheet_names(), &["Result".to_string(), "SQL".to_string()]); + let result = workbook.worksheet_range("Result").expect("read result worksheet"); + let sql = workbook.worksheet_range("SQL").expect("read sql worksheet"); + assert_eq!(result.get_value((1, 0)), Some(&calamine::Data::Float(1.0))); + assert_eq!(sql.get_value((1, 0)), Some(&calamine::Data::String("SELECT id, name FROM users".to_string()))); + let _ = fs::remove_file(path); + } } diff --git a/crates/dbx-core/tests/live_clickhouse_query_result_export.rs b/crates/dbx-core/tests/live_clickhouse_query_result_export.rs index beb693ae1c..61b6b12760 100644 --- a/crates/dbx-core/tests/live_clickhouse_query_result_export.rs +++ b/crates/dbx-core/tests/live_clickhouse_query_result_export.rs @@ -90,6 +90,7 @@ async fn live_clickhouse_query_result_export_xlsx_streams_random_order_query_onc use_agent_cursor: false, file_path: file_path.to_string_lossy().to_string(), format: "xlsx".to_string(), + include_sql_sheet: false, page_size: 100, row_limit: None, total_rows: Some(2050), diff --git a/crates/dbx-core/tests/live_mysql57.rs b/crates/dbx-core/tests/live_mysql57.rs index 71f073d290..52a634af1b 100644 --- a/crates/dbx-core/tests/live_mysql57.rs +++ b/crates/dbx-core/tests/live_mysql57.rs @@ -157,6 +157,7 @@ async fn live_mysql_query_result_export_xlsx_streams_single_query_without_duplic use_agent_cursor: false, file_path: file_path.to_string_lossy().to_string(), format: "xlsx".to_string(), + include_sql_sheet: false, page_size: 50, row_limit: None, total_rows: Some(250), diff --git a/crates/dbx-core/tests/live_postgres_query_result_export.rs b/crates/dbx-core/tests/live_postgres_query_result_export.rs index 2d1c8c3842..c1223565dd 100644 --- a/crates/dbx-core/tests/live_postgres_query_result_export.rs +++ b/crates/dbx-core/tests/live_postgres_query_result_export.rs @@ -121,6 +121,7 @@ async fn live_postgres_query_result_export_uses_single_streamed_query() { use_agent_cursor: false, file_path: file_path.to_string_lossy().to_string(), format: "csv".to_string(), + include_sql_sheet: false, page_size: 100, row_limit: None, total_rows: None, diff --git a/crates/dbx-core/tests/live_sqlserver_completion.rs b/crates/dbx-core/tests/live_sqlserver_completion.rs index 454b791bf8..7f8333f282 100644 --- a/crates/dbx-core/tests/live_sqlserver_completion.rs +++ b/crates/dbx-core/tests/live_sqlserver_completion.rs @@ -317,6 +317,7 @@ async fn live_sqlserver_query_result_export_streams_cte_query_to_csv() { use_agent_cursor: false, file_path: file_path.to_string_lossy().to_string(), format: "csv".to_string(), + include_sql_sheet: false, page_size: 1, row_limit: None, total_rows: None, diff --git a/packages/app-tests/queryStore.test.ts b/packages/app-tests/queryStore.test.ts index 62d1f8e88e..5ea18633c6 100644 --- a/packages/app-tests/queryStore.test.ts +++ b/packages/app-tests/queryStore.test.ts @@ -3812,6 +3812,7 @@ test("buildQueryResultExportRequest uses sorted SQL and independent row-limit se assert.equal(request?.useAgentCursor, false); assert.equal(request?.filePath, "C:\\tmp\\events.csv"); assert.equal(request?.format, "csv"); + assert.equal(request?.includeSqlSheet, false); assert.equal(request?.pageSize, 2500); assert.equal(request?.rowLimit, null); assert.equal(request?.totalRows, 123456); @@ -3852,10 +3853,12 @@ test("buildQueryResultExportRequest uses exportRowLimit when enabled", async () exportId: "export-2", filePath: "C:\\tmp\\events.xlsx", format: "xlsx", + includeSqlSheet: true, }); assert.equal(request?.pageSize, 2500); assert.equal(request?.rowLimit, 200000); + assert.equal(request?.includeSqlSheet, true); } finally { globalThis.fetch = originalFetch; restoreStorage(); diff --git a/packages/app-tests/useDataGridExport.test.ts b/packages/app-tests/useDataGridExport.test.ts index 77c8407c91..0ef859da84 100644 --- a/packages/app-tests/useDataGridExport.test.ts +++ b/packages/app-tests/useDataGridExport.test.ts @@ -3,6 +3,7 @@ import { computed, ref } from "vue"; import { beforeEach, test, vi } from "vitest"; import { createPinia, setActivePinia } from "pinia"; import { useSettingsStore } from "../../apps/desktop/src/stores/settingsStore.ts"; +import type { QueryResult } from "../../apps/desktop/src/types/database.ts"; const apiMock = vi.hoisted(() => ({ startQueryResultExport: vi.fn(), @@ -47,7 +48,14 @@ function installMemoryStorage() { }; } -function buildExportHarness(options: { currentResultLabel?: string; exportFileBaseName?: string; columnTypes?: Array } = {}) { +function buildExportHarness( + options: { + currentResultLabel?: string; + exportFileBaseName?: string; + columnTypes?: Array; + allExportResults?: Array<{ sheetName: string; result: QueryResult; sql?: string }>; + } = {}, +) { const exportProgressDialog = ref(false); const exportProgressState = ref({ title: "", @@ -62,7 +70,7 @@ function buildExportHarness(options: { currentResultLabel?: string; exportFileBa const fullExportResult = vi.fn(async () => { throw new Error("fullExportResult should not be called for streaming CSV/XLSX query exports"); }); - const queryResultExportRequest = vi.fn(async (options: { exportId: string; filePath: string; format: "csv" | "xlsx" }) => ({ + const queryResultExportRequest = vi.fn(async (options: { exportId: string; filePath: string; format: "csv" | "xlsx" | "txt"; includeSqlSheet?: boolean }) => ({ exportId: options.exportId, connectionId: "conn-1", database: "db", @@ -73,6 +81,7 @@ function buildExportHarness(options: { currentResultLabel?: string; exportFileBa useAgentCursor: false, filePath: options.filePath, format: options.format, + includeSqlSheet: options.includeSqlSheet, pageSize: 1000, rowLimit: 100000, totalRows: 2, @@ -89,6 +98,7 @@ function buildExportHarness(options: { currentResultLabel?: string; exportFileBa { id: 2, data: [2, "Lin"], isNew: false, isDeleted: false, isDirtyCol: [false, false], status: "" }, ]), sql: computed(() => "SELECT * FROM users"), + exportSql: computed(() => "SELECT * FROM users ORDER BY id DESC"), tableMeta: computed(() => undefined), databaseType: computed(() => "postgres"), connectionId: computed(() => "conn-1"), @@ -112,6 +122,7 @@ function buildExportHarness(options: { currentResultLabel?: string; exportFileBa hasRowSelection: computed(() => false), fullExportResult, queryResultExportRequest, + allExportResults: computed(() => options.allExportResults), currentResultLabel: computed(() => options.currentResultLabel), exportFileBaseName: computed(() => options.exportFileBaseName), exportProgressDialog, @@ -738,6 +749,62 @@ test("selected query result XLSX export uses the current source label as the she assert.deepEqual(apiMock.exportQueryResultXlsx.mock.calls[0][4], [[1, "Ada"]]); }); +test("streaming XLSX with SQL marks the backend request as opt in", async () => { + const { composable, queryResultExportRequest } = buildExportHarness(); + + await composable.exportXlsxWithSql(); + + assert.equal(queryResultExportRequest.mock.calls[0][0].includeSqlSheet, true); + assert.equal(apiMock.startQueryResultExport.mock.calls[0][0].includeSqlSheet, true); + assert.equal(apiMock.startQueryResultExport.mock.calls[0][0].sql, "SELECT * FROM users"); + assert.equal(apiMock.exportQueryResultsXlsx.mock.calls.length, 0); +}); + +test("streaming TXT export remains on the backend path without a SQL sheet", async () => { + const { composable, queryResultExportRequest } = buildExportHarness(); + + await composable.exportTxt(); + + assert.equal(queryResultExportRequest.mock.calls[0][0].format, "txt"); + assert.equal(queryResultExportRequest.mock.calls[0][0].includeSqlSheet, false); + assert.equal(apiMock.startQueryResultExport.mock.calls[0][0].format, "txt"); + assert.equal(apiMock.startQueryResultExport.mock.calls[0][0].includeSqlSheet, false); + assert.equal(apiMock.exportQueryResultsXlsx.mock.calls.length, 0); +}); + +test("selected XLSX with SQL uses the effective result SQL in a second worksheet", async () => { + const { composable, queryResultExportRequest } = buildExportHarness({ currentResultLabel: "public.users" }); + + await composable.exportXlsxWithSql([1]); + + assert.equal(queryResultExportRequest.mock.calls.length, 0); + assert.equal(apiMock.exportQueryResultXlsx.mock.calls.length, 0); + assert.equal(apiMock.exportQueryResultsXlsx.mock.calls.length, 1); + const worksheets = apiMock.exportQueryResultsXlsx.mock.calls[0][1]; + assert.equal(worksheets[0].sheetName, "public.users"); + assert.deepEqual(worksheets[0].rows, [[1, "Ada"]]); + assert.equal(worksheets[1].sheetName, "SQL"); + assert.deepEqual(worksheets[1].rows, [["SELECT * FROM users ORDER BY id DESC"]]); +}); + +test("all-results XLSX with SQL maps each result set to its source statement", async () => { + const allExportResults = [ + { sheetName: "Result 1", result: { columns: ["id"], rows: [[1]], affected_rows: 0, execution_time_ms: 1, sourceStatement: "SELECT 1" }, sql: "SELECT 1" }, + { sheetName: "Result 2", result: { columns: ["id"], rows: [[2]], affected_rows: 0, execution_time_ms: 1, sourceStatement: "SELECT 2" }, sql: "SELECT 2 ORDER BY 1" }, + ]; + const { composable } = buildExportHarness({ allExportResults }); + + await composable.exportAllResultsXlsxWithSql(); + + const worksheets = apiMock.exportQueryResultsXlsx.mock.calls[0][1]; + assert.equal(worksheets.length, 3); + assert.equal(worksheets[2].sheetName, "SQL"); + assert.deepEqual(worksheets[2].rows, [ + ["Result 1", "SELECT 1"], + ["Result 2", "SELECT 2 ORDER BY 1"], + ]); +}); + test("cancelled query result CSV export clears the cancel handler without using the in-memory path", async () => { const { composable, fullExportResult, exportProgressState, exportCancelHandler } = buildExportHarness(); apiMock.startQueryResultExport.mockImplementationOnce(async (_request, onProgress) => { diff --git a/packages/app-tests/xlsxExport.test.ts b/packages/app-tests/xlsxExport.test.ts index 13943f4adc..08c563ea94 100644 --- a/packages/app-tests/xlsxExport.test.ts +++ b/packages/app-tests/xlsxExport.test.ts @@ -1,6 +1,7 @@ import { strict as assert } from "node:assert"; import { test } from "vitest"; -import { buildXlsxWorkbook } from "../../apps/desktop/src/lib/export/xlsxExport.ts"; +import { buildXlsxWorkbook, buildXlsxWorkbookMulti } from "../../apps/desktop/src/lib/export/xlsxExport.ts"; +import { buildXlsxSqlWorksheet } from "../../apps/desktop/src/lib/export/xlsxSqlSheet.ts"; test("builds an xlsx workbook zip with worksheet data", () => { const workbook = buildXlsxWorkbook({ @@ -49,3 +50,34 @@ test("writes MySQL 5.7 numeric strings as numeric cells", () => { assert.match(text, /2800\.000000<\/v><\/c>/); assert.match(text, /9007199254740992<\/t><\/is><\/c>/); }); + +test("builds a result workbook with a separate SQL worksheet", () => { + const sqlWorksheet = buildXlsxSqlWorksheet([{ sql: "SELECT id, name FROM users WHERE active = true" }]); + assert.ok(sqlWorksheet); + const workbook = buildXlsxWorkbookMulti([{ sheetName: "Result", columns: ["id", "name"], rows: [[1, "Ada"]] }, sqlWorksheet]); + const text = new TextDecoder().decode(workbook); + + assert.match(text, /name="Result"/); + assert.match(text, /name="SQL"/); + assert.match(text, /xl\/worksheets\/sheet2\.xml/); + assert.match(text, /SELECT id, name FROM users WHERE active = true/); +}); + +test("maps multiple result statements and splits SQL at the Excel cell limit", () => { + const bmpPrefix = "x".repeat(32_766); + const longSql = `${bmpPrefix}😀tail`; + const worksheet = buildXlsxSqlWorksheet([ + { resultName: "Result 1", sql: "SELECT 1" }, + { resultName: "Result 2", sql: longSql }, + ]); + + assert.ok(worksheet); + assert.deepEqual(worksheet.columns, ["Result", "SQL"]); + assert.equal(worksheet.rows.length, 3); + assert.deepEqual(worksheet.rows[0], ["Result 1", "SELECT 1"]); + const longSqlRows = worksheet.rows.slice(1); + assert.ok(longSqlRows.every((row) => String(row[1]).length <= 32_767)); + assert.equal(longSqlRows[0][1], bmpPrefix); + assert.equal(longSqlRows[1][1], "😀tail"); + assert.equal(longSqlRows.map((row) => row[1]).join(""), longSql); +});