Freigeben über

Hilfe zu SQL Server PowerShell abrufen

Es gibt mehrere Informationsquellen zur Verwendung des SQL Server-Anbieters für Windows PowerShell und Cmdlets. Dies schließt die Hilfe ein, die in der Windows PowerShell-Umgebung verfügbar ist.

Bevor Sie beginnen

Informationen zu Windows PowerShell finden Sie im Handbuch für die ersten 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 zu erhalten. Get-Help bietet grundlegende Hilfe für die Windows PowerShell-Sprache und die verschiedenen Cmdlets und Anbieter, die in Windows PowerShell verfügbar sind.

Weitere Informationen zu den Möglichkeiten, wie Sie Get-Help verwenden können, finden Sie unter "Get-Help: Getting Help".

Sql Server PowerShell-Anbieterhilfe

Der SQL Server PowerShell-Anbieter implementiert mehrere Ordner auf einem virtuellen SQLSERVER-Laufwerk, z. B. sqlserver:\SQL und SQLSERVER:\DAC-Ordner. Jeder Ordner ist einem der SQL Server-Verwaltbarkeitsobjektmodelle zugeordnet. Sie können zwar die Methoden und Eigenschaften auflisten, die jedem Knoten in einem SQL Server-Pfad zugeordnet sind, aber Sie können in der PowerShell-Umgebung keine Hilfe für sie erhalten. Eine Tabelle der Ordner mit Links zur zugeordneten Programmierreferenz finden Sie unter SQL Server PowerShell Provider.

Invoke-Sqlcmd Hilfe

Das Cmdlet Invoke-Sqlcmd verwendet jede Abfrage- oder Skriptdatei, die vom sqlcmd-Hilfsprogramm ausgeführt werden kann. Sie können Get-Help verwenden, um Informationen zu Invoke-Sqlcmd und den zugehörigen Parametern abzurufen, aber es gibt keine Get-Help-Abdeckung für die sqlcmd-Abfragen .

Die Eingabe -Query oder -QueryFromFile kann Folgendes enthalten:

Hilfe zu einem SQL Server-Cmdlet abrufen

So erhalten Sie Hilfe zu einem cmdlet

  • Führen Sie Get-Help aus, indem Sie den Namen des Cmdlets und die Ebene der zurückzugebenden Hilfe angeben.

Beispiel: Cmdlet-Get-Help

In den folgenden Beispielen werden verschiedene Hilfeebenen 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

Liste von Anbietern abrufen

So rufen Sie eine Liste der aktiven Anbieter ab

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

Weitere Informationen zum Abrufen von Anbieterhilfen in Windows PowerShell finden Sie unter "Laufwerke und Anbieter".

Beispiel: Abrufen einer Liste von Anbietern

Dieser Code gibt eine Liste der Anbieter zurück, die derzeit in Ihrer Windows PowerShell-Sitzung aktiviert sind:

Get-Help -Category provider

Abrufen von Hilfe zum SQL Server-Anbieter

So erhalten Sie Hilfe zum Anbieter

  1. Starten Sie Get-Help und geben Sie den Namen SQLServer an

Beispiel: Abrufen der SQL Server-Anbieterhilfe

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

Get-Help SQLServer

Methoden und Eigenschaften auflisten

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

  1. Entweder wechseln Sie zu einem Knoten im SQL-Server-Pfad, oder erstellen Sie eine Variable, die auf diesen Ort verweist.

  2. Führen Sie das Cmdlet Get-Member mit dem Parameter -Type aus, festgelegt auf Methoden oder Eigenschaften.

Beispiele: Auflisten von Methoden und Eigenschaften

In diesem Beispiel werden die methoden aufgeführt, die für den Knoten "Datenbanken" unterstützt werden:

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 Table-Objekt festgelegt wurde:

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

Siehe auch

SQL Server PowerShell-Anbieter
Verwenden Sie die Cmdlets des Datenbankmoduls

  • Last updated on