Adding SqlPackage Service for supporting Sqlpackage command generation changes by ssreerama · Pull Request #2556 · microsoft/sqltoolsservice

ssreerama · 2025-12-14T23:28:21Z

Pull Request Template – SQL Tools Service

Description

This PR provides the Service layer that bridges VSCode and the SqlPackage API by transforming client-side deployment configurations into SqlPackage CLI command strings, handling contract conversion and option normalization.

Below are the complete changes that have made to achieve this task with sqlpackage service.

GenerateSqlPackageCommandRequest.cs - Defines the RPC contract between VSCode and STS.
SqlPackageCommandParams (request) and request type for the "sqlpackage/generateCommand" endpoint.
SqlPackageCommandResult.cs - Response contract sent back to VSCode containing the generated command string, success status, and error message.
SqlPackageService.cs - Service layer that handles command generation requests, normalizes deployment options for Publish/Script operations, converts STS contracts to API types, and calls the SqlPackage API.
Changes in csproj file using HintPathGeneratePathProperty → Creates $(PkgMicrosoft_SqlPackage) variable pointing to package folder
- IncludeAssets="none" → Don't auto-include the package in build output
- HintPath → Manually reference only the sqlpackage.dll assembly we need
- Private = true → Copies the dll to the build output folder

Code Changes Checklist

New or updated unit tests added
All existing tests pass (dotnet test)
Code follows contributing guidelines
Logging/telemetry updated if relevant
No protocol or behavioral regressions

Reviewers: Please read our reviewer guidelines

…vice

github-actions · 2025-12-14T23:28:31Z

As part of updating the dependencies in Packages.props we require that any PRs opened also verify that
they've done the following checks.

Please respond to this comment verifying that you've done the appropriate validation (or explain why it's not necessary) before merging in the PR

Built and tested the change locally to validate that the update doesn't cause any regressions and fixes the issues intended
Tested changes on all major platforms
- Windows
- Linux
- Mac
Check the source repo for any open issues with the release being updated to (if available)

… nuget publicly available

ssreerama · 2026-01-07T01:27:50Z

bin/nuget/Microsoft.SqlPackage.Core.0.1.70-preview.nupkg

Working on uploading the Sqlpackage Core nuget to nuget.org, uploaded temporarily for the validation checks

aasimkhan30 · 2026-01-08T22:58:28Z

packages/Microsoft.SqlTools.ManagedBatchParser/Microsoft.SqlTools.ManagedBatchParser.nuspec

-                <dependency id="Azure.Identity" version="1.12.0" />
-                <dependency id="Microsoft.Data.SqlClient" version="5.1.6" />
+                <dependency id="Azure.Identity" version="1.14.2" />
+                <dependency id="Microsoft.Data.SqlClient" version="6.1.3" />


This is a pretty significant bump in sqlclient. We will have to make sure if everything is still working.

we are not bumping the MDS with this release so, reverted the changes and fixed the issue with the Nuget that causes the vbump requirement

llali · 2026-01-08T23:11:48Z

Packages.props

-    <PackageReference Update="Azure.Identity" Version="1.12.0" />
-    <PackageReference Update="Microsoft.Data.SqlClient" Version="5.1.7" />
+    <PackageReference Update="Azure.Identity" Version="1.14.2" />
+    <PackageReference Update="Microsoft.Data.SqlClient" Version="6.1.3" />


I thought we decided yesterday that we don't need to update MDS for this release. is it required for your work?

Since the New Nuget's sqlpackage.dll build against latest dacfx, it is expecting the MDS version bump and few supported packages upgrade. But I'll verify again if the version upgrades can be bypassed with the nuget usage.

you nuget should have dependency on dacfx 170.2. that's what we discussed in the meeting.

llali · 2026-01-08T23:18:40Z

src/Microsoft.SqlTools.ServiceLayer/SqlPackage/SqlPackageService.cs

