Aufrufen der SQL Server PowerShell-Hilfe

 

Es stehen mehrere Informationsquellen zur Verwendung des SQL Server-Anbieters für Windows PowerShell und Cmdlets zur Verfügung. Dazu gehört auch die Hilfe, die in der Windows PowerShell-Umgebung verfügbar ist.

Informationen zu Windows PowerShell finden Sie unter Erste Schritte mit Windows PowerShell.

Eine Übersicht über die SQL Server-Cmdlets und -Anbieter finden Sie unter SQL Server PowerShell.

Hilfe in der Windows PowerShell-Umgebung

Verwenden Sie das Cmdlet Get-Help, um Hilfe in der Windows PowerShell-Umgebung aufzurufen. Get-Help stellt grundlegende Hilfe zur Windows PowerShell-Sprache und den verschiedenen in Windows PowerShell verfügbaren Cmdlets und Anbietern bereit.

Weitere Informationen zur Verwendung von Get-Help finden Sie unter Abrufen von Hilfeinformationen: Get-Help.

SQL Server PowerShell-Anbieterhilfe

Der SQL Server PowerShell-Anbieter implementiert mehrere Ordner auf einem virtuellen SQLSERVER-Laufwerk, z. B. die Ordner SQLSERVER:\SQL und SQLSERVER:\DAC. Jeder Ordner ist einem der SQL Server-Verwaltbarkeitsobjektmodelle zugeordnet. Während Sie die jedem Knoten zugeordneten Methoden und Eigenschaften in einem SQL Server-Pfad auflisten können, können Sie dafür keine Hilfe in der PowerShell-Umgebung abrufen. Eine Tabelle mit den Ordnern mit Links zur zugeordneten Referenzdokumentation zur Programmierung finden Sie unter SQL Server PowerShell-Anbieter.

Invoke-Sqlcmd-Hilfe

Das Cmdlet Invoke-Sqlcmd akzeptiert alle Abfragen oder Skriptdateien als Eingabe, die vom sqlcmd-Hilfsprogramm ausgeführt werden können. Sie können mit Get-Help Informationen zu Invoke-Sqlcmd und den zugehörigen Parametern abrufen. Get-Help kann jedoch nicht für die sqlcmd-Abfragen verwendet werden.

Die Eingaben -Query oder -QueryFromFile können Folgendes enthalten:

So rufen Sie Hilfe für ein Cmdlet auf

  • Führen Sie "Get-Help" aus, und geben Sie dabei den Namen des Cmdlet und die Ebene der Hilfe an, die zurückgegeben werden soll.

Beispiel: Cmdlet Get-Help

In den folgenden Beispielen werden verschiedene Ebenen der Hilfe für Invoke-Sqlcmd zurückgegeben:

## 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  

So rufen Sie eine Liste aktiver Anbieter ab

  1. Führen Sie "Get-Help" aus, und geben Sie dabei die Anbieterkategorie an.

Weitere Informationen darüber, wie Sie in Windows PowerShell Hilfe zu den Anbietern erhalten können, finden Sie unter Laufwerke und Anbieter.

Beispiel: Abrufen einer Liste von Anbietern

Mit diesem Code wird eine Liste der Anbieter, die gerade in der Windows PowerShell-Sitzung aktiviert sind, zurückgegeben:

Get-Help -Category provider  

So rufen Sie Hilfe zum Anbieter auf

  1. Ausführen von "Get-Help" mit Angabe des Namens "SQLServer"

Beispiel: Aufrufen von Hilfe zum SQL Server-Anbieter

In diesem Beispiel werden grundlegende Informationen zum SQL Server-Anbieter zurückgegeben:

Get-Help SQLServer  

So listen Sie die Methoden und die Eigenschaften für einen Knoten in einem SQL Server-Anbieterpfad auf

  1. Verweisen Sie mit CD auf einen Knoten im SQL Server-Pfad, oder erstellen Sie einen Variablensatz zu diesem Speicherort.

  2. Ausführen des Get-Member-Cmdlets, wobei der –Type-Parameter auf „Methoden“ oder „Eigenschaften“ festgelegt ist

Beispiele: Auflisten von Methoden und Eigenschaften

In diesem Beispiel sind die für den Datenbankknoten unterstützten Methoden aufgeführt:

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

In diesem Beispiel werden die Eigenschaften für eine Variable aufgelistet, die auf ein SMO-Tabellenobjekt festgelegt wurde:

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

SQL Server PowerShell-Anbieter
Verwenden der Datenbankmodul-Cmdlets

Community-Beiträge

HINZUFÜGEN
Anzeigen: