Install SQL Server PowerShell module

• 01/31/2019
• 2 minutes to read
• • 
  • 
  • 
  • 
  • 
  • +2

APPLIES TO: SQL Server Azure SQL Database Azure Synapse Analytics (SQL DW) Parallel Data Warehouse

This article provides directions for installing the SqlServer PowerShell module.

Previous versions of the SqlServer module were included with SQL Server Management Studio (SSMS), but only with the 16.x versions of SSMS. To use PowerShell with SSMS 17.0 and later, the SqlServer module must be installed from the PowerShell Gallery.

Pre-release versions of the module may become available more frequently: please refer to the section at the bottom of this page on how to get such versions of the module.

To install the SqlServer module from the PowerShell Gallery, start a PowerShell session and use the following commands. If you run into problems installing, see the Install-Module documentation and Install-Module reference.

To install the SqlServer module:

Install-Module -Name SqlServer

If there are previous versions of the SqlServer module on the computer, you may be able to use Update-Module (later in this article), or provide the -AllowClobber parameter:

Install-Module -Name SqlServer -AllowClobber

If you are not able to run the PowerShell session as administrator, you can install for the current user:

Install-Module -Name SqlServer -Scope CurrentUser

When updated versions of the SqlServer module are available, you can update the version using Update-Module:

Update-Module -Name SqlServer

To view the versions of the module installed:

Get-Module SqlServer -ListAvailable

To use a specific version of the module, you can import it with a specific version number similar to the following:

Import-Module SqlServer -Version 21.1.18080

The versions of the SqlServer module in the PowerShell Gallery support versioning and require PowerShell version 5.0 or greater.

• SqlServer module in the PowerShell Gallery
• SqlServer cmdlets
• SQLPS cmdlets