Usando o cmdlet do Invoke-Sqlcmd

Usando o Invoke-Sqlcmd

O cmdlet do Invoke-Sqlcmd permite executar os arquivos de script sqlcmd em um ambiente do Windows PowerShell. Quase tudo o que pode ser feito com o sqlcmd também pode ser feito usando o Invoke-Sqlcmd.

Este é um exemplo de chamada do Invoke-Sqlcmd para executar uma consulta simples, semelhante à especificação de sqlcmd com as opções -Q e -S:

Invoke-Sqlcmd -Query "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance "MyComputer\MyInstance"

Este é um exemplo de chamada do Invoke-Sqlcmd, especificando um arquivo de entrada e indicando o resultado em um arquivo. Esse processo é semelhante à especificação de sqlcmd com as opções -i e -o:

Invoke-Sqlcmd -InputFile "C:\MyFolder\TestSQLCmd.sql" | Out-File -filePath "C:\MyFolder\TestSQLCmd.rpt"

Este é um exemplo do uso de uma matriz do Windows PowerShell para passar diversas variáveis de script do sqlcmd para o Invoke-Sqlcmd. O caractere "$" que identifica as variáveis de script do sqlcmd na instrução SELECT foi substituída pelo caractere de escape "`" do PowerShell:

$MyArray = "MyVar1 = 'String1'", "MyVar2 = 'String2'"
Invoke-Sqlcmd -Query "SELECT `$(MyVar1) AS Var1, `$(MyVar2) AS Var2;" -Variable $MyArray

Este é um exemplo do uso do provedor do SQL Server para Windows PowerShell para navegar por uma instância do Mecanismo de Banco de Dados e, em seguida, usar o cmdlet Get-Item do Windows PowerShell para recuperar o objeto Servidor SMO da instância e passá-lo para o Invoke-Sqlcmd:

Set-Location SQLSERVER:\SQL\MyComputer\MyInstance
Invoke-Sqlcmd -Query "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance (Get-Item .)

O parâmetro -Query é posicional e não tem que ser nomeado. Se a primeira cadeia de caracteres que é transmitida a Invoke-Sqlcmd: não é nomeada, ela é tratada como o parâmetro - Query.

Invoke-Sqlcmd "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance "MyComputer\MyInstance"

Contexto de caminho em Invoke-Sqlcmd

Se você não usar o parâmetro -Database, o contexto do banco de dados para Invoke-Sqlcmd será definido pelo caminho que estiver ativo quando o cmdlet é chamado.

Por exemplo, suponha que o banco de dados padrão de sua conta do Windows na instância padrão do computador local seja o master. Os seguintes comandos retornariam master:

Set-Location SQLSERVER:\SQL
Invoke-Sqlcmd "SELECT DB_NAME() AS DatabaseName;"

Os comandos a seguir retornariam AdventureWorks2008R2:

Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks2008R2\Tables\Person.Person
Invoke-Sqlcmd "SELECT DB_NAME() AS DatabaseName;"

Invoke-Sqlcmd fornece um aviso quando usa o contexto do banco de dados de caminho. Você pode usar o parâmetro -SuppressProviderContextWarning para desativar a mensagem de aviso. Você pode usar o parâmetro -IgnoreProviderContext para pedir que Invoke-Sqlcmd use sempre o banco de dados padrão para logon.

Comparando o Invoke-Sqlcmd e o utilitário sqlcmd

O Invoke-Sqlcmd pode ser usado para executar muitos dos scripts que podem ser executados usando o utilitário sqlcmd. Entretanto, Invoke-Sqlcmd é executado em um ambiente Windows PowerShell que é diferente do ambiente de prompt de comando no qual o sqlcmd é executado. O comportamento de Invoke-Sqlcmd foi modificado para funcionar em um ambiente PowerShell.

Nem todos os comandos do sqlcmd são implementados no Invoke-Sqlcmd. Dentre os comandos que não são implementados estão: :!!, :connect, :error, :out, :ed, :list, :listvar, :reset, :perftrace e :serverlist.

O Invoke-Sqlcmd não inicializa o ambiente sqlcmd ou as variáveis de scripts, como SQLCMDDBNAME ou SQLCMDWORKSTATION.

Invoke-Sqlcmd não exibe mensagens, como o resultado das instruções PRINT, a menos que você especifique o parâmetro comum -Verbose do Windows PowerShell. Por exemplo:

Invoke-Sqlcmd -Query "PRINT N'abc';" -Verbose

Nem todos os parâmetros do sqlcmd são necessários em um ambiente PowerShell. Por exemplo, o Windows PowerShell formata todas as saídas dos cmdlets, de modo que as opções de formatação de especificação de parâmetros do sqlcmd não sejam implementadas no Invoke-Sqlcmd. A tabela a seguir mostra a relação entre os parâmetros do Invoke-Sqlcmd e as opções do sqlcmd:

Consulte também

Referência

Conceitos