[Feature Request]: Provide docs about connection-sharing (API)

[m4ss1m0g]

Feature Description

Provide documentation about connection-sharing (API), now all infos are inside issues and PR:
#19542
#19456
#19544

And my discussion about this
#19519

An example code could be very helpful.

Also, add a notice of this possibility on the main README.

Problem and Motivation

I would port the SqlPackage extension on ADS, to VScode.

Related Area

• Connection dialog (SQL Server | Azure browse/Fabric browse)
• Query results panel
• Query editor
• Object Explorer
• Table Designer
• Schema Compare
• Schema Designer
• Local SQL Server Container provisioning
• SQL database in Fabric provisioning
• GitHub Copilot integration
• Query Plan Visualizer
• Other (please describe below)

If you selected "Other", please describe the area

Connection-Sharing, API

Confirmation

• I have searched existing feature requests and couldn't find a match
• I want to help implement this feature

[kburtram]

@aasimkhan30 let's discuss where we'd like to document our extensibility APIs. Probably in the wiki?

[aasimkhan30]

@m4ss1m0g while I get the docs ready. Why don't you look at the example extension here:

Please let me know if you have more questions.
https://github.com/microsoft/vscode-mssql/tree/main/samples/connection-sharing-sample

[m4ss1m0g]

Thanks!

[m4ss1m0g]

I created a brand new extension, and I tried to copy and paste the extension.ts code, but I encountered many problems:

Missing imports

These imports are missing

import { IConnectionProfile } from 'azdata';
import * as mssql from 'vscode-mssql';

From mssql, the extension uses only IConnectionSharingService from /typings/vscode-mssql.d.ts, but importing this file is quite impossible because there are many dependencies.

So I tried to copy the IConnectionSharingService and IConnectionProfile and add the missing dependencies, below is
my step to create a working file called external.ts

external.ts

IConnectionSharingService

• add npm i vscode-languageclient -D for RequestType
• add ScriptOperation from src/models/contracts/scripting/scriptingRequest.ts
• add ctor on DbCellValue
• ConnectionSharingApproval NOT FOUND

IConnectionProfile

• add IConnectionProfile from src/models/interfaces.ts
• add AzureAuthType from src/models/contracts/azure.ts
• AccountStore is a class: not included because there are many deps

I attach the external.ts

First Impression

I found the mandatory open editor to grab the active connection quite cumbersome, but I understand that it is a way to know which connection is active.

Question: Is there a possibility to extend the context menù over the database to add custom item, like right-click over the database and launch a backup/restore? This can be a path to get the current active database.

Thanks

external.txt