ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-01-18 01:25:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

Give saveAsExcel its own config options (#20647)

Browse Source 
Co-authored-by: Ben Russell <russellben@microsoft.com>
This commit is contained in:
Benjamin Russell
2022-10-05 11:40:00 -05:00
committed by GitHub
parent 60c1c8a89f
commit 29daa72ef1
4 changed files with 46 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/sql/workbench/contrib/notebook/browser/outputs/gridOutput.component.ts
View File

@@ -438,7 +438,7 @@ export class DataResourceDataProvider implements IGridDataProvider {
if (!this.canSerialize) {
return Promise.resolve(undefined);
}
// TODO implement selection support
let columns = this._resultSet.columnInfo;
let rowLength = this._rows.length;
let minRow = 0;
@@ -482,13 +482,21 @@ export class DataResourceDataProvider implements IGridDataProvider {
return result;
};
let serializeRequestParams: SerializeDataParams = <SerializeDataParams>Object.assign(serializer.getBasicSaveParameters(format), <Partial<SerializeDataParams>>{
// This code path uses the serialization service which uses a different request parameter
// interface than the query execution service's saveResults handlers. Here, we take the
// format-specific request params (eg, includeHeaders for CSV) and merge the format-agnostic
// request params for the serialization request (eg, saveFormat, filePath).
let formatSpecificParams = serializer.getBasicSaveParameters(format);
let formatAgnosticParams = <Partial<SerializeDataParams>>{
saveFormat: format,
columns: columns,
filePath: filePath.fsPath,
getRowRange: (rowStart, includeHeaders, numberOfRows) => getRows(rowStart, includeHeaders, numberOfRows),
rowCount: rowLength
});
columns: columns,
rowCount: rowLength,
getRowRange: (rowStart: number, includeHeaders: boolean, numberOfRows?: number) =>
getRows(rowStart, includeHeaders, numberOfRows),
};
let serializeRequestParams = <SerializeDataParams>Object.assign(formatSpecificParams, formatAgnosticParams);
return this._serializationService.serializeResults(serializeRequestParams);
}

5
src/sql/workbench/contrib/query/browser/query.contribution.ts
View File

@@ -374,6 +374,11 @@ const queryEditorConfiguration: IConfigurationNode = {
'description': localize('queryEditor.results.saveAsCsv.textIdentifier', "Character used for enclosing text fields when saving results as CSV"),
'default': '\"'
},
'queryEditor.results.saveAsExcel.includeHeaders': {
'type': 'boolean',
'description': localize('queryEditor.results.saveAsExcel.includeHeaders', "When true, column headers are included when saving results as an Excel file"),
'default': true
},
'queryEditor.results.saveAsCsv.encoding': {
'type': 'string',
'description': localize('queryEditor.results.saveAsCsv.encoding', "File encoding used when saving results as CSV"),

37
src/sql/workbench/services/query/common/resultSerializer.ts
View File

@@ -191,6 +191,7 @@ export class ResultSerializer {
// get save results config from vscode config
let saveConfig = this._configurationService.getValue<IQueryEditorConfiguration>('queryEditor').results.saveAsCsv;
// if user entered config, set options
if (saveConfig) {
if (saveConfig.includeHeaders !== undefined) {
@@ -215,21 +216,23 @@ export class ResultSerializer {
private getConfigForJson(): SaveResultsRequestParams {
// JSON does not currently have special conditions
let saveResultsParams = <SaveResultsRequestParams>{ resultFormat: SaveFormat.JSON as string };
return saveResultsParams;
return <SaveResultsRequestParams>{ resultFormat: SaveFormat.JSON as string };
}
private getConfigForExcel(): SaveResultsRequestParams {
// get save results config from vscode config
// Note: we are currently using the configSaveAsCsv setting since it has the option mssql.saveAsCsv.includeHeaders
// and we want to have just 1 setting that lists this.
let config = this.getConfigForCsv();
config.resultFormat = SaveFormat.EXCEL;
config.delimiter = undefined;
config.lineSeperator = undefined;
config.textIdentifier = undefined;
config.encoding = undefined;
return config;
let saveResultsParams = <SaveResultsRequestParams>{ resultFormat: SaveFormat.EXCEL as string };
// Get save results config from vscode config
let saveConfig = this._configurationService.getValue<IQueryEditorConfiguration>('queryEditor').results.saveAsExcel;
// If user entered config, set options
if (saveConfig) {
if (saveConfig.includeHeaders !== undefined) {
saveResultsParams.includeHeaders = saveConfig.includeHeaders;
}
}
return saveResultsParams;
}
private getConfigForXml(): SaveResultsRequestParams {
@@ -237,6 +240,7 @@ export class ResultSerializer {
// get save results config from vscode config
let saveConfig = this._configurationService.getValue<IQueryEditorConfiguration>('queryEditor').results.saveAsXml;
// if user entered config, set options
if (saveConfig) {
if (saveConfig.formatted !== undefined) {
@@ -251,7 +255,14 @@ export class ResultSerializer {
}
private getParameters(uri: string, filePath: URI, batchIndex: number, resultSetNo: number, format: string, selection?: Slick.Range): SaveResultsRequestParams {
private getParameters(
uri: string,
filePath: URI,
batchIndex: number,
resultSetNo: number,
format: string,
selection?: Slick.Range
): SaveResultsRequestParams {
let saveResultsParams = this.getBasicSaveParameters(format);
saveResultsParams.filePath = filePath.fsPath;
saveResultsParams.ownerUri = uri;