ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-01-23 09:35:39 -05:00
Code Issues Packages Projects Releases Wiki Activity

Support Save As CSV/JSON/Excel/XML from Notebooks (#6627)

Browse Source 
Updated existing serialization code so it actually supports serialization. Still needs work to replace the saveAs function when a QueryProvider doesn't support save as, but want to handle in separate PR.
Removed separate MainThread/ExtHostSerializationProvider code as the DataProtocol code is the right place to put this code
Plumbed support through the gridOutputComponent to use the new serialize method in the serialization provider
Refactored the resultSerializer so majority of code can be shared between both implementations (for example file save dialog -> save -> show file on completion)

* Update to latest SQLToolsService release
This commit is contained in:
Kevin Cunnane
2019-08-09 11:37:53 -07:00
committed by GitHub
parent b589abbea5
commit fb7ece006d
20 changed files with 482 additions and 253 deletions
Download Patch File Download Diff File Expand all files Collapse all files

117
src/sql/workbench/parts/query/common/resultSerializer.ts
View File

@@ -29,6 +29,12 @@ import { IFileDialogService } from 'vs/platform/dialogs/common/dialogs';
let prevSavePath: string;
export interface SaveResultsResponse {
succeeded: boolean;
messages: string;
}
interface ICsvConfig {
includeHeaders: boolean;
delimiter: string;
@@ -48,9 +54,6 @@ interface IXmlConfig {
export class ResultSerializer {
public static tempFileCount: number = 1;
private _uri: string;
private _filePath: string;
constructor(
@IOutputService private _outputService: IOutputService,
@IQueryManagementService private _queryManagementService: IQueryManagementService,
@@ -67,12 +70,38 @@ export class ResultSerializer {
*/
public saveResults(uri: string, saveRequest: ISaveRequest): Thenable<void> {
const self = this;
this._uri = uri;
// prompt for filepath
return self.promptForFilepath(saveRequest).then(filePath => {
return this.promptForFilepath(saveRequest.format, uri).then(filePath => {
if (filePath) {
return self.sendRequestToService(filePath, saveRequest.batchIndex, saveRequest.resultSetNumber, saveRequest.format, saveRequest.selection ? saveRequest.selection[0] : undefined);
if (!path.isAbsolute(filePath)) {
filePath = resolveFilePath(uri, filePath, this.rootPath);
}
let saveResultsParams = this.getParameters(uri, filePath, saveRequest.batchIndex, saveRequest.resultSetNumber, saveRequest.format, saveRequest.selection ? saveRequest.selection[0] : undefined);
let sendRequest = () => this.sendSaveRequestToService(saveResultsParams);
return self.doSave(filePath, saveRequest.format, sendRequest);
}
return Promise.resolve(undefined);
});
}
private async sendSaveRequestToService(saveResultsParams: SaveResultsRequestParams): Promise<SaveResultsResponse> {
let result = await this._queryManagementService.saveResults(saveResultsParams);
return {
succeeded: !result.messages,
messages: result.messages
};
}
/**
* Handle save request by getting filename from user and sending request to service
*/
public handleSerialization(uri: string, format: SaveFormat, sendRequest: ((filePath: string) => Promise<SaveResultsResponse>)): Thenable<void> {
const self = this;
return this.promptForFilepath(format, uri).then(filePath => {
if (filePath) {
if (!path.isAbsolute(filePath)) {
filePath = resolveFilePath(uri, filePath, this.rootPath);
}
return self.doSave(filePath, format, () => sendRequest(filePath));
}
return Promise.resolve(undefined);
});
@@ -100,25 +129,26 @@ export class ResultSerializer {
this.outputChannel.append(message);
}
private promptForFilepath(saveRequest: ISaveRequest): Thenable<string> {
let filepathPlaceHolder = prevSavePath ? path.dirname(prevSavePath) : resolveCurrentDirectory(this._uri, this.rootPath);
private promptForFilepath(format: SaveFormat, resourceUri: string): Thenable<string> {
let filepathPlaceHolder = prevSavePath ? path.dirname(prevSavePath) : resolveCurrentDirectory(resourceUri, this.rootPath);
if (filepathPlaceHolder) {
filepathPlaceHolder = path.join(filepathPlaceHolder, this.getResultsDefaultFilename(saveRequest));
filepathPlaceHolder = path.join(filepathPlaceHolder, this.getResultsDefaultFilename(format));
}
return this.fileDialogService.showSaveDialog({
title: nls.localize('resultsSerializer.saveAsFileTitle', "Choose Results File"),
defaultUri: filepathPlaceHolder ? URI.file(filepathPlaceHolder) : undefined,
filters: this.getResultsFileExtension(saveRequest)
filters: this.getResultsFileExtension(format)
}).then(filePath => {
prevSavePath = filePath.fsPath;
return filePath.fsPath;
});
}
private getResultsDefaultFilename(saveRequest: ISaveRequest): string {
private getResultsDefaultFilename(format: SaveFormat): string {
let fileName = 'Results';
switch (saveRequest.format) {
switch (format) {
case SaveFormat.CSV:
fileName = fileName + '.csv';
break;
@@ -137,11 +167,11 @@ export class ResultSerializer {
return fileName;
}
private getResultsFileExtension(saveRequest: ISaveRequest): FileFilter[] {
private getResultsFileExtension(format: SaveFormat): FileFilter[] {
let fileFilters = new Array<FileFilter>();
let fileFilter: { extensions: string[]; name: string } = { extensions: undefined, name: undefined };
switch (saveRequest.format) {
switch (format) {
case SaveFormat.CSV:
fileFilter.name = nls.localize('resultsSerializer.saveAsFileExtensionCSVTitle', "CSV (Comma delimited)");
fileFilter.extensions = ['csv'];
@@ -167,6 +197,22 @@ export class ResultSerializer {
return fileFilters;
}
public getBasicSaveParameters(format: string): SaveResultsRequestParams {
let saveResultsParams: SaveResultsRequestParams;
if (format === SaveFormat.CSV) {
saveResultsParams = this.getConfigForCsv();
} else if (format === SaveFormat.JSON) {
saveResultsParams = this.getConfigForJson();
} else if (format === SaveFormat.EXCEL) {
saveResultsParams = this.getConfigForExcel();
} else if (format === SaveFormat.XML) {
saveResultsParams = this.getConfigForXml();
}
return saveResultsParams;
}
private getConfigForCsv(): SaveResultsRequestParams {
let saveResultsParams = <SaveResultsRequestParams>{ resultFormat: SaveFormat.CSV as string };
@@ -231,26 +277,11 @@ export class ResultSerializer {
return saveResultsParams;
}
private getParameters(filePath: string, batchIndex: number, resultSetNo: number, format: string, selection: Slick.Range): SaveResultsRequestParams {
let saveResultsParams: SaveResultsRequestParams;
if (!path.isAbsolute(filePath)) {
this._filePath = resolveFilePath(this._uri, filePath, this.rootPath);
} else {
this._filePath = filePath;
}
if (format === SaveFormat.CSV) {
saveResultsParams = this.getConfigForCsv();
} else if (format === SaveFormat.JSON) {
saveResultsParams = this.getConfigForJson();
} else if (format === SaveFormat.EXCEL) {
saveResultsParams = this.getConfigForExcel();
} else if (format === SaveFormat.XML) {
saveResultsParams = this.getConfigForXml();
}
saveResultsParams.filePath = this._filePath;
saveResultsParams.ownerUri = this._uri;
private getParameters(uri: string, filePath: string, batchIndex: number, resultSetNo: number, format: string, selection: Slick.Range): SaveResultsRequestParams {
let saveResultsParams = this.getBasicSaveParameters(format);
saveResultsParams.filePath = filePath;
saveResultsParams.ownerUri = uri;
saveResultsParams.resultSetIndex = resultSetNo;
saveResultsParams.batchIndex = batchIndex;
if (this.isSelected(selection)) {
@@ -297,13 +328,13 @@ export class ResultSerializer {
/**
* Send request to sql tools service to save a result set
*/
private sendRequestToService(filePath: string, batchIndex: number, resultSetNo: number, format: string, selection: Slick.Range): Thenable<void> {
let saveResultsParams = this.getParameters(filePath, batchIndex, resultSetNo, format, selection);
private async doSave(filePath: string, format: string, sendRequest: () => Promise<SaveResultsResponse>): Promise<void> {
this.logToOutputChannel(LocalizedConstants.msgSaveStarted + this._filePath);
this.logToOutputChannel(LocalizedConstants.msgSaveStarted + filePath);
// send message to the sqlserverclient for converting results to the requested format and saving to filepath
return this._queryManagementService.saveResults(saveResultsParams).then(result => {
try {
let result = await sendRequest();
if (result.messages) {
this._notificationService.notify({
severity: Severity.Error,
@@ -311,20 +342,20 @@ export class ResultSerializer {
});
this.logToOutputChannel(LocalizedConstants.msgSaveFailed + result.messages);
} else {
this.promptFileSavedNotification(this._filePath);
this.promptFileSavedNotification(filePath);
this.logToOutputChannel(LocalizedConstants.msgSaveSucceeded + filePath);
this.openSavedFile(this._filePath, format);
this.openSavedFile(filePath, format);
}
// TODO telemetry for save results
// Telemetry.sendTelemetryEvent('SavedResults', { 'type': format });
}, error => {
} catch (error) {
this._notificationService.notify({
severity: Severity.Error,
message: LocalizedConstants.msgSaveFailed + error
});
this.logToOutputChannel(LocalizedConstants.msgSaveFailed + error);
});
}
}
/**