• Artigo

Ajuda do SQL Server PowerShell

Há várias origens de informações sobre como usar o provedor e os cmdlets do provedor do SQL Server para Windows PowerShell. Isso inclui a ajuda que está disponível no ambiente Windows PowerShell.

Informações Gerais

Para obter mais informações sobre recursos que você pode usar para conhecer o Windows PowerShell, consulte Aprendendo sobre o PowerShell.

Para obter uma visão geral sobre o provedor e os cmdlets do SQL Server, consulte Visão geral do SQL Server PowerShell.

Usando o Get-Help

Use o cmdlet Get-Help para obter ajuda no ambiente Windows PowerShell. O Get-Help fornece ajuda básica para a linguagem Windows PowerShell e os diversos cmdlets e provedores disponíveis no Windows PowerShell.

Os cmdlets do SQL Server Windows PowerShell oferecem suporte ao Get-Help. O Get-Help retorna informações sobre o uso do cmdlet, como sintaxe e descrições de parâmetro. Os exemplos a seguir retornam a ajuda completa para o Invoke-Sqlcmd, a ajuda apenas para os parâmetros e a ajuda apenas para os exemplos:

Get-Help Invoke-Sqlcmd -Full
Get-Help Invoke-Sqlcmd -Parameter *
Get-Help Invoke-Sqlcmd -Examples

Para obter mais informações sobre como você pode usar o Get-Help para aprender mais sobre os cmdlets, consulte Get-Help: Obtendo Ajuda.

O provedor do SQL Server Windows PowerShell também oferece suporte ao Get-Help. Por exemplo, esse código retorna informações básicas sobre o provedor do SQL Server:

Get-Help SQLServer

Esse código retorna uma lista de provedores habilitados atualmente em sua sessão do Windows PowerShell:

Get-Help -Category provider

Para obter mais informações sobre como obter ajuda do provedor no Windows PowerShell, consulte Unidades e Provedores.

Ajuda do Invoke-Sqlcmd

O cmdlet Invoke-Sqlcmd usa como entrada qualquer consulta ou arquivo de script que possa ser executado pelo utilitário sqlcmd. Você pode usar o Get-Help para obter informações sobre o Invoke-Sqlcmd e seus parâmetros, mas o Get-Help não oferece cobertura para consultas sqlcmd.

A entrada -Query ou -QueryFromFile pode conter:

Ajuda do provedor do SQL Server

O provedor do SQL Server expõe a hierarquia de objetos do SQL Server em caminhos semelhantes aos caminhos do sistema de arquivos. Por exemplo, esse é o caminho para a tabela Vendor no esquema Purchasing do banco de dados AdventureWorks2008R2 em uma instância padrão do Mecanismo de Banco de Dados:

SQL:\MyComputer\DEFAULT\Databases\AdventureWorks2008R2\Tables\Purchasing.Vendor

O provedor implementa nós de unidade diferentes para os objetos cobertos por modelos de objeto de gerenciamento do SQL Server (SMO) diferentes. Caminhos com a unidade SQL: usam os objetos cobertos pelos objetos de gerenciamento do SQL Server (SMO), como tabelas e exibições. Quando você navega até um nó em um caminho, é possível usar os métodos e as propriedades de modelo de objeto que se aplicam a esse tipo de objeto.

Você pode usar o cmdlet Get-Member para aprender quais métodos e propriedades estão disponíveis para um nó de caminho. Por exemplo, é possível executar esse código para consultar os métodos suportados para o nó Bancos de Dados:

Set-Location SQL:\MyComputer\DEFAULT\Databases
Get-Item . | Get-Member -Type Methods

Esse código lista as propriedades de uma variável que foi definida como um objeto Tabela SMO:

$MyVar = New-Object Microsoft.SqlServer.Management.SMO.Table
$MyVar | Get-Member -Type Properties

A documentação relacionada aos modelos de objeto para unidades diferentes é: