Skip to content

Commit 8fb46f2

Browse files
jborsecnikjborsecnik
authored
Merge pull request #24838 from dzsquared/dacfx-sqlpackagedotnettool
adding sqlpackage dotnet tool info
2 parents 299e330 + 5d1fbc3 commit 8fb46f2

2 files changed

Lines changed: 68 additions & 33 deletions

File tree

‎docs/tools/sqlpackage/release-notes-sqlpackage.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ This article lists the features and fixes delivered by the released versions of
3333
| :------ | :------ |
3434
|Platform|Changes connections to use encryption and not trust the server certificate by default. This is a breaking change for connections using self-signed certificates or without encryption by default. For more information, see [this dedicated article](https://aka.ms/dacfx-connection).|
3535
|Platform|References [Microsoft.Data.SqlClient](https://www.nuget.org/packages/Microsoft.Data.SqlClient/5.0.1) v5.0.1|
36+
|Platform|SqlPackage is now available for [installation](sqlpackage-download.md) as a `dotnet tool` for Windows, macOS, and Linux platforms.|
3637
|Always Encrypted|Adds support for VBS (Virtualization-based security) with [secure enclaves](/sql/relational-databases/security/encryption/always-encrypted-enclaves).|
3738
|Connectivity|Adds support for TDS 8.0 and parameters for `/SourceHostNameInCertificate` and `/TargetHostNameInCertificate` to SqlPackage operations.|
3839
|Replication|Adds support for [sp_addpublication](/sql/relational-databases/replication/transactional/peer-to-peer-conflict-detection-in-peer-to-peer-replication#automatically-handle-conflicts-with-last-write-wins) with peer-to-peer replication.|
@@ -203,7 +204,7 @@ This article lists the features and fixes delivered by the released versions of
203204
### Fixes
204205
| Feature | Details |
205206
| :------ | :------ |
206-
| Deployment | Fixed an issue where external user deployment to Managed Instance would fail |
207+
| Deployment | Fixed an issue where external user deployment to Azure SQL Managed Instance would fail |
207208
| Deployment | Fix for deployment order involving temporal tables to drop dependencies before turning system versioning off |
208209
| Deployment | Fix for Always Encrypted deployment bug with error "Invalid object name '#tmpErrors'" |
209210
| Export | Validation for SqlPackage parameters ExcludeObjectType(s) and DoNotDropObjectType(s) |
@@ -362,7 +363,7 @@ This article lists the features and fixes delivered by the released versions of
362363
| Deployment | Add Azure Synapse Analytics support for ordered clustered column store index |
363364
| Deployment | Add support for External Data Source (Oracle, Teradata, MongoDB/CosmosDB, ODBC, Big Data Cluster) and External Table for SQL Server 2019 Big Data Cluster |
364365
| Deployment | Add SQL Database Edge Instance as supported edition |
365-
| Deployment | Support Managed Instance server names of the form '\<server>.\<dnszone>.database.windows.net' |
366+
| Deployment | Support Azure SQL Managed Instance server names of the form '\<server>.\<dnszone>.database.windows.net' |
366367
| Deployment | Add support for copy command in Azure Synapse Analytics |
367368
| Deployment | Add deployment option 'IgnoreTablePartitionOptions' during Publish to avoid table recreation when there is change in partition function on table for Azure Synapse Analytics |
368369
| .NET Core | Add support for Microsoft.Data.SqlClient in .NET Core version of SqlPackage |
@@ -424,7 +425,7 @@ This article lists the features and fixes delivered by the released versions of
424425
| Platform | SqlPackage .NET Core generally available for macOS, Linux, and Windows. |
425426
| Security | Remove SHA1 code signing. |
426427
| Deployment | Add support for new Azure database editions: GeneralPurpose, BusinessCritical, Hyperscale |
427-
| Deployment | Add Managed Instance support for Azure Active Directory user and groups. |
428+
| Deployment | Add Azure SQL Managed Instance support for Azure Active Directory user and groups. |
428429
| Deployment | Support the /AccessToken parameter for SqlPackage on .NET Core. |
429430

430431
### Known Issues
@@ -547,7 +548,7 @@ Build: &nbsp; 15.0.4200.1
547548
| Feature | Details |
548549
| :------ | :------ |
549550
| Deployment | Added support for database compatibility level 150. |
550-
| Deployment | Added support for Managed Instances. |
551+
| Deployment | Added support for Azure SQL Managed Instances. |
551552
| Performance | Added MaxParallelism command-line parameter to specify the degree of parallelism for database operations. |
552553
| Security | Added AccessToken command-line parameter to specify an authentication token when connecting to SQL Server. |
553554
| Import | Added support to stream BLOB/CLOB data types for imports. |

‎docs/tools/sqlpackage/sqlpackage-download.md‎

Lines changed: 63 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,44 +16,56 @@ ms.date: 11/9/2022
1616

1717
# Download and install SqlPackage
1818

19-
SqlPackage runs on Windows, macOS, and Linux.
19+
SqlPackage runs on Windows, macOS, and Linux, and is available to install through `dotnet tool` or as a standalone zip download.
2020

21-
Download and install the latest releases:
21+
- **Version number:** 161.6374.0
22+
- **Build number:** 16.1.6374.0
23+
- **Release date:** November 9, 2022
2224

23-
|Platform|Download|Release date|Version|Build|
24-
|:---|:---|:---|:---|:---|
25-
|[Windows .NET 6](#windows-net-6) |[.zip file](https://go.microsoft.com/fwlink/?linkid=2215400)|November 9, 2022|161.6374.0|16.1.6374.0|
26-
|[Windows](#windows-net-framework)|[MSI Installer](https://go.microsoft.com/fwlink/?linkid=2215326)|November 9, 2022|161.6374.0|16.1.6374.0|
27-
|[macOS .NET 6](#macos) |[.zip file](https://go.microsoft.com/fwlink/?linkid=2215401)|November 9, 2022|161.6374.0|16.1.6374.0|
28-
|[Linux .NET 6](#linux) |[.zip file](https://go.microsoft.com/fwlink/?linkid=2215501)|November 9, 2022|161.6374.0|16.1.6374.0|
29-
30-
For details about the latest release, see the [release notes](release-notes-sqlpackage.md). To download additional languages, see the [Available Languages](#available-languages) section.
25+
For details about the latest release, see the [release notes](release-notes-sqlpackage.md).
3126

3227
> [!NOTE]
3328
> SqlPackage version numbering has been adjusted to better reflect the DacFx build number it is associated with. Previously, SqlPackage had a distinct version number (19) and build number (160.x). Beginning with version 161, the version number of SqlPackage will match the DacFx version number it is associated with (eg 161.6374.0).
3429
35-
## DacFx
30+
## Installation, cross-platform
3631

37-
SqlPackage is a command-line interface for the DacFx framework, exposing some of the public DacFx APIs. DacServices ([Microsoft.SqlServer.Dac](/dotnet/api/microsoft.sqlserver.dac.dacservices)) is a related mechanism for integrating database deployment into your application pipeline. The DacServices API is available in a package through NuGet, [Microsoft.SqlServer.DacFx](https://www.NuGet.org/packages/Microsoft.SqlServer.DacFx). The current DacFx version is 161.6374.0.
32+
Installing SqlPackage as a [dotnet tool](/dotnet/core/tools/global-tools) requires the [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet/6.0) v6.0 or later to be installed on your machine. Installing SqlPackage as a global tool will make it available on your path as `sqlpackage` and is the recommended way to install SqlPackage for Windows, macOS, and Linux.
3833

39-
Installing the NuGet package via the .NET CLI is accomplished with this command:
34+
To install SqlPackage as a global .NET tool, run the following command:
4035

41-
```cmd
42-
dotnet add package Microsoft.SqlServer.DacFx
43-
```
36+
```bash
37+
dotnet tool install -g microsoft.sqlpackage
38+
```
4439

45-
> [!NOTE]
46-
> Additional NuGet packages were published under the DacFx name, "Microsoft.SqlServer.DacFx.x64" and "Microsoft.SqlServer.DacFx.x86". Support for both platforms is covered under the "Microsoft.SqlServer.DacFx" package. New references should be made to this package, not the x64 or x86 variants.
40+
More information on the options available with the `dotnet tool install` command can be found in the [dotnet tool install documentation](/dotnet/core/tools/dotnet-tool-install).
41+
42+
43+
To update SqlPackage to the latest version, run the following command:
44+
45+
```bash
46+
dotnet tool update -g microsoft.sqlpackage
47+
```
48+
49+
50+
To uninstall SqlPackage, run the following command:
51+
52+
```bash
53+
dotnet tool uninstall -g microsoft.sqlpackage
54+
```
4755

48-
## Automated environments
4956

50-
Evergreen links are available for downloading the latest Sqlpackage versions:
51-
- Linux ([https://aka.ms/sqlpackage-linux](https://aka.ms/sqlpackage-linux))
52-
- macOS ([https://aka.ms/sqlpackage-macos](https://aka.ms/sqlpackage-macos))
53-
- Windows ([https://aka.ms/sqlpackage-windows](https://aka.ms/sqlpackage-windows))
54-
- Windows, .NET Framework ([https://aka.ms/dacfx-msi](https://aka.ms/dacfx-msi))
5557

56-
## Linux
58+
## Installation, zip download
59+
60+
|Platform|Download|
61+
|:---|:---|
62+
|[Windows .NET 6](#windows-net-6) |[.zip file](https://go.microsoft.com/fwlink/?linkid=2215400)|
63+
|[Windows](#windows-net-framework)|[MSI Installer](https://go.microsoft.com/fwlink/?linkid=2215326)|
64+
|[macOS .NET 6](#macos) |[.zip file](https://go.microsoft.com/fwlink/?linkid=2215401)|
65+
|[Linux .NET 6](#linux) |[.zip file](https://go.microsoft.com/fwlink/?linkid=2215501)|
66+
67+
68+
### Linux
5769

5870
1. Download [SqlPackage for Linux](https://aka.ms/sqlpackage-linux).
5971
2. To extract the file and launch SqlPackage, open a new Terminal window and type the following commands:
@@ -96,7 +108,7 @@ Evergreen links are available for downloading the latest Sqlpackage versions:
96108
sudo apt-get install libicu66 # for 20.x
97109
```
98110

99-
## macOS
111+
### macOS
100112

101113
1. Download [SqlPackage for macOS](https://aka.ms/sqlpackage-macos).
102114
2. To extract the file and launch SqlPackage, open a new Terminal window and type the following commands:
@@ -123,7 +135,7 @@ Evergreen links are available for downloading the latest Sqlpackage versions:
123135
sudo spctl --master-enable
124136
```
125137

126-
## Windows (.NET 6)
138+
### Windows (.NET 6)
127139

128140
1. Download [SqlPackage for Windows](https://aka.ms/sqlpackage-windows).
129141
2. To extract the file by right clicking on the file in Windows Explorer, and selecting 'Extract All...', and select the target directory.
@@ -133,20 +145,42 @@ Evergreen links are available for downloading the latest Sqlpackage versions:
133145
> sqlpackage
134146
```
135147

136-
## Windows (.NET Framework)
148+
### Windows (.NET Framework)
137149

138150
This release of SqlPackage includes a standard Windows installer experience, and a .zip:
139151

140152
1. Download and run the [DacFramework.msi installer for Windows](https://aka.ms/dacfx-msi).
141153
2. Open a new Command Prompt window, and run SqlPackage.exe
142154
- SqlPackage is installed to the ```C:\Program Files\Microsoft SQL Server\160\DAC\bin``` folder
143155

144-
## Uninstall SqlPackage
156+
### Uninstall SqlPackage
145157

146158
If you installed SqlPackage using the Windows installer, then uninstall the same way you remove any Windows application.
147159

148160
If you installed SqlPackage with a .zip or other archive, then delete the files.
149161

162+
### Automated environments
163+
164+
Evergreen links are available for downloading the latest Sqlpackage versions:
165+
- Linux ([https://aka.ms/sqlpackage-linux](https://aka.ms/sqlpackage-linux))
166+
- macOS ([https://aka.ms/sqlpackage-macos](https://aka.ms/sqlpackage-macos))
167+
- Windows ([https://aka.ms/sqlpackage-windows](https://aka.ms/sqlpackage-windows))
168+
- Windows, .NET Framework ([https://aka.ms/dacfx-msi](https://aka.ms/dacfx-msi))
169+
170+
## DacFx
171+
172+
SqlPackage is a command-line interface for the DacFx framework, exposing some of the public DacFx APIs. DacServices ([Microsoft.SqlServer.Dac](/dotnet/api/microsoft.sqlserver.dac.dacservices)) is a related mechanism for integrating database deployment into your application pipeline. The DacServices API is available in a package through NuGet, [Microsoft.SqlServer.DacFx](https://www.NuGet.org/packages/Microsoft.SqlServer.DacFx). The current DacFx version is 161.6374.0.
173+
174+
Adding the NuGet package to a .NET project is accomplished via the .NET CLI with this command:
175+
176+
```cmd
177+
dotnet add package Microsoft.SqlServer.DacFx
178+
```
179+
180+
> [!NOTE]
181+
> Additional NuGet packages were published under the DacFx name, "Microsoft.SqlServer.DacFx.x64" and "Microsoft.SqlServer.DacFx.x86". Support for both platforms is covered under the "Microsoft.SqlServer.DacFx" package. New references should be made to this package, not the x64 or x86 variants.
182+
183+
150184
## Supported Operating Systems
151185

152186
SqlPackage runs on Windows, macOS, and Linux and is built using .NET 6. The [.NET 6 OS requirements](https://github.com/dotnet/core/blob/main/release-notes/6.0/supported-os.md) are minimum requirements for SqlPackage, which has additional requirements due to its dependencies.

0 commit comments

Comments
 (0)