SQL Scripts Explorer

Microsoft SQL Server Management Studio 20 extension to open, create, edit, organize, search and share SQL Scripts. Its purpose is to allow quick access to scripts that are frequently used.

Contents

• Getting Started
  • Requirements
  • Installation
  • Launch
• Features
  • Manage multiple SQL Scripts repositories
  • Organize SQL Scripts using folders
  • Open, create and edit SQL Script files
  • Search SQL Scripts across repositories
  • Format SQL Scripts
• Contributing
  • Debugging
• Known Issues
  • Extension does not Load
  • Docking Issue

Getting Started

Requirements

• Microsoft SQL Server Management Studio 20 (supposed to support versions 13-20, only tested in 18 and 20)
• .NET 4.8.1

Installation

• Close all instances of Microsoft SQL Server Management Studio 20
• Download the most recent release
• Add release folder SQLScriptsExplorer to
  C:\Program Files (x86)\Microsoft SQL Server Management Studio 20\Common7\IDE\Extensions
  

Launch

You can access the addin via the View menu.

Or you can add a quick launch button by enabling the toolbar.

Features

Manage multiple SQL Scripts repositories

Map local folders to store your own SQL Scripts or collaborate/share knowledge with your team by mapping shared SQL Scripts folders.

Organize SQL Scripts using folders

Use the explorer to organize scripts using folders.

Open, create and edit SQL Script files

Use the explorer to manage your scripts without living your workspace.

Search SQL Scripts across repositories

Easily search SQL Scripts across different mapped repositories.

Format SQL Scripts

Use Format Selection button to format SQL statements.

Contributing

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.

Debugging

• Install Visual Studio 2022 with Visual Studio Extension Development enabled
  
• Open solution in Visual Studio 2022 in Administrator Mode
• Right click the project SQLScriptsExplorer.Addin
• Select Debug tab
• In the Start external program option, change it to
  C:\Program Files (x86)\Microsoft SQL Server Management Studio 18\Common7\IDE\ssms.exe
• In the Command line arguments option, remove all the text
  
• Select VSIX tab
  • Ensure Copy VSIX content to the following location is
    C:\Program Files (x86)\Microsoft SQL Server Management Studio 18\Common7\IDE\Extensions\SQLScriptsExplorer
    

Known Issues

Extension does not Load

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.

Docking Issue

Note: Issue is related to Windows and .NET Framework, not the addin.

There's an issue with docking any Toolbar in Microsoft SQL Server Management Studio 18. Here are two options to solve it:

• Install Microsoft's official cumulative update
• Manual fix by changing SSMS.config file. (Source: Microsoft Docs Q&A)
  • Navigate to C:\Program Files (x86)\Microsoft SQL Server Management Studio 18\Common7\IDE
  • Find "Ssms.exe.config" file, open up a Notepad in Administrator Mode, and edit this file
  • You will then need to find an xml tag called <AppContextSwitchOverrides>, and APPEND (not replace) the following exactly:
  • ;Switch.System.Windows.Interop.MouseInput.OptOutOfMoveToChromedWindowFix=true; Switch.System.Windows.Interop.MouseInput.DoNotOptOutOfMoveToChromedWindowFix=true