Compartilhar via

Utilitário sqlps

  • Artigo

Aplica-se a: SQL Server Banco de Dados SQL do Azure Instância Gerenciada de SQL do Azure Azure Synapse Analytics Analytics Platform System (PDW)

O utilitário sqlps inicia uma sessão do Windows PowerShell 2.0 com os cmdlets e o provedor do SQL Server PowerShell carregados e registrados. Você pode inserir comandos ou scripts do PowerShell que usam os componentes do SQL Server PowerShell para trabalhar com instâncias do SQL Server e os respectivos objetos.

Importante

Esse recurso será removido em uma versão futura do SQL Server. Evite usar esse recurso em desenvolvimentos novos e planeje modificar os aplicativos que atualmente o utilizam. Use o módulo sqlps do PowerShell. Para saber mais sobre o módulo sqlps , veja Import the SQLPS Module.

Sintaxe

  
sqlps   
[ [ [ -NoLogo ][ -NoExit ][ -NoProfile ]  
    [ -OutPutFormat { Text | XML } ] [ -InPutFormat { Text | XML } ]  
  ]  
  [ -Command { -  
             | script_block [ -args argument_array ]  
             | string [ command_parameters ]  
             }  
  ]  
]  
[ -? | -Help ]

Argumentos

-NoLogo
Especifica que o utilitário sqlps oculta a faixa de direitos autorais quando é iniciado.

-NoExit
Especifica que o utilitário sqlps continua em execução após a conclusão dos comandos de inicialização.

-NoProfile
Especifica que o utilitário sqlps não carrega um perfil do usuário. Os perfis de usuário registram alias, funções e variáveis usados com frequência para uso em sessões do PowerShell.

-OutPutFormat { Text | XML }
Especifica que a saída do utilitário sqlps será formatada como cadeias de caracteres de texto (Text) ou em um formato CLIXML serializado (XML).

-InPutFormat { Text | XML }
Especifica que a entrada para o utilitário sqlps será formatada como cadeias de caracteres de texto (Text) ou em um formato CLIXML serializado (XML).

-Command
Especifica o comando para a execução do utilitário sqlps . O utilitário sqlps executa o comando e fecha em seguida, a menos que -NoExit também seja especificado. Não especifique outras opções depois de -Command, pois elas serão lidas como parâmetros de comando.

-
-Command especifica que o utilitário sqlps leia a entrada da entrada padrão.

script_block [ -argsargument_array ]
Especifica um bloco de comandos de PowerShell para executar. O bloco deve ficar entre chaves: {}. Script_block pode ser especificado apenas quando o utilitário sqlps é chamado do PowerShell ou de outra sessão do utilitário sqlps . O argument_array é uma matriz de variáveis do PowerShell que contêm os argumentos para os comandos do PowerShell em script_block.

string [ command_parameters ]
Especifica que uma cadeia de caracteres contendo os comandos do PowerShell seja executada. Use o formato "&{comando}". As aspas indicam uma cadeia de caracteres, e o operador de invocação (&) faz com que o utilitário sqlps execute o comando.

[ -? | -Help ]
Mostra o resumo da sintaxe de opções do utilitário sqlps .

Comentários

O utilitário sqlps inicia o ambiente do PowerShell (PowerShell.exe) e carrega o módulo do PowerShell do SQL Server. O módulo, também chamado sqlps, carrega e registra esses snap-ins do PowerShell do SQL Server:

  • Microsoft.SqlServer.Management.PSProvider.dll

    Implementa o provedor do PowerShell do SQL Server e os cmdlets associados, como Encode-SqlName e Decode-SqlName.

  • Microsoft.SqlServer.Management.PSSnapin.dll

    Implementa os cmdlets Invoke-Sqlcmd e Invoke-PolicyEvaluation .

É possível usar o utilitário sqlps para fazer o seguinte:

  • Executar comandos do PowerShell de forma interativa.

  • Executar arquivos de script do PowerShell.

  • Executar cmdlets do SQL Server.

  • Usar os caminhos do provedor do SQL Server para navegar pela hierarquia de objetos SQL Server.

Por padrão, o utilitário sqlps é executado com a política de execução de scripts definida como Restrita. Isso impede a execução de quaisquer scripts do PowerShell. Você pode usar o cmdlet Set-ExecutionPolicy a fim de habilitar a execução de scripts assinados ou de qualquer script. Execute apenas scripts de fontes confiáveis e proteja todos os arquivos de entrada e saída usando as permissões NTFS adequadas. Para obter mais informações sobre como habilitar scripts do PowerShell, consulte Running Windows PowerShell Scripts(a página pode estar em inglês).

A versão do utilitário sqlps no SQL Server 2008 (10.0.x) e no SQL Server 2008 R2 (10.50.x) foi implementada como um minishell do Windows PowerShell 1.0. Os minishells têm determinadas restrições, como não permitir que os usuários carreguem snap-ins diferentes dos carregados pelo minishell. Essas restrições não se aplicam à versão SQL Server 2012 (11.x) e posteriores do utilitário, que foi alterado para usar o módulo sqlps.

Exemplos

a. Executar o utilitário sqlps no modo interativo padrão, sem a faixa de direitos autorais

sqlps -NoLogo

B. Executar um script do SQL Server PowerShell no prompt de comando

sqlps -Command "&{.\MyFolder.MyScript.ps1}"

C. Executar um script do SQL Server PowerShell a partir do prompt de comando, e manter a execução após a conclusão do script

sqlps -NoExit -Command "&{.\MyFolder.MyScript.ps1}"

Consulte Também

Habilitar ou desabilitar um protocolo de rede do servidor
SQL Server PowerShell