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.
Vorbereitungen
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 nimmt beliebige Abfragen oder Skriptdateien als Eingabe auf, die vom sqlcmd-Hilfsprogramm ausgeführt werden können. Mithilfe von Get-Help können Sie Informationen über Invoke-Sqlcmd und die zugehörigen Parameter aufrufen, Get-Help funktioniert jedoch nicht bei sqlcmd-Abfragen.
Die -Query- oder -QueryFromFile-Eingabe kann Folgendes enthalten:
sqlcmd-Variablen und -Befehle. Weitere Informationen zu diesen Variablen und Befehlen finden Sie unter sqlcmd (Hilfsprogramm) im Abschnitt "Hinweise".
Transact-SQL-Anweisungen. Weitere Informationen zur Transact-SQL-Sprache finden Sie unter Transact-SQL-Referenz (Datenbankmodul).
XQuery-Anweisungen. Weitere Informationen zu der von SQL Server unterstützten XQuery-Sprache finden Sie unter XQuery-Sprachreferenz (SQL Server).
Aufrufen von Hilfe für ein SQL Server-Cmdlet
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
Abrufen einer Liste von Anbietern
So rufen Sie eine Liste aktiver Anbieter ab
- 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
Aufrufen von Hilfe zum SQL Server-Anbieter
So rufen Sie Hilfe zum Anbieter auf
- 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
Auflisten von Methoden und Eigenschaften
So listen Sie die Methoden und die Eigenschaften für einen Knoten in einem SQL Server-Anbieterpfad auf
Verweisen Sie mit CD auf einen Knoten im SQL Server-Pfad, oder erstellen Sie einen Variablensatz zu diesem Speicherort.
Ausführen des Get-Member-Cmdlet, 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