Instalar o módulo SQL Server PowerShell

  • Artigo

Aplica-se a:SQL ServerBanco de Dados SQL do AzureInstância Gerenciada de SQL do AzureAzure Synapse AnalyticsPDW (Analytics Platform System)

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, vá para Módulo SqlServer na Galeria do PowerShell.

Observação

As versões do módulo SqlServer na Galeria do PowerShell são compatíveis com controle de versão e exigem o PowerShell na versão 5.1 ou superior.

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

Para obter artigos de ajuda, vá para:

Observação

No contexto dos módulos SqlServer e SQLPS, é possível que determinados nomes de comando existam em ambos os módulos.

Isso pode gerar um conflito quando um módulo já está instalado e o outro está sendo instalado ou atualizado. Para evitar esse conflito, o parâmetro -AllowClobber pode ser usado ao instalar ou atualizar o módulo. Além disso, ao importar um dos módulos, é necessário remover o outro primeiro ou usar o parâmetro -DisableNameChecking para evitar erro. Essas medidas garantem que os módulos possam coexistir sem causar nenhum problema.

SQL Server Management Studio

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

Observação

O SQL Server Management Studio (SSMS) 16.x (e versões anteriores) incluía o módulo SQLPS.

Azure Data Studio

O Azure Data Studio não instala nenhum desses módulos do PowerShell. Para usar o PowerShell com o Azure Data Studio, instale o módulo SqlServer da Galeria do PowerShell.

É possível usar a extensão do PowerShell, que fornece suporte avançado ao editor do PowerShell no Azure Data Studio.

Instalar ou atualizar o módulo SqlServer

Para instalar o módulo SqlServer na 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 do PowerShell com privilégios elevados; 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ê nas etapas de instalação do módulo SqlServer do PowerShell em um computador sem acesso à Internet. Você precisa de dois computadores para realizar esta instalação: um computador conectado à Internet e o computador de destino offline (não conectado à Internet).

  1. Em um computador conectado à Internet, baixe o módulo SQLServer PowerShell. Esse comando baixa e salva todos os arquivos do módulo no exemplo da pasta $env:TEMP\SQLServer\<SomeVersion>, o que é definido no parâmetro -Path. 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 do módulo SqlServer que foram instaladas.

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

Observação

O PowerShell sempre usa o módulo mais recente instalado.

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

É possível usar o comando Update-Module para instalar a versão mais recente do módulo SQL Server PowerShell, mas isso não removerá as versões mais antigas. Ele instala a versão mais recente lado a lado para permitir que você experimente a última versão, enquanto os módulos mais antigos ainda estão 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

As versões pré-lançamento (ou "prévias") do módulo SqlServer podem estar disponíveis na Galeria do PowerShell.

Importante

Essas versões podem ser encontradas e instaladas usando os cmdlets Find-Module e Install-Module atualizados que fazem parte do módulo PowerShellGet passando a opção -AllowPrerelease. Para usar esses cmdlets, instale o módulo PowerShellGet e abra uma nova sessão.

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

Para encontrar as versões pré-lançamento (prévias) 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 Gerenciar o SQL Server em Linux com o PowerShell Core para saber 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 de DSC para implantação e configuração do Microsoft SQL Server.

Referência de cmdlet

Conteúdo relacionado