SQLScriptsExplorer

<h1>SQL Scripts Explorer</h1> <p>Microsoft SQL Server Management Studio 22 extension to open, create, edit, organize, search and share SQL Scripts. Its purpose is to allow quick access to scripts that are frequently used.</p> <h2>Contents</h2> <ul> <li><a href="#getting-started">Getting Started</a> <ul> <li><a href="#requirements">Requirements</a></li> <li><a href="#installation">Installation</a></li> <li><a href="#launch">Launch</a></li> </ul> </li> <li><a href="#features">Features</a> <ul> <li><a href="#manage-multiple-sql-scripts-repositories">Manage multiple SQL Scripts repositories</a></li> <li><a href="#organize-sql-scripts-using-folders">Organize SQL Scripts using folders</a></li> <li><a href="#open-create-and-edit-sql-script-files">Open, create and edit SQL Script files</a></li> <li><a href="#search-sql-scripts-across-repositories">Search SQL Scripts across repositories</a></li> <li><a href="#format-sql-scripts">Format SQL Scripts</a></li> </ul> </li> <li><a href="#contributing">Contributing</a> <ul> <li><a href="#debugging">Debugging</a></li> </ul> </li> <li><a href="#known-issues">Known Issues</a> <ul> <li><a href="#extension-does-not-load">Extension does not Load</a></li> <li><a href="#docking-issue">Docking Issue</a></li> </ul> </li> </ul> <!-- GETTING STARTED --> <h1>Getting Started</h1> <h2>Requirements</h2> <ul> <li>Microsoft SQL Server Management Studio 22 (<i>supposed to support versions 13-22, only tested in 18, 20-22</i>)</li> <li>.NET 4.8.1</li> </ul> <h2>Installation</h2> <ul> <li>Close all instances of Microsoft SQL Server Management Studio</li> <li>Download the most recent <a href="https://github.com/joaoribe/SQLScriptsExplorer/releases/latest">release</a></li> <li>Execute the <i>SQLScriptsExplorer.Addin.vsix</i> to complete installation <br/> <img width="322" height="232" alt="image" src="https://github.com/user-attachments/assets/8a03e315-fbfb-4081-9e86-1c014a45fd10" /> </li> <h4>*** DEPRECATED: Version v1.3.2-beta and before ***</h4> <li>Close all instances of Microsoft SQL Server Management Studio 21 (or prior)</li> <li>Download any <a href="https://github.com/joaoribe/SQLScriptsExplorer/releases">release</a> up until v1.3.2-beta</li> <li>Add release folder <i>SQLScriptsExplorer</i> to <br/> <code>C:\Program Files\Microsoft SQL Server Management Studio 21\Release\Common7\IDE\Extensions</code> </li> <li><b>Note:</b> adjust the extension path based on the SSMS you are using e.g. SSMS 20 <br/> <code>C:\Program Files (x86)\Microsoft SQL Server Management Studio 20\Common7\IDE\Extensions</code> <br/> <img src="docs/images/InstallationFolder.png"/> </li> </ul> <h2>Launch</h2> <p>You can access the addin via the View menu.</p> <img src="docs/images/AccessViaMenu.png"/> <p>Or you can add a quick launch button by enabling the toolbar.</p> <img src="docs/images/AccessViaToolbar.png"/> <!-- FEATURES --> <h1>Features</h1> <h2>Manage multiple SQL Scripts repositories</h2> <p>Map local folders to store your own SQL Scripts or collaborate/share knowledge with your team by mapping shared SQL Scripts folders.</p> <img src="docs/images/MapFolders.png"/> <h2>Organize SQL Scripts using folders</h2> <p>Use the explorer to organize scripts using folders.</p> <img src="docs/images/OrganizeScripts.png"/> <h2>Open, create and edit SQL Script files</h2> <p>Use the explorer to manage your scripts without living your workspace.</p> <img src="docs/images/CreateAndEditFile.gif"/> <h2>Search SQL Scripts across repositories</h2> <p>Easily search SQL Scripts across different mapped repositories.</p> <img src="docs/images/Search.gif"/> <h2>Format SQL Scripts</h2> <p>Use <i>Format Selection</i> button to format SQL statements.</p> <img src="docs/images/FormatSelection.gif"/> <h2>Theme Support (SSMS 21+)</h2> <p>Since SSMS 21+ now support Themes, so does the plugin.</p> <img src="docs/images/Themes.png"/> <!-- CONTRIBUTING --> <h1>Contributing</h1> <p>Feel free to report an issue or suggest a feature. If you would like to introduce a functionality or fix an issue, please create a pull request.</p> <h2>Debugging</h2> <ul> <li>Install Visual Studio 2022 with <i>Visual Studio Extension Development</i> enabled <br/> <img src="docs/images/VisualStudioExtensionDevelopment.png"/> </li> <li>Open solution in Visual Studio 2022 in Administrator Mode</li> <li>Right click the project <i>SQLScriptsExplorer.Addin</i></li> <li>Select <i>Debug</i> tab</li> <ul> <li>In the <i>Start external program</i> option, change it to <br/> <code>C:\Program Files\Microsoft SQL Server Management Studio 22\Release\Common7\IDE\Ssms.exe</code> </li> <li>In the <i>Command line arguments</i> option, remove all the text <br/> <img src="docs/images/ProjectProperties.Debug.png"/> </li> </ul> <li>Select <i>VSIX</i> tab <ul> <li>Ensure <i>Copy VSIX content to the following location</i> is <br/> <code>C:\Program Files\Microsoft SQL Server Management Studio 22\Release\Common7\IDE\Extensions\SQLScriptsExplorer</code> <br/> <img src="docs/images/ProjectProperties.VSIX.png"/> </li> </ul> </li> </ul> <!-- KNOWN ISSUES --> <h1>Known Issues</h1> <h2>Extension does not Load</h2> <p>Sometimes when you download the release zip file, Windows blocks it for security reasons. If you get an error after the plugin installation or the plugin does not appear in Microsoft SQL Server Management Studio 18, ensure the release ZIP file you have downloaded is unblocked.</p> <img src="docs/images/UnblockFile.png"/> <h2>Docking Issue</h2> <p><b>Note:</b> Issue is related to Windows and .NET Framework, not the addin.</p> <p>There's an issue with docking any Toolbar in Microsoft SQL Server Management Studio 18. Here are two options to solve it:</p> <ul> <li> <a target="_blank" href="https://support.microsoft.com/en-us/topic/february-9-2021-kb4601060-cumulative-update-for-net-framework-3-5-and-4-7-2-for-windows-10-version-1809-and-windows-server-version-2019-b240d07e-639f-d708-98c9-0cbe443176aa"> Install Microsoft's official cumulative update </a> </li> <li> Manual fix by changing SSMS.config file. (Source: <a target="_blank" href="https://docs.microsoft.com/en-us/answers/questions/263738/ssms-188-crashes-when-re-docking-tabs.html">Microsoft Docs Q&A</a>) <ul> <li>Navigate to <i>C:\Program Files (x86)\Microsoft SQL Server Management Studio 18\Common7\IDE</i></li> <li>Find "Ssms.exe.config" file, open up a Notepad in Administrator Mode, and edit this file</li> <li>You will then need to find an xml tag called &lt;AppContextSwitchOverrides&gt;, and APPEND (not replace) the following exactly:</li> <ul> <li> ;Switch.System.Windows.Interop.MouseInput.OptOutOfMoveToChromedWindowFix=true; Switch.System.Windows.Interop.MouseInput.DoNotOptOutOfMoveToChromedWindowFix=true </li> <ul> </ul> </li> </ul>