Let’s start with GitHub.
It’s been said many times, it may daunt to contribute to an Open Source Project. Maybe you are not sure where to start, or how to even approach such a thing.
I am all too aware of this, but I also know how one’s input does matter. If you’re interested, GitHub has a detailed guide about contributing to Open Source.
Well, I bumped into Azure Data Studio when I started using my personal computer, a MacBook Air, and Microsoft SQL Server on a Docker container for some personal projects, although I also use it at work, such that it is the tool I recommend to my teammates given its low footprint, in comparison, and I find myself running Microsoft SQL Server Management Studio less and less.
Very recently I was talking with a colleague about SQL query formatting, and some useful extensions I’ve used. And that reminded me about a code snippet pre-bundled with Azure Data Studio that caught my attention; the
Why that snippet? The main reason is because the body of the stored procedure is not inside a
END block. So when you format the query by selecting
Format Document from the context menu, the query gets formatted in a weird way, and readability seems to go out the window.
So there were a couple of solutions.
Option 1. DIY, or fix-it-yourself. The file to modify is called
mssql.json found at
/Applications/Azure\ Data\ Studio.app/Contents/Resources/app/extensions/mssql/snippets on macOS, or
C:\Program Files\Azure Data Studio\resources\app\extensions\mssql\snippets on Windows.
And it looks like this.
"AS", "\t-- body of the stored procedure", "\tSELECT @param1, @param2", "GO",
My solution is to surround those lines with
END, like this:
"AS", "BEGIN", "\t-- body of the stored procedure", "\tSELECT @param1, @param2", "END", "GO",
The problem with this approach is that every time Azure Data Studio gets updated, the
mssql.json file is replaced and must be re-edited.
Option 2. Create your own snippet.
Option 3. Report this on GitHub, and achieve a more permanent solution.
Of course I’ve done all three, so coming soon the new snippet will be published on the stable release, or you can get it now by running Azure Data Studio - Insiders.
Which is a perfect segway to the last portion of this post; Homebrew.
I’ve used Homebrew in the past, but it has not been until recently that I’ve come to fully embrace it. So much that I’ve even become a Sponsor on GitHub as a “thank you” to all the maintainers.
And this week I’ve had my first PR approved for a
cask. After doing my homework, going through their guidelines, and asking a question or two, I finally got the courage to create the cask for Azure Data Studio - Insiders, and updating it, too.
So, starting now you can run the following command:
$ brew install azure-data-studio-insiders
Azure Data Studio - Insiders will be installed on your machine, and, even better, when you choose the
sqlCreateStoredProc snippet you’ll get the following template:
-- Create a new stored procedure called 'StoredProcedureName' in schema 'dbo' -- Drop the stored procedure if it already exists IF EXISTS ( SELECT * FROM INFORMATION_SCHEMA.ROUTINES WHERE SPECIFIC_SCHEMA = N'dbo' AND SPECIFIC_NAME = N'StoredProcedureName' AND ROUTINE_TYPE = N'PROCEDURE' ) DROP PROCEDURE dbo.StoredProcedureName GO -- Create the stored procedure in the specified schema CREATE PROCEDURE dbo.StoredProcedureName @param1 /*parameter name*/ int /*datatype_for_param1*/ = 0, /*default_value_for_param1*/ @param2 /*parameter name*/ int /*datatype_for_param1*/ = 0 /*default_value_for_param2*/ -- add more stored procedure parameters here AS BEGIN -- body of the stored procedure SELECT @param1, @param2 END GO -- example to execute the stored procedure we just created EXECUTE dbo.StoredProcedureName 1 /*value_for_param1*/, 2 /*value_for_param2*/ GO
Will you looke at that? A
BEGIN and an
And with all this, the moral of the story is: Do your homework, and contribute.