Added Query Plan to results pane

localization/xliff/vscode-mssql.xlf

@@ -1513,6 +1513,9 @@
     <trans-unit id="mssql.enableSqlAuthenticationProvider">
       <source xml:lang="en">Enables use of the Sql Authentication Provider for &apos;Microsoft Entra Id Interactive&apos; authentication mode when user selects &apos;AzureMFA&apos; authentication. This enables Server-side resource endpoint integration when fetching access tokens. This option is only supported for &apos;MSAL&apos; Authentication Library. Please restart Visual Studio Code after changing this option.</source>
     </trans-unit>
+    <trans-unit id="mssql.showExecutionPlanInResults">
+      <source xml:lang="en">Estimated Plan</source>
+    </trans-unit>
     <trans-unit id="mssql.runCurrentStatement">
       <source xml:lang="en">Execute Current Statement</source>
     </trans-unit>

package.json

@@ -319,6 +319,11 @@
           "command": "mssql.changeDatabase",
           "when": "editorLangId == sql",
           "group": "navigation@4"
+        },
+        {
+          "command": "mssql.showExecutionPlanInResults",
+          "when": "editorLangId == sql",
+          "group": "navigation@4"
         }
       ],
       "editor/context": [
@@ -799,6 +804,15 @@
         "command": "mssql.userFeedback",
         "title": "%mssql.userFeedback%",
         "category": "MS SQL"
+      },
+      {
+        "command": "mssql.showExecutionPlanInResults",
+        "title": "%mssql.showExecutionPlanInResults%",
+        "category": "MS SQL",
+        "icon": {
+          "dark": "media/executionPlan_dark.svg",
+          "light": "media/executionPlan_light.svg"
+        }
       }
     ],
     "keybindings": [

package.nls.json

@@ -36,6 +36,7 @@
 "mssql.addAadAccount":"Add Microsoft Entra Account",
 "mssql.removeAadAccount":"Remove Microsoft Entra Account",
 "mssql.clearAzureAccountTokenCache":"Clear Microsoft Entra account token cache",
+"mssql.showExecutionPlanInResults":"Estimated Plan",
 "mssql.rebuildIntelliSenseCache":"Refresh IntelliSense Cache",
 "mssql.logDebugInfo":"[Optional] Log debug output to the VS Code console (Help -> Toggle Developer Tools)",
 "mssql.maxRecentConnections":"The maximum number of recently used connections to store in the connection list.",

src/constants/constants.ts

@@ -79,6 +79,7 @@ export const cmdAzureSignInToCloud = "azure-account.loginToCloud";
 export const cmdAadRemoveAccount = "mssql.removeAadAccount";
 export const cmdAadAddAccount = "mssql.addAadAccount";
 export const cmdClearAzureTokenCache = "mssql.clearAzureAccountTokenCache";
+export const cmdShowExecutionPlanInResults = "mssql.showExecutionPlanInResults";
 export const cmdNewTable = "mssql.newTable";
 export const cmdEditTable = "mssql.editTable";
 export const cmdEditConnection = "mssql.editConnection";

src/controllers/mainController.ts

@@ -58,6 +58,7 @@ import { QueryResultWebviewController } from "../queryResult/queryResultWebViewC
 import { MssqlProtocolHandler } from "../mssqlProtocolHandler";
 import { isIConnectionInfo } from "../utils/utils";
 import { UserSurvey } from "../nps/userSurvey";
+import { ExecutionPlanOptions } from "../models/contracts/queryExecute";
 
 /**
  * The main controller class that initializes the extension
@@ -81,6 +82,10 @@ export default class MainController implements vscode.Disposable {
     private _queryHistoryProvider: QueryHistoryProvider;
     private _scriptingService: ScriptingService;
     private _queryHistoryRegistered: boolean = false;
+    private _executionPlanOptions: ExecutionPlanOptions = {
+        includeEstimatedExecutionPlanXml: false,
+        includeActualExecutionPlanXml: false,
+    };
     public sqlTasksService: SqlTasksService;
     public dacFxService: DacFxService;
     public schemaCompareService: SchemaCompareService;
@@ -186,6 +191,8 @@ export default class MainController implements vscode.Disposable {
             this.registerCommand(Constants.cmdRunQuery);
             this._event.on(Constants.cmdRunQuery, () => {
                 UserSurvey.getInstance().promptUserForNPSFeedback();
+                this._executionPlanOptions.includeEstimatedExecutionPlanXml =
+                    false;
                 this.onRunQuery();
             });
             this.registerCommand(Constants.cmdManageConnectionProfiles);
@@ -255,6 +262,15 @@ export default class MainController implements vscode.Disposable {
             this._event.on(Constants.cmdClearAzureTokenCache, () =>
                 this.onClearAzureTokenCache(),
             );
+            this.registerCommand(Constants.cmdShowExecutionPlanInResults);
+            this._event.on(
+                Constants.cmdShowExecutionPlanInResults,
+                async () => {
+                    this._executionPlanOptions.includeEstimatedExecutionPlanXml =
+                        true;
+                    this.onRunQuery();
+                },
+            );
             this.initializeObjectExplorer();
 
             this.registerCommandWithArgs(
@@ -335,6 +351,13 @@ export default class MainController implements vscode.Disposable {
                 SqlToolsServerClient.instance,
             );
 
+            this._queryResultWebviewController.setExecutionPlanService(
+                this.executionPlanService,
+            );
+            this._queryResultWebviewController.setUntitledDocumentService(
+                this._untitledSqlDocumentService,
+            );
+
             const providerInstance = new this.ExecutionPlanCustomEditorProvider(
                 this._context,
                 this.executionPlanService,
@@ -438,6 +461,7 @@ export default class MainController implements vscode.Disposable {
                 uri,
                 undefined,
                 title,
+                {},
                 queryPromise,
             );
             await queryPromise;
@@ -509,6 +533,8 @@ export default class MainController implements vscode.Disposable {
         // Init Query Results Webview Controller
         this._queryResultWebviewController = new QueryResultWebviewController(
             this._context,
+            this.executionPlanService,
+            this.untitledSqlDocumentService,
         );
 
         // Init content provider for results pane
@@ -1522,11 +1548,13 @@ export default class MainController implements vscode.Disposable {
             if (editor.document.getText(selectionToTrim).trim().length === 0) {
                 return;
             }
+
             await self._outputContentProvider.runQuery(
                 self._statusview,
                 uri,
                 querySelection,
                 title,
+                self._executionPlanOptions,
             );
         } catch (err) {
             console.warn(`Unexpected error running query : ${err}`);

src/controllers/queryRunner.ts

@@ -27,6 +27,7 @@ import {
     QueryExecutionOptionsParams,
     QueryExecutionOptions,
     DbCellValue,
+    ExecutionPlanOptions,
 } from "../models/contracts/queryExecute";
 import {
     QueryDisposeParams,
@@ -197,12 +198,14 @@ export default class QueryRunner {
     // Pulls the query text from the current document/selection and initiates the query
     public async runQuery(
         selection: ISelectionData,
+        executionPlanOptions?: ExecutionPlanOptions,
         promise?: Deferred<boolean>,
     ): Promise<void> {
         await this.doRunQuery(selection, async (onSuccess, onError) => {
             // Put together the request
             let queryDetails: QueryExecuteParams = {
                 ownerUri: this._ownerUri,
+                executionPlanOptions: executionPlanOptions,
                 querySelection: selection,
             };
 

src/models/contracts/queryExecute.ts

@@ -104,6 +104,7 @@ export namespace QueryExecuteStatementRequest {
 
 export class QueryExecuteParams {
     ownerUri: string;
+    executionPlanOptions?: ExecutionPlanOptions;
     querySelection: ISelectionData;
 }
 
@@ -115,6 +116,11 @@ export class QueryExecuteStatementParams {
 
 export class QueryExecuteResult {}
 
+export class ExecutionPlanOptions {
+    includeActualExecutionPlanXml?: boolean;
+    includeEstimatedExecutionPlanXml?: boolean;
+}
+
 // ------------------------------- < Query Results Request > ------------------------------------
 export namespace QueryExecuteSubsetRequest {
     export const type = new RequestType<

src/models/sqlOutputContentProvider.ts

@@ -14,7 +14,11 @@ import VscodeWrapper from "./../controllers/vscodeWrapper";
 import { ISelectionData, ISlickRange } from "./interfaces";
 import { WebviewPanelController } from "../controllers/webviewController";
 import { IServerProxy, Deferred } from "../protocol";
-import { ResultSetSubset, ResultSetSummary } from "./contracts/queryExecute";
+import {
+    ExecutionPlanOptions,
+    ResultSetSubset,
+    ResultSetSummary,
+} from "./contracts/queryExecute";
 import { sendActionEvent } from "../telemetry/telemetry";
 import { QueryResultWebviewController } from "../queryResult/queryResultWebViewController";
 import { QueryResultPaneTabs } from "../sharedInterfaces/queryResult";
@@ -163,6 +167,7 @@ export class SqlOutputContentProvider {
         uri: string,
         selection: ISelectionData,
         title: string,
+        executionPlanOptions?: any,
         promise?: Deferred<boolean>,
     ): Promise<void> {
         // execute the query with a query runner
@@ -178,9 +183,14 @@ export class SqlOutputContentProvider {
                             this._panels.get(uri).revealToForeground(uri);
                         }
                     }
-                    await queryRunner.runQuery(selection, promise);
+                    await queryRunner.runQuery(
+                        selection,
+                        executionPlanOptions as ExecutionPlanOptions,
+                        promise,
+                    );
                 }
             },
+            executionPlanOptions,
         );
     }
 
@@ -219,6 +229,7 @@ export class SqlOutputContentProvider {
         uri: string,
         title: string,
         queryCallback: any,
+        executionPlanOptions?: any,
     ): Promise<void> {
         let queryRunner = await this.createQueryRunner(
             statusView ? statusView : this._statusView,
@@ -239,7 +250,10 @@ export class SqlOutputContentProvider {
                 await this.createWebviewController(uri, title, queryRunner);
             }
         } else {
-            this._queryResultWebviewController.addQueryResultState(uri);
+            this._queryResultWebviewController.addQueryResultState(
+                uri,
+                executionPlanOptions?.includeEstimatedExecutionPlanXml ?? false,
+            );
         }
         if (queryRunner) {
             queryCallback(queryRunner);