feat(export): include query SQL in XLSX
This commit is contained in:
23 files changed
+486
-91
No files matched your search
@@ -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<string[]>;
|
||||
displayItems: ComputedRef<RowItem[]>;
|
||||
sql: ComputedRef<string | undefined>;
|
||||
exportSql?: ComputedRef<string | undefined>;
|
||||
tableMeta: ComputedRef<DataGridTableMeta | undefined>;
|
||||
copyInsertTargetLabel?: ComputedRef<string | undefined>;
|
||||
databaseType: ComputedRef<DatabaseType | undefined>;
|
||||
@@ -71,7 +73,7 @@ export interface UseDataGridExportOptions {
|
||||
selectedRowIds: Ref<Set<number>> | ComputedRef<Set<number>>;
|
||||
hasRowSelection: ComputedRef<boolean>;
|
||||
fullExportResult?: (onProgress?: (info: { rowsExported: number; totalRows: number | null }) => void) => Promise<QueryResult | undefined>;
|
||||
queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" | "txt" }) => Promise<QueryResultExportRequest | undefined>;
|
||||
queryResultExportRequest?: (options: { exportId: string; filePath: string; format: "csv" | "xlsx" | "txt"; includeSqlSheet?: boolean }) => Promise<QueryResultExportRequest | undefined>;
|
||||
/**
|
||||
* 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<QueryResult | undefined>;
|
||||
allExportResults?: ComputedRef<Array<{ sheetName: string; result: QueryResult }> | undefined>;
|
||||
allExportResults?: ComputedRef<Array<{ sheetName: string; result: QueryResult; sql?: string }> | undefined>;
|
||||
currentResultLabel?: ComputedRef<string | undefined>;
|
||||
exportFileBaseName?: ComputedRef<string | undefined>;
|
||||
exportProgressDialog?: Ref<boolean>;
|
||||
@@ -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<boolean> {
|
||||
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<boolean> {
|
||||
async function exportQueryResultViaBackend(format: "csv" | "xlsx" | "txt", rowIds?: number[], includeSqlSheet = false): Promise<boolean> {
|
||||
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,
|
||||
|
||||
Reference in new issue
Block a user