Freigeben über


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.

Allgemeine Informationen

Ressourcen zum Erlernen von Windows PowerShell finden Sie unter Erlernen von PowerShell.

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

Verwenden von 'Get-Help'

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.

Die SQL Server-Cmdlets unterstützen Get-Help. Get-Help gibt Verwendungsinformationen zu Cmdlets zurück, z. B. Syntax- und Parameterbeschreibungen. Die folgenden Beispiele geben die vollständige Hilfe für Invoke-Sqlcmd, Hilfe nur zu den Parametern und dann Hilfe nur zu den Beispielen zurück:

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

Weitere Informationen darüber, wie Sie mithilfe von Get-Help mehr über Cmdlets erfahren können, finden Sie unter Get-Help: Getting Help.

Der SQL Server-Anbieter unterstützt ebenfalls Get-Help. Mit diesem Code werden z. B. grundlegende Informationen über den SQL Server-Anbieter zurückgegeben:

Get-Help SQLServer

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

Get-Help -Category provider

Weitere Informationen darüber, wie Sie in Windows PowerShell Hilfe zu den Anbietern erhalten können, finden Sie unter Drives and Providers.

Invoke-Sqlcmd-Hilfe

Das Cmdlet Invoke-Sqlcmd nimmt beliebige Abfragen oder Skriptdateien als Eingabe auf, die vom sqlcmd-Dienstprogramm 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:

SQL Server-Anbieterhilfe

Der SQL Server-Anbieter macht die Hierarchie von SQL Server-Objekten in Pfaden auf eine Weise verfügbar, die den Dateisystempfaden ähnelt. Dies ist beispielsweise der Pfad zur Tabelle Vendor im Schema Purchasing der Datenbank AdventureWorks in einer Standardinstanz von Database Engine (Datenbankmodul):

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

Der Anbieter implementiert verschiedene Laufwerksknoten für die von verschiedenen SQL Server Management Object-Modellen abgedeckten Objekte. Pfade mit dem Laufwerk SQL: verwenden die von SQL Server Management Objects (SMO) abgedeckten Objekte wie Tabellen und Sichten. Wenn Sie zu einem Knoten in einem Pfad navigieren, können Sie die auf den Objekttyp anwendbaren SMO-Methoden und -Eigenschaften verwenden.

Sie können das Cmdlet Get-Member verwenden, um zu erfahren, welche Methoden und Eigenschaften für einen Pfadknoten verfügbar sind. Zum Beispiel können Sie diesen Code ausführen, um die für den Knoten Databases unterstützten Methoden anzuzeigen:

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

Mit diesem Code 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

Die Dokumentation für die Objektmodelle für die verschiedenen Laufwerke lautet: