Instalar o módulo do SQL Server PowerShell

Este artigo fornece orientações para instalar o módulo do SqlServer PowerShell.

Módulos PowerShell para SQL Server

Há dois módulos do SQL Server PowerShell:

• SqlServer: o módulo SqlServer inclui novos cmdlets para dar suporte aos recursos mais recentes do SQL. O módulo também contém versões atualizadas dos cmdlets no SQLPS. Para baixar o módulo SqlServer , acesse o módulo SqlServer na Galeria do PowerShell.

• SQLPS: O SQLPS é o módulo usado pelo SQL Agent para executar trabalhos de agente em etapas de trabalho do agente usando o subsistema do PowerShell.

Para obter artigos de ajuda, vá para:

• Cmdlets SqlServer.
• Cmdlets SQLPS.

SQL Server Management Studio (SSMS)

O SSMS (SQL Server Management Studio) não instala nenhum módulo do PowerShell. Para usar o PowerShell com o SSMS, instale o módulo SqlServer da Galeria do PowerShell.

Instalar ou atualizar o módulo SqlServer

Para instalar o módulo SqlServer da Galeria do PowerShell, inicie uma sessão do PowerShell e execute Install-Module SQLServer.

Install-Module -Name SqlServer

Se estiver sendo executado no Windows PowerShell, você poderá usar Install-Module SQLServer -Scope CurrentUser para instalar o módulo para o usuário atual e evitar a necessidade de permissões elevadas.

Instalar o módulo SqlServer para todos os usuários

Para instalar o módulo SqlServer para todos os usuários, execute o comando abaixo em uma sessão elevada do PowerShell; Inicie uma sessão do PowerShell como administrador:

Install-Module -Name SqlServer

Instalar o módulo SqlServer em um computador offline

Esta seção orienta você pelas etapas de instalação do módulo SqlServer PowerShell em um computador sem acesso à Internet. Você precisa de dois computadores para realizar essa instalação: um computador conectado à Internet e um computador de destino offline.

1. Em um computador conectado à Internet, baixe o módulo do SQLServer PowerShell. Esse comando baixa e salva todos os arquivos do módulo na pasta de exemplo $env:TEMP\SQLServer\<SomeVersion> , definida no -Path parâmetro. Você pode escolher uma pasta de sua preferência como um destino em seu computador conectado à Internet.

   Save-Module -Name SqlServer -Path $env:TEMP
   

2. Navegue até o local da pasta no Explorador de Arquivos para verificar se existe uma pasta $env:TEMP\SQLServer\<SomeVersion> ou execute este comando:

   Get-ChildItem -Path $env:TEMP\SQLServer\
   

3. Copie a pasta $env:TEMP\SQLServer\<SomeVersion> encontrada na etapa 2 para o computador offline de destino na pasta %ProgramFiles%\WindowsPowerShell\Modules\SqlServer (essa pasta funcionaria para PS5 e PS7). Substitua <SomeVersion> pelo valor encontrado na etapa anterior.

4. Confirme se o módulo do SqlServer PowerShell está disponível no computador offline executando o seguinte cmdlet do PowerShell:

   Get-Module SqlServer -ListAvailable
   

   A saída pode ter esta aparência (a versão real pode ser diferente e deve corresponder <SomeVersion> listada anteriormente):

      PS C:\Users\user1> Get-Module SqlServer -ListAvailable
   
          Directory: C:\Program Files\WindowsPowerShell\Modules
   
      ModuleType Version    Name                     ExportedCommands
      ---------- -------    ----                     ----------------
      Script     22.1.1     SqlServer                {Add-RoleMember, Add-SqlAvail...
   

Exibir as versões instaladas do módulo SqlServer

Execute o comando a seguir para ver as versões instaladas do módulo SqlServer .

Get-Module SqlServer -ListAvailable

Para exibir a versão do módulo SqlServer carregado na sessão atual

(Get-Module SqlServer).Version

Substituir uma versão anterior do módulo SqlServer

Também é possível usar o comando Install-Module para substituir uma versão anterior.

Install-Module -Name SqlServer -AllowClobber

Atualizar a versão instalada do módulo SqlServer

Quando as versões atualizadas do módulo SqlServer estiverem disponíveis será possível instalar a versão mais recente usando o seguinte comando:

Update-Module -Name SqlServer -AllowClobber

Você pode usar o Update-Module comando para instalar a versão mais recente do módulo SQLServer PowerShell, mas isso não remove versões mais antigas. Ele instala as versões mais recentes lado a lado para permitir que você experimente a versão mais recente enquanto ainda tem módulos mais antigos instalados.

Porém, se você não quiser manter as versões mais antigas do módulo, poderá usar o comando Uninstall-Module para remover as versões anteriores.

Caso mais de uma versão esteja instalada é possível usar o seguinte comando para listá-las:

Get-Module SqlServer -ListAvailable

É possível usar o seguinte comando para remover as versões mais antigas:

Uninstall-module -Name SQLServer -RequiredVersion "<version number>"

Solucionar problemas

Se tiver problemas na instalação, consulte a documentação Install-Module e a referência Install-Module.

Usar uma versão específica do módulo SqlServer

Para usar uma versão específica do módulo, importe-a com um número de versão específico, semelhante ao seguinte comando:

Import-Module SqlServer -Version 21.1.18218

Versões de pré-lançamento do módulo SqlServer

Versões de pré-lançamento (ou "versão prévia") do módulo SqlServer podem estar disponíveis na Galeria do PowerShell.

Encontrar as versões de pré-lançamento do módulo SqlServer

Para descobrir as versões de pré-lançamento (versão prévia) do módulo SqlServer , execute o seguinte comando:

Find-Module SqlServer -AllowPrerelease

Instalar uma versão pré-lançamento específica do módulo SqlServer

Para instalar uma versão pré-lançamento específica do módulo, instale-a com um número de versão específico.

Você pode tentar usar o seguinte comando:

Install-Module SqlServer -RequiredVersion 21.1.18218-preview -AllowPrerelease

SQL Server PowerShell no Linux

Visite /sql/linux/sql-server-linux-manage-powershell-core para ver como instalar o SQL Server PowerShell no Linux.

Outros módulos

• Az.Sql – cmdlets do serviço SQL para o Azure Resource Manager no Windows PowerShell e no PowerShell.

• SqlServerDsc – Módulo com recursos DSC para implantar e configurar o Microsoft SQL Server.

Referência de cmdlet

• Cmdlets do SqlServer
• Cmdlets do SQLPS

Conteúdo relacionado

• O que é o SQL Server PowerShell?
• Cmdlets do SQL Server PowerShell
• Suporte do Editor do PowerShell para o Azure Data Studio