Voice of the DBA

Tag: ADS

Fixing the PoSh Hotkey in ADS

I installed the PowerShell (PoSh) extension in ADS recently. This is available in the extension pane, and once installed, you get the 4th icon on the right added to your sidebar, for PoSh.

I have the SSMS Keymap extension installed as well, since that was the first one I grabbed. This gives me keymapping to allow CTRL+E to execute queries. I have literally a decade of muscle memory here, and really wanted this to work.

However, when I highlight code in ADS and press F8, which is what I do in VS Code, I get this:

Not only is my PoSh code in the editor tab not executed in the Terminal, but the Server Connection pane pops open.

This is because that’s what keymap does for F8. I can use the command palette to debug this.

If I open up the keyboard shortcuts and search for F8, I find that a number of things use this.

The last binding is the one that’s in effect, and you can see that the Show Connections overrides the PowerShell item.

Fortunately, I can edit this by clicking on the left of this line.

Once the dialog pops up, it is there to capture any keystrokes, so it’s hard to get a picture of this. However, with a little experimenting, I remapped this to CTRL+L, which has some bindings, but these aren’t ones I use.

Now I see PowerShell as the last item, and if I close this tab, and go back to my code, I can press F8, and I’ll see the line executed in the terminal.

September 28, 2020
Creating a Quick Dashboard Widget

I read Carlos Robles blog on creating an Azure Data Studio (ADS) insight widget and decided to try this for myself. I decided to try and get a list of object types and a count of each. Following instructions, here’s what I did.

First, I wrote a query that would gather the types of objects and counts from sys.objects.

I saved this as a file under my Documents folder. Once I had this, I ran the query and in the results, I clicked on the Chart item to the right of the results.

This displays a bar chart, which is useful at times, but that’s not what I want.

Instead of this, I’ll expand the Chart Type drop down. This gives me a list of a number of items I can choose. For this insight, I’ll use the table type.

Once this is done, I’ll see the results I want. There is a “Create Insight” button above the chart. I’ll click this to get the JSON code that creates this.

A new editor tab opens with the JSON code in it. This is just one long line of code, which isn’t as helpful or easy to work with.

CTRL+Shift+P opens the command palette. Type “format” and you’ll see the Format Document command. Once you format the code, it will be easier to read.

The next step is to open the user settings. This is also in the command palette.

In my ADS, I get the settings list. I can search for dashboard and I’ll find the one I want.

If I put the cursor in the upper left, I’ll get an edit item. I can pick this and I’ll get one of two items. If I’ve never customized anything, I’ll get the “copy to user settings” option. If I have, I get the “Replace in settings” item.

Once I’ve done this, I want to modify some code. I don’t love the search box, so I’ll delete that json widget. Then I paste in my widget code. Be sure you put this in the right place, with a comma between the widgets braces. I changed the name from “my-widget” to “User Object Count”.

Once I do this, I save it and close it. Then I double click one of my server connections and I see my widget on the dashboard.

Pretty easy to get a query to appear on your dashboard as a chart if you want to get some insights. Any query could be used, with the results returned when you open the server connection. You can also leave the dashboard open and refresh it when convenient.

November 8, 2018
Adding SQL Search to Azure Data Studio

There are a limited number of extensions available for Azure Data Studio (ADS), but one that came out early is SQL Search. This is highlighted as a recommended extension from Microsoft. Redgate worked with them early on in the lifecycle of the product to get this extension working, including helping spec out the APIs for interaction with ADS.

My extensions pane is on the right, so my details are on the left. There’s a description of SQL Search as well as a link to install the extension. As with most extensions, the link takes you to a download page. For SQL Search, this is a Redgate Foundry page with a few builds. I picked the public one.

Installing extensions is basically using File | Install Extensions from VSIX and picking the downloaded file. You need to approve the extension and then reload once it’s installed. You can see it installed if you re-open the extensions pane.

Using SQL Search

To use this extension, you can use the CTRL+Shift+P command to bring up the command palette. When you do this, you get a way to run commands at the top of the ADS window. This is a handy tool that you will use often.

If we type “SQL S”, we’ll get the SQL Search commands. There is a reindex command and a search command. These are the two items implemented at this time.

The re-index command will update the SQL Search index with information from the current database connection. If you cannot find an object you need, then you might run the reindex.

The other command allows you to search the database. If we click this one, we get a new edit box at the top of the window. Focus will be in this window, so you can type a term. For me, I know there are a number of items in this database for blogs, so let’s enter that.

The results will appear in a new tab alongside your currently open tabs.

The results show me that I have an object name along with the schema and database. We see the type of the object and then the way the object was matched. Next to the object name, there is a circle with an ellipsis. If we click this, we have a couple of choices for what to do with our results.

We can highlight this object in our object explorer, which will, well, do nothing for me. I suspect that the call from the extension to the servers Object Explorer is flaky. Even if I open the Servers pane and then click “Reveal in Object Explorer”, nothing happens. I see whatever I had opened in the Servers Pane.

If I close the server pane and instead click View Definition, I get a split pane on the right with the object definition. I can resize this as needed, but this is a view only pane. I can’t edit or execute this code. It’s for reference, which can be helpful when coding, but is of limited use.

I can copy this code for another window if I click the start and end places in the search results while holding the Shift key. Then I right click in the window and select Copy.

This is a limited use extension, but it does allow one to find code quicker than browsing through the Object Explorer. We can keep the search results up as a separate pane, so that we can use this as a pick list if we were looking for all the dependent objects for an object.

One nice touch from ADS is that if you CTRL+Shift+P again, the SQL Search commands appear at the top as recently used items.

Give SQL Search a try and let us know what you think.

November 2, 2018
Better Keyboard Extensions in Azure Data Studio

I used to use ALT+X to execute queries in SSMS. I spent years with this shortcut, but as I started to present more, CTRL+E felt more natural. I’ve now grown used to that, so when I typed CTRL+E in Azure Data Studio (ADS), I was less than pleased.

Even trying to get help here didn’t help.

I actually had a conversation with Kevin Cunnane when this was SOS and he pointed me to the keymap extension. You can get this by clicking the extensions icon on the left side of ADS:

Once you do this, search for keymap, and you’ll see Kevin’s extension.

You can see details for the extension on the right.

When you click “Install”, you’ll go to Kevin’s repo on Github. Click the link to download the VSIS extension. This gets saved in your Downloads folder (or wherever you have downloads going).

Go back to ADS and use the File menu to find the VSIS installer.

Browse and double click the VSIX file you downloaded. You’ll see a message in the lower right of ADS.

Click Yes, or no, but if you click No, this won’t install. In a few seconds, if you clicked Yes, you’ll see this:

Click Reload, and ADS will close and reopen. Your query window should still be there, and CTRL+E will pop the connection dialog, since the connection closed. Once you connect, the query will run with CTRL+E

The full list of key mappings is available on the repo or in the package.json file.

October 23, 2018