Azure Data Studio Debug

This extension forms the Azure Data Studio extension debugging experience.

Release Notes

1.4

Updated to latest debugger code to allow debugging newer versions of Azure Data Studio.

1.2

Renamed the extension to Azure Data Studio Debug, matching the rename of Azure Data Studio (previously known as SQL Operations Studio).

1.0.2

Fixed issue where use of the sqlops default runtimeExecutable target didn't work as expected. Testing of this has been verified on macOS and Windows, but not Linux.

Building and debugging an extension

Prerequisites

To develop an extension you need Node.js installed and available in your $PATH. Node.js includes npm, the Node.js Package Manager, which will be used to install the extension generator.

Install the extension generator

Install Yeoman and the Azure Data Studio Extension generator from the command prompt:

npm install -g yo generator-azuredatastudio

Run yo azuredatastudio

The Yeoman generator will walk you through the steps required to create your customization or extension prompting for the required information.

To launch the generator, type the following in a command prompt:

yo azuredatastudio

Generate a new extension

Pick the New Extension (Typescript) option to quickly get started with an extension

Debug your extension

• Press F5 or click the Debug icon and click Start
• A new instance of Azure Data Studio will start in a special mode (Extension Development Host) and this new instance is now aware of your extension.
• Press ctrl+shift+P (Windows/Linux) or cmd+shift+P (macOS) and run the command named Hello World.
• Congratulations! You've just created and executed your first Azure Data Studio command!

You can now add breakpoints to your code and debug as needed.

Next steps

Take a look at the extension samples for examples of the type of extension points added to Azure Data Studio. Also look at the VSCode Extensibility Reference - most of the extension points will work, with the exclusion of the debug namespace.

Contact the team on gitter or via our issues page if you have questions on adding extensions.

See a general overview of debugging in VS Code here.

Releasing the extension

Steps to update the extension on the VS Code Marketplace :

1. Make changes and update version in package.json
2. Create a tag in the format x.x.x corresponding to the version of the release. This will trigger the CD pipeline to run and attach a built version of the VSIX to the release
3. Download that VSIX and then run vsce publish --packagePath <pathToVSIX>. It will prompt you for your PAT which you can get by following the instructions here : https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token (note that you will also need to be a member of the ms-mssql publisher on the Marketplace. Contact repo owners if you're not)

License

Copyright (c) Microsoft. All rights reserved.

Licensed under the MIT License.