Adding a setting to prevent auto execute on Select top 1000 (#20224)

Author: aasimkhan30

localization/xliff/vscode-mssql.xlf

@@ -3786,6 +3786,9 @@
     <trans-unit id="mssql.pauseQueryHistoryCapture">
       <source xml:lang="en">Pause Query History Capture</source>
     </trans-unit>
+    <trans-unit id="mssql.preventAutoExecuteScript">
+      <source xml:lang="en">Prevent automatic execution of scripts (e.g., &apos;Select Top 1000&apos;). When enabled, scripts will not be automatically executed upon generation.</source>
+    </trans-unit>
     <trans-unit id="mssql.authCodeGrant.description">
       <source xml:lang="en">Prompts users to sign in using their browser.</source>
     </trans-unit>

package.json

@@ -1689,6 +1689,12 @@
                     ],
                     "scope": "resource"
                 },
+                "mssql.query.preventAutoExecuteScript": {
+                    "type": "boolean",
+                    "description": "%mssql.preventAutoExecuteScript%",
+                    "default": false,
+                    "scope": "resource"
+                },
                 "mssql.enableSqlAuthenticationProvider": {
                     "type": "boolean",
                     "description": "%mssql.enableSqlAuthenticationProvider%",

package.nls.json

@@ -115,6 +115,7 @@
     "mssql.copyRemoveNewLine": "[Optional] Configuration options for copying multi-line results from the Results View",
     "mssql.showBatchTime": "[Optional] Should execution time be shown for individual batches",
     "mssql.splitPaneSelection": "[Optional] Configuration options for which column new result panes should open in",
+    "mssql.preventAutoExecuteScript": "Prevent automatic execution of scripts (e.g., 'Select Top 1000'). When enabled, scripts will not be automatically executed upon generation.",
     "mssql.format.alignColumnDefinitionsInColumns": "Should column definitions be aligned?",
     "mssql.format.datatypeCasing": "Should data types be formatted as UPPERCASE, lowercase, or none (not formatted)",
     "mssql.format.keywordCasing": "Should keywords be formatted as UPPERCASE, lowercase, or none (not formatted)",

src/constants/constants.ts

@@ -206,6 +206,7 @@ export const configMaxRecentConnections = "maxRecentConnections";
 export const configCopyRemoveNewLine = "copyRemoveNewLine";
 export const configSplitPaneSelection = "splitPaneSelection";
 export const configShowBatchTime = "showBatchTime";
+export const configPreventAutoExecuteScript = "mssql.query.preventAutoExecuteScript";
 export enum extConfigResultKeys {
     Shortcuts = "shortcuts",
     MessagesDefaultOpen = "messagesDefaultOpen",

src/controllers/mainController.ts

@@ -736,20 +736,26 @@ export default class MainController implements vscode.Disposable {
                 connectionInfo: connectionCreds,
             });
             if (executeScript) {
-                const uri = getUriKey(editor.document.uri);
-                const queryPromise = new Deferred<boolean>();
-                await this._outputContentProvider.runQuery(
-                    this._statusview,
-                    uri,
-                    undefined,
-                    title,
-                    undefined,
-                    queryPromise,
-                );
-                await queryPromise;
-                await this.connectionManager.connectionStore.removeRecentlyUsed(
-                    <IConnectionProfile>connectionCreds,
-                );
+                const preventAutoExecute = vscode.workspace
+                    .getConfiguration()
+                    .get<boolean>(Constants.configPreventAutoExecuteScript);
+
+                if (!preventAutoExecute) {
+                    const uri = getUriKey(editor.document.uri);
+                    const queryPromise = new Deferred<boolean>();
+                    await this._outputContentProvider.runQuery(
+                        this._statusview,
+                        uri,
+                        undefined,
+                        title,
+                        undefined,
+                        queryPromise,
+                    );
+                    await queryPromise;
+                    await this.connectionManager.connectionStore.removeRecentlyUsed(
+                        <IConnectionProfile>connectionCreds,
+                    );
+                }
             }
 
             let scriptType;