You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -21,12 +24,12 @@ SqlPackage runs on Windows, macOS, and Linux, and is available to install throug
21
24
22
25
SqlPackage is developed and released for both .NET 8 and .NET Framework. Installing the .NET 8 SqlPackage version is recommended via the [convenient `dotnet tool` method](#installation-cross-platform), which is cross-platform and easy to update, or via the [portable self-contained .zip download](#installation-file-download-alternative). The .NET 8 SqlPackage releases benefit from the continual advances to the performance and scalability of .NET as part of the [focus on for modern applications](/dotnet/core/introduction#net-ecosystem), which contrasts to the maintenance support of .NET Framework for Windows. The .NET Framework version is only available as a [.msi Windows installer](#windows-net-framework).
23
26
24
-
> [!NOTE]
27
+
> [!NOTE]
25
28
> Previously, SqlPackage had a distinct version number (19) and build number (160.x). Beginning with version 161, the version number of SqlPackage matches the DacFx version number it is associated with (eg 162.0.52).
26
29
27
30
## Installation, cross-platform
28
31
29
-
Installing SqlPackage as a [dotnet tool](/dotnet/core/tools/global-tools) requires the [.NET SDK](https://dotnet.microsoft.com/download/dotnet/8.0) to be installed on your machine. Installing SqlPackage as a global tool makes it available on your path as `sqlpackage` and is the recommended method to install SqlPackage for Windows, macOS, and Linux. SqlPackage is available as a dotnet tool for .NET 6 and .NET 8.
32
+
Installing SqlPackage as a [dotnet tool](/dotnet/core/tools/global-tools) requires the [.NET SDK](https://dotnet.microsoft.com/download/dotnet/8.0) to be installed on your machine. Installing SqlPackage as a global tool makes it available on your path as `sqlpackage` and is the recommended method to install SqlPackage for Windows, macOS, and Linux. SqlPackage is available as a dotnet tool for .NET 8 and later.
30
33
31
34
To install SqlPackage as a global .NET tool, run the following command:
32
35
@@ -36,20 +39,48 @@ To install SqlPackage as a global .NET tool, run the following command:
36
39
37
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).
38
41
39
-
40
42
To update SqlPackage to the latest version, run the following command:
41
43
42
44
```bash
43
45
dotnet tool update -g microsoft.sqlpackage
44
46
```
45
47
46
-
47
48
To uninstall SqlPackage, run the following command:
48
49
49
50
```bash
50
51
dotnet tool uninstall -g microsoft.sqlpackage
51
52
```
52
53
54
+
### Troubleshoot installation
55
+
56
+
If you encounter issues during installation, follow these steps:
57
+
58
+
1.**Ensure .NET SDK is installed**: Verify that the .NET SDK is installed on your machine by running the following command:
59
+
60
+
```bash
61
+
dotnet --list-sdks
62
+
```
63
+
64
+
If the .NET SDK isn't listed, download and install it from the [.NET SDK download page](https://dotnet.microsoft.com/download/dotnet/8.0).
65
+
66
+
2.**Verify NuGet source configuration**: Ensure that `nuget.org` is a configured NuGet source for dotnet. List the configured NuGet sources by running:
67
+
68
+
```bash
69
+
dotnet nuget list source
70
+
```
71
+
72
+
If `nuget.org` isn't listed, add it as a NuGet source using the following command:
3.**Retry installation**: After verifying the .NET SDK installation and NuGet source configuration, retry installing SqlPackage using the appropriate command:
79
+
80
+
```bash
81
+
dotnet tool install -g microsoft.sqlpackage
82
+
```
83
+
53
84
### Preview releases
54
85
55
86
Preview releases of SqlPackage are available with the dotnet tool feed. To access preview releases, use the `--prerelease` option with the `dotnet tool` command. For example, to install the latest preview release, run the following command:
@@ -66,37 +97,34 @@ To update SqlPackage to the latest preview version, run the following command:
66
97
67
98
A list of preview releases is available on the [dotnet tool feed for SqlPackage](https://www.nuget.org/packages/microsoft.sqlpackage/).
68
99
69
-
70
100
## Installation, file download (alternative)
71
101
72
102
SqlPackage is also prepared as a self-contained download for Windows, macOS, and Linux. No .NET install is required, however, the dependencies included in this .zip download are updated more frequently in the [dotnet tool option for SqlPackage](#installation-cross-platform). The following links are for the latest version of SqlPackage:
> You may have missing dependencies. Use the following commands to install these dependencies depending on your version of Linux:
126
+
> [!NOTE]
127
+
> You might have missing dependencies. Use the following commands to install these dependencies depending on your version of Linux:
100
128
101
129
**Debian:**
102
130
@@ -120,7 +148,7 @@ SqlPackage is also prepared as a self-contained download for Windows, macOS, and
120
148
### macOS
121
149
122
150
1. Download [SqlPackage for macOS](https://aka.ms/sqlpackage-macos)
123
-
2. Extract the file and launch SqlPackage, open a new Terminal window and type the following commands:
151
+
1. Extract the file and launch SqlPackage, open a new Terminal window and type the following commands:
124
152
125
153
```bash
126
154
mkdir sqlpackage
@@ -131,35 +159,37 @@ SqlPackage is also prepared as a self-contained download for Windows, macOS, and
131
159
sqlpackage
132
160
```
133
161
134
-
> [!NOTE]
135
-
> Security settings may require modification to run SqlPackage on macOS. Use the following commands to interact with Gatekeeper from the command line.
162
+
> [!NOTE]
163
+
> Security settings might require modification to run SqlPackage on macOS. Use the following commands to interact with Gatekeeper from the command line.
136
164
137
165
**Before executing SqlPackage:**
166
+
138
167
```bash
139
168
sudo spctl --master-disable
140
169
```
141
170
142
171
**After executing SqlPackage:**
172
+
143
173
```bash
144
174
sudo spctl --master-enable
145
175
```
146
176
147
177
### Windows (.NET 8)
148
178
149
179
1. Download [SqlPackage for Windows](https://aka.ms/sqlpackage-windows)
150
-
2. Extract the file by right-clicking on the file in Windows Explorer, and selecting 'Extract All...', and select the target directory
151
-
3. Open a new Terminal window and cd to the location where SqlPackage was extracted:
180
+
1. Extract the file by right-clicking on the file in Windows Explorer, and selecting 'Extract All...', and select the target directory
181
+
1. Open a new Terminal window and cd to the location where SqlPackage was extracted:
152
182
153
183
```cmd
154
184
> sqlpackage
155
185
```
156
186
157
187
### Windows (.NET Framework)
158
188
159
-
This release of SqlPackage includes a standard Windows installer experience, and a .zip:
189
+
This release of SqlPackage includes a standard Windows installer experience, and a .zip:
160
190
161
191
1. Download and run the [DacFramework.msi installer for Windows](https://aka.ms/dacfx-msi)
162
-
2. Open a new Command Prompt window, and run SqlPackage
192
+
1. Open a new Command Prompt window, and run SqlPackage
163
193
- SqlPackage is installed to the ```C:\Program Files\Microsoft SQL Server\160\DAC\bin``` folder
164
194
165
195
### Uninstall SqlPackage
@@ -171,6 +201,7 @@ If you installed SqlPackage with a .zip or other archive, then delete the files.
171
201
### Automated environments
172
202
173
203
Evergreen links are available for downloading the latest Sqlpackage versions:
204
+
174
205
- Linux ([https://aka.ms/sqlpackage-linux](https://aka.ms/sqlpackage-linux))
- Windows ([https://aka.ms/sqlpackage-windows](https://aka.ms/sqlpackage-windows))
@@ -186,10 +217,9 @@ Adding the NuGet package to a .NET project is accomplished via the .NET CLI with
186
217
dotnet add package Microsoft.SqlServer.DacFx
187
218
```
188
219
189
-
> [!NOTE]
220
+
> [!NOTE]
190
221
> 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.
191
222
192
-
193
223
## Supported Operating Systems
194
224
195
225
SqlPackage runs on Windows, macOS, and Linux and is built using .NET 8. The [.NET 8 OS requirements](https://github.com/dotnet/core/blob/main/release-notes/8.0/supported-os.md) are minimum requirements for SqlPackage, which has extra requirements due to its dependencies.
0 commit comments