+                    await requestContext.SendResult(new SqlPackageCommandResult
+                    {
+                        Success = false,
+                        ErrorMessage = "Invalid request parameters"


shouldn't be localized?

llali · 2026-01-08T23:32:55Z

src/Microsoft.SqlTools.ServiceLayer/SqlPackage/Contracts/CommandLineArguments.cs

+        /// <summary>
+        /// Enable diagnostics logging
+        /// </summary>
+        public bool Diagnostics { get; set; }


you cannot inherit from CommandLineArguments so you don't duplicate all the properties?

great point! actually we can avoid repetition of this by doing inheritance, since i have started with few arguments before i made the commandlineArgs public, I missed this one. Thanks.

… cmdArgs

packages/Microsoft.SqlTools.ManagedBatchParser/Microsoft.SqlTools.ManagedBatchParser.nuspec

llali · 2026-01-13T20:32:11Z

packages/Microsoft.SqlTools.ManagedBatchParser/Microsoft.SqlTools.ManagedBatchParser.nuspec

            <group targetFramework="net8.0">
                <dependency id="Azure.Identity" version="1.12.0" />
-                <dependency id="Microsoft.Data.SqlClient" version="5.1.7" />
+                <dependency id="Microsoft.Data.SqlClient" version="5.1.6" />


why? seems wrong

Batchparser is at 5.1.6 currenlty, should be align with MDS version with props file though. we are not making any changes to that in this PR.

aasimkhan30 · 2026-01-14T17:04:35Z

src/Microsoft.SqlTools.ResourceProvider.Core/Localization/sr.cs

@@ -1,5 +1,5 @@
 // WARNING:
-// This file was generated by the Microsoft SQL Server String Resource Tool 9.0.0.0
+// This file was generated by the Microsoft SQL Server String Resource Tool 10.0.0.0


Do you know why we are seeing these changes?

I ran the localization command to generate the loc strings, and it produced these updates to the files.

ssreerama added 10 commits December 4, 2025 23:14

Inital changes: sqlpakcage service with nuget import

7620e51

fixing build errors

a509e40

adding hint path to use the hybrid package and updated sqlpakcage ser…

7e43cb1

…vice

new updates

4a6cce3

adding test with generic command generation

ec60590

latest updates with serialized params

941dd87

still have different API method calls

6c51841

making the API to generic

2acd656

final changes

b4addcb

refactoring by reusing targetFx variable

f31d4eb

ssreerama added 13 commits December 15, 2025 11:26

keeping the sqlpackage command line result separate

60a9c76

removing hintpatha nd using core nuget

b234f4d

fixing build and tests with sqlpackage .core Nuget

ca9bf9c

using new nuget version

d17ee5e

adding command line args DTO

564e442

fixing the issues

a179f39

Merge branch 'main' into sai/SqlPkgCmdGen

7ecb3bb

using Builder with latest nuget and updated tests

017d37d

refactoring and cpturing the sqlpackage exception

7f00af0

adding XML comments for the methods

201541c

Merge branch 'main' into sai/SqlPkgCmdGen

eb0dc5b

adding masked option to the command request

9f56102

updating sqlpackage core nuget version

aa04d1a

ssreerama changed the title ~~Sai/sql pkg cmd gen~~ Adding SqlPackage Service for supporting Sqlpackage command generation changes Jan 7, 2026

ssreerama self-assigned this Jan 7, 2026

ssreerama marked this pull request as ready for review January 7, 2026 01:21

ssreerama requested review from aasimkhan30, caohai and kburtram as code owners January 7, 2026 01:21

ssreerama requested review from Benjin, allancascante, laurenastrid1, lewis-sanchez, llali and manujoseph85 as code owners January 7, 2026 01:21

Temporarily adding the Nuget for PR validations, will remove once the…

524d438

… nuget publicly available

ssreerama commented Jan 7, 2026

View reviewed changes

ssreerama added 3 commits January 6, 2026 20:27

Refactoring itno simple classes

589a783

test fixes

8e8f2cf

removing local nuget, the core nuget is published to nuget org

9eee30b

aasimkhan30 reviewed Jan 8, 2026

View reviewed changes

llali requested changes Jan 8, 2026

View reviewed changes

removing the duplicated commandlineArgs and inheriting from the dacfx…

8291587

… cmdArgs

ssreerama commented Jan 13, 2026

View reviewed changes

packages/Microsoft.SqlTools.ManagedBatchParser/Microsoft.SqlTools.ManagedBatchParser.nuspec Outdated Show resolved Hide resolved

ssreerama added 2 commits January 13, 2026 12:26

adding loc string and removed undo batchparser change

1291e62

vbump core nuget with the latest iteration

0e1dac2

llali requested changes Jan 13, 2026

View reviewed changes

llali approved these changes Jan 13, 2026

View reviewed changes

aasimkhan30 approved these changes Jan 14, 2026

View reviewed changes

aasimkhan30 reviewed Jan 14, 2026

View reviewed changes

aasimkhan30 approved these changes Jan 14, 2026

View reviewed changes

ssreerama merged commit 6858e96 into main Jan 14, 2026
6 checks passed

ssreerama deleted the sai/SqlPkgCmdGen branch January 14, 2026 17:39

Conversation

ssreerama commented Dec 14, 2025

Pull Request Template – SQL Tools Service

Description

Code Changes Checklist

Reviewers: Please read our reviewer guidelines

Uh oh!

github-actions bot commented Dec 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ssreerama Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ssreerama Jan 13, 2026 •

edited

Loading