Obter 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.
Antes de começar
Para saber mais sobre o Windows PowerShell, consulte o Guia de Introdução do Windows PowerShell.
Para obter uma visão geral sobre o provedor e os cmdlets do SQL Server, consulte SQL Server PowerShell.
Ajude no ambiente de Windows PowerShell
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.
Para obter mais informações sobre os modos você pode usar Get-Help, consulte Get-Help: Obtendo Ajuda.
Ajuda do provedor do SQL Server PowerShell
O provedor SQL Server PowerShell implementa várias pastas em uma unidade virtual SQLSERVER, como as pastas SQLSERVER:\SQL e SQLSERVER:\DAC. Cada pasta é associada com um dos modelos de objeto de gerenciamento do SQL Server. Enquanto você puder listar os métodos e propriedades associadas com cada nó em um caminho de SQL Server, não poderá obter ajuda por eles no ambiente PowerShell. Para obter uma tabela das pastas com links para a referência de programação associada, consulte Provedor do SQL Server PowerShell.
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:
Variáveis e comandos do sqlcmd. Para obter informações sobre essas variáveis e comandos, consulte a seção Comentários de Utilitário sqlcmd.
Instruções Transact-SQL. Para obter mais informações sobre a linguagem Transact-SQL, consulte Referência do Transact-SQL (Mecanismo de Banco de Dados).
Instruções XQuery. Para obter mais informações sobre a linguagem XQuery com suporte do SQL Server, consulte Referência de linguagem Xquery (SQL Server).
Obtenha Ajuda para um cmdlet de SQL Server
Para obter Ajuda para um cmdlet
- Execute Get-Help especificando o nome do cmdlet e o nível de ajuda a ser retornada.
Exemplo: cmdlet Get-Help
Os exemplos a seguir retornam vários níveis de ajuda para Invoke-Sqlcmd:
## Get the basic help.
Get-Help Invoke-Sqlcmd
## Get the full help.
Get-Help Invoke-Sqlcmd –Full
## Get the parameter descriptions.
Get-Help Invoke-Sqlcmd -Parameter *
## Get the code examples.
Get-Help Invoke-Sqlcmd –Examples
## Get the syntax diagram.
Get-Help Invoke-Sqlcmd –Syntax
Obtenha uma lista de provedores
Para obter uma lista de provedores ativos
- Execute Get-Help especificando a categoria de provedor.
Para obter mais informações sobre como obter ajuda do provedor no Windows PowerShell, consulte Unidades e Provedores.
Exemplo: obtenha uma lista de provedores
Esse código retorna uma lista de provedores habilitados atualmente em sua sessão do Windows PowerShell:
Get-Help -Category provider
Obter ajuda sobre o provedor do SQL Server
Para obter ajuda sobre o provedor
- Execute Get-Help especificando o nome SQL Server
Exemplo: Obtenha ajuda do provedor SQL Server
Este exemplo retorna informações básicas sobre o provedor do SQL Server:
Get-Help SQLServer
Listar métodos e propriedades
Para listar os métodos e propriedades para um nó em um caminho de provedor do SQL Server
O CD para um nó no caminho do SQL Server ou crie uma variável definida para esse local.
Execute o cmdlet Get-Member com o parâmetro –Type definido como Métodos ou Propriedades
Exemplos: listando métodos e propriedades
Este exemplo lista os métodos com suporte para o nó Bancos de Dados:
Set-Location SQL:\MyComputer\DEFAULT\Databases
Get-Item . | Get-Member -Type Methods
Esse exemplo 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