Compartilhar via

Obter ajuda do SQL Server PowerShell

Há várias fontes de informações sobre como usar o provedor do SQL Server para Windows PowerShell e cmdlets. Isso inclui a ajuda disponível no ambiente do 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 dos cmdlets e do provedor do SQL Server, consulte o SQL Server PowerShell.

Ajuda no ambiente do Windows PowerShell

Use o cmdlet Get-Help para obter ajuda no ambiente do Windows PowerShell. O Get-Help fornece ajuda básica para o idioma do Windows PowerShell e os vários cmdlets e provedores disponíveis no Windows PowerShell.

Para obter mais informações sobre como você pode usar Get-Help, consulte Get-Help: Getting Help.

Ajuda do provedor do SQL Server PowerShell

O provedor do SQL Server PowerShell implementa várias pastas em uma unidade virtual SQLSERVER, como as pastas SQLSERVER:\SQL e SQLSERVER:\DAC. Cada pasta está associada a um dos modelos de objeto de gerenciamento do SQL Server. Embora você possa listar os métodos e propriedades associados a cada nó em um caminho do SQL Server, não é possível obter ajuda para eles no ambiente do PowerShell. Para obter uma tabela das pastas com links para a referência de programação associada, consulte o Provedor do SQL Server PowerShell.

Ajuda Invoke-Sqlcmd

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

A entrada -Query ou -QueryFromFile pode conter:

Obter ajuda para um cmdlet do SQL Server

Para obter ajuda para um cmdlet

  • Execute Get-Help especificando o nome do cmdlet e o nível de ajuda a ser retornado.

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

Obter uma lista de provedores

Para obter uma lista de provedores ativos

  1. Execute Get-Help especificando a categoria do provedor.

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

Exemplo: obter uma lista de provedores

Esse código retorna uma lista dos provedores atualmente habilitados 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

  1. Execute Get-Help especificando o nome SQLServer

Exemplo: Obter ajuda do provedor do SQL Server

Este exemplo retorna informações básicas sobre o provedor do SQL Server:

Get-Help SQLServer

Listar métodos e propriedades

Listar os métodos e as propriedades de um nó em um caminho de provedor do SQL Server

  1. CD para um nó no caminho do SQL Server ou crie uma variável configurada para esse local.

  2. 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 suportados para o nó Bancos de Dados:

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

Este exemplo lista as propriedades de uma variável que foi definida como um objeto de tabela SMO:

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

Consulte Também

Provedor do SQL Server PowerShell
Usar cmdlets do Mecanismo de Banco de Dados

  • Last updated on