Invoke-Sqlcmd-Cmdlet
Invoke-Sqlcmd ist ein SQL Server-Cmdlet, das Skripts ausführt, die Anweisungen aus den Sprachen (Transact-SQL und XQuery) und Befehlen enthalten, die vom Dienstprogramm sqlcmd unterstützt werden.
Verwenden von Invoke-Sqlcmd
Mit dem Invoke-Sqlcmd-Cmdlet können Sie die sqlcmd-Skriptdateien in einer Windows PowerShell-Umgebung ausführen. Viele der Vorgänge, die Sie mit sqlcmd durchführen können, können auch mit Invoke-Sqlcmd durchgeführt werden.
Dies ist ein Beispiel für den Aufruf von Invoke-Sqlcmd zum Ausführen einer einfachen Abfrage, die dem Festlegen von sqlcmd mit den Optionen -Q und -S ähnelt:
Invoke-Sqlcmd -Query "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance "MyComputer\MyInstance"
Dies ist ein Beispiel für den Aufruf von Invoke-Sqlcmd, in dem eine Eingabedatei angegeben und die Ausgabe an eine Datei weitergeleitet wird. Dies ähnelt dem Festlegen von sqlcmd mit der -i-Option und der -o-Option:
Invoke-Sqlcmd -InputFile "C:\MyFolder\TestSQLCmd.sql" | Out-File -filePath "C:\MyFolder\TestSQLCmd.rpt"
Dies ist ein Beispiel für die Verwendung eines Windows PowerShell-Arrays zum Übergeben von mehreren sqlcmd-Skriptvariablen an Invoke-Sqlcmd. Die "$"-Zeichen, die die sqlcmd-Skriptvariablen in der SELECT-Anweisung identifizieren, wurden mit dem PowerShell-Escapezeichen "`" versehen:
$MyArray = "MyVar1 = 'String1'", "MyVar2 = 'String2'"
Invoke-Sqlcmd -Query "SELECT `$(MyVar1) AS Var1, `$(MyVar2) AS Var2;" -Variable $MyArray
Dies ist ein Beispiel für die Verwendung des SQL Server-Anbieters für Windows PowerShell zur Navigation zu einer Instanz von Database Engine (Datenbankmodul) und zur anschließenden Verwendung des Windows PowerShell-Cmdlets Get-Item, um das SMO-Serverobjekt für die Instanz abzurufen und es an Invoke-Sqlcmd zu übergeben:
Set-Location SQLSERVER:\SQL\MyComputer\MyInstance
Invoke-Sqlcmd -Query "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance (Get-Item .)
Der Query-Parameter ist ein Positionsparameter und muss nicht benannt werden. Wenn die erste Zeichenfolge, die an Invoke-Sqlcmd übergeben wird, nicht benannt ist, wird dieser als Query-Parameter behandelt.
Invoke-Sqlcmd "SELECT GETDATE() AS TimeOfQuery;" -ServerInstance "MyComputer\MyInstance"
Pfadkontext in Invoke-Sqlcmd
Wenn Sie den Database-Parameter nicht verwenden, wird der Datenbankkontext für Invoke-Sqlcmd vom Pfad gesetzt, der aktiv ist, wenn cmdlet aufgerufen wird.
Pfad |
Datenbankkontext |
|---|---|
Beginnt mit einem anderen Laufwerk als SQLSERVER: |
Die Standarddatenbank für die Anmelde-ID in der Standardinstanz auf dem lokalen Computer. |
SQLSERVER:\SQL |
Die Standarddatenbank für die Anmelde-ID in der Standardinstanz auf dem lokalen Computer. |
SQLSERVER:\SQL\ComputerName |
Die Standarddatenbank für die Anmelde-ID in der Standardinstanz auf dem angegebenen Computer. |
SQLSERVER:\SQL\ComputerName\InstanceName |
Die Standarddatenbank für die Anmelde-ID in der angegebenen Instanz auf dem angegebenen Computer. |
SQLSERVER:\SQL\ComputerName\InstanceName\Databases |
Die Standarddatenbank für die Anmelde-ID in der angegebenen Instanz auf dem angegebenen Computer. |
SQLSERVER:\SQL\ComputerName\InstanceName\Databases\DatabaseName |
Die angegebene Datenbank in der angegebenen Instanz auf dem angegebenen Computer. Dies gilt auch für längere Pfade, wie z. B. einen Pfad, der den Knoten Tabellen und Spalten innerhalb einer Datenbank angibt. |
Nehmen wir beispielsweise an, dass die Standarddatenbank für Ihr Windows-Konto in der Standardinstanz auf dem lokalen Computer die master-Datenbank ist. Dann geben die folgenden Befehle master zurück:
Set-Location SQLSERVER:\SQL
Invoke-Sqlcmd "SELECT DB_NAME() AS DatabaseName;"
Die folgenden Befehle würden AdventureWorks2012 zurückgeben:
Set-Location SQLSERVER:\SQL\MyComputer\DEFAULT\Databases\AdventureWorks2012\Tables\Person.Person
Invoke-Sqlcmd "SELECT DB_NAME() AS DatabaseName;"
Invoke-Sqlcmd stellt eine Warnung bereit, wenn es den Pfaddatenbankkontext verwendet. Sie können den SuppressProviderContextWarning-Parameter verwenden, um die Warnmeldung zu deaktivieren. Sie können den IgnoreProviderContext-Parameter verwenden, um Invoke-Sqlcmd anzuweisen, immer die Standarddatenbank für die Anmeldung zu verwenden.
Vergleichen von Invoke-Sqlcmd und dem sqlcmd-Hilfsprogramm
Mit Invoke-Sqlcmd können zahlreiche der Skripts ausgeführt werden, die auch mit dem sqlcmd-Hilfsprogramm ausgeführt werden können. Invoke-Sqlcmd wird jedoch in einer Windows PowerShell-Umgebung ausgeführt, die sich von der Eingabeaufforderungsumgebung unterscheidet, in der sqlcmd ausgeführt wird. Das Verhalten von Invoke-Sqlcmd wurde für die Ausführung in einer Windows PowerShell-Umgebung angepasst.
Nicht alle sqlcmd-Befehle sind in Invoke-Sqlcmd implementiert. Zu den nicht implementierten Befehlen gehören: :!!, :connect, :error, :out, :ed, :list, :listvar, :reset, :perftrace, and :serverlist.
Invoke-Sqlcmd initialisiert die sqlcmd-Umgebung oder Skriptvariablen wie SQLCMDDBNAME oder SQLCMDWORKSTATION nicht.
Invoke-Sqlcmd zeigt keine Meldungen, wie die Ausgabe von PRINT-Anweisungen, an, außer Sie geben den gängigen Windows PowerShell-Parameter -Verbose an. Beispiel:
Invoke-Sqlcmd -Query "PRINT N'abc';" -Verbose
Nicht alle sqlcmd-Parameter werden in einer PowerShell-Umgebung benötigt. Beispielsweise formatiert Windows PowerShell alle Ausgaben von Cmdlets, sodass die sqlcmd-Parameter, die Formatierungsoptionen festlegen, nicht in Invoke-Sqlcmd implementiert werden. In der folgenden Tabelle wird die Beziehung zwischen den Invoke-Sqlcmd-Parametern und den sqlcmd-Optionen dargestellt:
Beschreibung |
sqlcmd-Option |
Invoke-Sqlcmd-Parameter |
|---|---|---|
Server- und Instanzname. |
-S |
-ServerInstance |
Die zu verwendende ursprüngliche Datenbank. |
-d |
-Database |
Die angegebene Abfrage ausführen und dann beenden. |
-Q |
-Query |
Anmelde-ID für die SQL Server-Authentifizierung. |
-U |
-Username |
Kennwort für die SQL Server-Authentifizierung. |
-P |
-Password |
Variablendefinition. |
-v |
-Variable |
Abfragetimeoutintervall. |
-t |
-QueryTimeOut |
Ausführung bei Fehler beenden. |
-b |
-AbortOnError |
Dedizierte Administratorverbindung. |
-A |
-DedicatedAdministratorConnection |
Interaktive Befehle, Startskript und Umgebungsvariablen deaktivieren. |
-X |
-DisableCommands |
Variablenersetzung deaktivieren. |
-x |
-DisableVariables |
Minimaler Schweregrad für Bericht. |
-V |
-SeverityLevel |
Minimaler Fehlergrad für Bericht. |
-m |
-ErrorLevel |
Anmeldungstimeoutintervall. |
-l |
-ConnectionTimeout |
Hostname. |
-H |
-HostName |
Kennwort ändern und beenden. |
-Z |
-NewPassword |
Eingabedatei, die eine Abfrage enthält |
-i |
-InputFile |
Maximale Länge der Zeichenausgabe. |
-w |
-MaxCharLength |
Maximale Länge der Binärausgabe. |
-w |
-MaxBinaryLength |
Verbinden mit SSL-Verschlüsselung. |
Kein Parameter |
-EncryptConnection |
Anzeigen von Fehlern |
Kein Parameter |
-OutputSqlErrors |
Meldungen an stderr ausgeben. |
-r |
Kein Parameter |
Regionale Einstellungen des Clients verwenden |
-R |
Kein Parameter |
Die angegebene Abfrage ausführen und mit der Ausführung fortfahren. |
-q |
Kein Parameter |
Codepage zur Verwendung für Ausgabedaten. |
-f |
Kein Parameter |
Ein Kennwort ändern und mit der Ausführung fortfahren |
-z |
Kein Parameter |
Paketgröße |
-a |
Kein Parameter |
Spaltentrennzeichen |
-s |
Kein Parameter |
Steuern von Ausgabeheadern |
-h |
Kein Parameter |
Angeben von Steuerzeichen |
-k |
Kein Parameter |
Feste Längenanzeigebreite |
-Y |
Kein Parameter |
Variable Längenanzeigebreite |
-y |
Kein Parameter |
Eingabe auf dem Bildschirm anzeigen. |
-e |
Kein Parameter |
Bezeichner in Anführungszeichen aktivieren |
-I |
Kein Parameter |
Nachfolgende Leerzeichen löschen. |
-W |
Kein Parameter |
Instanzen auflisten |
-L |
Kein Parameter |
Ausgabe als Unicode formatieren |
-u |
Kein Parameter |
Statistiken drucken |
-p |
Kein Parameter |
Befehlsende |
-c |
Kein Parameter |
Verbindung mithilfe der Windows-Authentifizierung herstellen |
-E |
Kein Parameter |