SQLCMD-Hilfsprogramm

Mit dem sqlcmd Hilfsprogramm können Sie Transact-SQL-Anweisungen, Systemprozeduren und Skriptdateien an der Eingabeaufforderung in Abfrage-Editor im SQLCMD-Modus, in einer Windows-Skriptdatei oder in einem Auftragsschritt (Cmd.exe) eines SQL Server-Agent Auftrags eingeben. Für dieses Hilfsprogramm wird ODBC verwendet, um Transact-SQL-Batches auszuführen.

Derzeit erfordert sqlcmd kein Leerzeichen zwischen der Befehlszeilenoption und dem Wert. In einer zukünftigen Version kann jedoch ein Leerzeichen zwischen der Befehlszeilenoption und dem Wert erforderlich sein.

Syntax

  
   sqlcmd  
   -a  
   packet_size  
   -A (dedicated administrator connection)  
-b (terminate batch job if there is an error)  
-cbatch_terminator-C (trust the server certificate)  
-ddb_name-e (echo input)  
-E (use trusted connection)  
-fcodepage | i:codepage[,o:codepage] | o:codepage[,i:codepage]  
-hrows_per_header-Hworkstation_name-iinput_file-I (enable quoted identifiers)  
-k[1 | 2] (remove or replace control characters)  
-Kapplication_intent-llogin_timeout-L[c] (list servers, optional clean output)  
-merror_level-Mmultisubnet_failover-N (encrypt connection)  
-ooutput_file-p[1] (print statistics, optional colon format)  
-Ppassword-q "cmdline query"-Q "cmdline query" (and exit)  
-r[0 | 1] (msgs to stderr)  
-R (use client regional settings)  
-scol_separator-S [protocol:]server[\instance_name][,port]  
-tquery_timeout-u (unicode output file)  
-Ulogin_id-vvar = "value"-Verror_severity_level-wcolumn_width-W (remove trailing spaces)  
-x (disable variable substitution)  
-X[1] (disable commands, startup script, environment variables and optional exit)  
-yvariable_length_type_display_width-Yfixed_length_type_display_width-znew_password -Znew_password (and exit)  
  
-? (usage)  

Befehlszeilenoptionen

Anmeldungsvorgänge
-A
Bewirkt die Anmeldung bei SQL Server über eine dedizierte Administratorverbindung (DAC). Diese Verbindungsart wird verwendet, um Serverprobleme zu behandeln. Diese Option kann nur bei Servercomputern verwendet werden, die DAC unterstützen. Wenn DAC nicht verfügbar ist, generiert sqlcmd eine Fehlermeldung und wird dann beendet. Weitere Informationen zu DAC finden Sie unter Diagnoseverbindung für Datenbankadministratoren.

-C
Dieser Schalter wird vom Client verwendet, um ihn so zu konfigurieren, dass er dem Serverzertifikat ohne Überprüfung implizit vertraut. Diese Option entspricht der ADO.NET-Option TRUSTSERVERCERTIFICATE = true.

-d Datenbankname
Gibt beim Start sqlcmdeine USE db_name Anweisung aus. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDDBNAME festgelegt. Hierdurch wird die Ausgangsdatenbank angegeben. Der Standardwert ist die Standarddatenbank-Eigenschaft der Anmelde-ID. Wenn die Datenbank nicht vorhanden ist, wird eine Fehlermeldung generiert und sqlcmd beendet.

-l login_timeout
Gibt an, wie viele Sekunden bei der Herstellung einer Verbindung mit einem Server verstreichen dürfen, bevor für eine sqlcmd-Anmeldung beim ODBC-Treiber ein Timeout eintritt. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDLOGINTIMEOUT festgelegt. Der Standardwert für das Timeout eines sqlcmd-Anmeldevorgangs ist acht Sekunden. Der Timeoutwert für den Anmeldungszeitraum muss eine Zahl zwischen 0 und 65534 sein. Wenn der angegebene Wert kein numerischer Wert ist oder außerhalb dieses Bereichs liegt, generiert sqlcmd eine Fehlermeldung. Mit dem Wert 0 wird eine unbegrenzte Wartezeit festgelegt.

-E
Verwendet eine vertrauenswürdige Verbindung anstelle eines Benutzernamens und eines Kennworts für die Anmeldung bei SQL Server. Standardmäßig wird von sqlcmd die vertrauenswürdige Verbindung verwendet, wenn -E nicht angegeben ist.

Die Option -E ignoriert mögliche Umgebungsvariableneinstellungen für Benutzernamen und Kennwörter, z.B. SQLCMDPASSWORD. Wird die Option -E zusammen mit der Option -U oder der Option -P verwendet, wird eine Fehlermeldung generiert.

-H Arbeitsstationsname
Der Name einer Arbeitsstation. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDWORKSTATION festgelegt. Der Name der Arbeitsstation wird in der hostname-Spalte der sys.processes-Katalogsicht aufgeführt, und der Name kann mithilfe der gespeicherten Prozedur sp_who zurückgegeben werden. Wenn diese Option nicht angegeben ist, wird standardmäßig der Name des aktuellen Computers angenommen. Mithilfe dieses Namens können verschiedene sqlcmd-Sitzungen identifiziert werden.

-K Anwendungsabsicht
Deklariert den Arbeitsauslastungstyp der Anwendung beim Herstellen einer Verbindung mit einem Server. Der einzige derzeit unterstützte Wert ist ReadOnly. Wenn -K nicht angegeben wird, unterstützt das sqlcmd-Hilfsprogramm keine Konnektivität mit einem sekundären Replikat in einer AlwaysOn-Verfügbarkeitsgruppe. Weitere Informationen finden Sie unter Active Secondaries: Lesbare sekundäre Replikate.

-Mmultisubnet_failover
Geben Sie immer -M an, wenn Sie eine Verbindung mit dem Verfügbarkeitsgruppenlistener einer SQL Server-Verfügbarkeitsgruppe oder einer SQL Server-Failoverclusterinstanz herstellen. -M gewährleistet eine schnellere Erkennung und Verbindung mit dem (gerade) aktiven Server. Wenn -M nicht angegeben ist, wird -M deaktiviert. Weitere Informationen zu AlwaysOn-Verfügbarkeitsgruppen finden Sie unter Verfügbarkeitsgruppenlistener, Clientkonnektivität und Anwendungsfailover (SQL Server),Erstellung und Konfiguration von Verfügbarkeitsgruppen (SQL Server), Failoverclustering- und AlwaysOn-Verfügbarkeitsgruppen (SQL Server) und active Secondaries: Lesbare sekundäre Replikate .

-N
Dieser Schalter wird vom Client verwendet, um eine verschlüsselte Verbindung anzufordern.

-P Kennwort
Ein vom Benutzer angegebenes Kennwort. Bei Kennwörtern wird nach Groß- und Kleinschreibung unterschieden. Wenn die Option "-U" verwendet wird und die Option "-P " nicht verwendet wird und die SQLCMDPASSWORD-Umgebungsvariable nicht festgelegt wurde, wird der Benutzer aufgefordert, sqlcmd ein Kennwort einzugeben. Wenn die Option "-P " am Ende der Eingabeaufforderung ohne Kennwort sqlcmd verwendet wird, wird das Standardkennwort (NULL) verwendet.

Die Aufforderung zur Eingabe des Kennworts wird folgendermaßen an der Konsole ausgegeben: Password:

Die Benutzereingabe bleibt verborgen. d. h. es erfolgt keine Anzeige, und der Cursor bleibt an der Anfangsposition.

Über die SQLCMDPASSWORD-Umgebungsvariable können Sie ein Standardkennwort für die aktuelle Sitzung festlegen. Aus diesem Grund ist die Hartcodierung von Kennwörtern in Batchdateien nicht notwendig.

Im folgenden Beispiel wird zuerst die SQLCMDPASSWORD-Variable an der Eingabeaufforderung festgelegt und dann auf das Hilfsprogramm sqlcmd zugegriffen. Geben Sie an der Eingabeaufforderung Folgendes ein:

SET SQLCMDPASSWORD= p@a$$w0rd

Geben Sie Folgendes an der daraufhin angezeigten Eingabeaufforderung ein:

sqlcmd

Wenn die Kombination aus Benutzername und Kennwort falsch ist, wird eine Fehlermeldung generiert.

Wird die Option -P zusammen mit der Option -E verwendet, wird eine Fehlermeldung generiert.

Werden nach der Option -P mehrere Argumente angegeben, wird eine Fehlermeldung generiert und das Programm beendet.

-S [protocol:]server[\Instanzname][,port]
Gibt die SQL Server-Instanz an, mit der eine Verbindung hergestellt werden soll. Durch die Option wird die sqlcmd-Skriptvariable SQLCMDSERVER festgelegt.

Geben Sie server_name an, um eine Verbindung mit der Standardinstanz von SQL Server auf diesem Servercomputer herzustellen. Geben Sie server_name [ \Instanzname ] an, um eine Verbindung mit der benannten Instanz von SQL Server auf diesem Servercomputer herzustellen. Wenn kein Servercomputer angegeben ist, sqlcmd wird eine Verbindung mit der Standardinstanz von SQL Server auf dem lokalen Computer hergestellt. Diese Option ist erforderlich, wenn Sie von einem Remotecomputer im Netzwerk aus ausgeführt werden sqlcmd .

Protokoll kann Folgendes sein: tcp (TCP/IP), lpc (Shared Memory) oder np (Named Pipes).

Wenn Sie beim Start sqlcmdkein server_name [ \instance_name ] angeben, sucht SQL Server nach der SQLCMDSERVER-Umgebungsvariable und verwendet sie.

-U login_id
Die Benutzeranmelde-ID.

Wenn weder die Option -U noch die Option -P angegeben ist, versucht, sqlcmd eine Verbindung über den Microsoft Windows-Authentifizierungsmodus herzustellen. Die Authentifizierung basiert auf dem Windows-Konto des Benutzers, der sqlcmd ausführt.

Wird die Option -U zusammen mit der Option -E verwendet (weiter unten in diesem Thema beschrieben), wird eine Fehlermeldung generiert. Werden nach der Option -U mehrere Argumente angegeben, wird eine Fehlermeldung generiert und das Programm beendet.

-z neues_Kennwort
Kennwort ändern:

sqlcmd -U someuser -P s0mep@ssword -z a_new_p@a$$w0rd

-Z neues_Kennwort
Kennwort ändern und beenden:

sqlcmd -U someuser -P s0mep@ssword -Z a_new_p@a$$w0rd

Eingabe-/Ausgabeoptionen
-f Codepage | i:Codepage[,o:Codepage] | o:Codepage[,i:Codepage]
Gibt die Eingabe- und Ausgabecodepages an. Die Codepagenummer ist ein numerischer Wert, der eine installierte Windows-Codepage angibt.

Regeln zum Konvertieren von Codepages:

• Wenn keine Codepages angegeben sind, verwendet sqlcmd die aktuelle Codepage sowohl für Eingabe- als auch für Ausgabedateien, außer wenn es sich bei der Eingabedatei um eine Unicode-Datei handelt, da in diesem Fall keine Konvertierung erforderlich ist.

• sqlcmd erkennt Unicode-Eingabedateien des Formats Big-Endian bzw. Little-Endian automatisch. Wenn die Option -u angegeben wurde, handelt es sich bei der Ausgabe stets um Unicode-Dateien des Formats Little-Endian.

• Wenn keine Ausgabedatei angegeben wurde, handelt es sich bei der Ausgabe-Codepage um die Codepage der Konsole. Auf diese Weise wird die Ausgabe richtig auf der Konsole angezeigt.

• Wenn mehrere Eingabedateien angegeben wurden, wird davon ausgegangen, dass sie dieselbe Codepage verwenden. Unicode- und Nicht-Unicode-Eingabedateien können gemischt verwendet werden.

Geben Sie an der Eingabeaufforderung chcp ein, um die Codepage von Cmd.exe zu überprüfen.

-i input_file[,input_file2...]
Identifiziert die Datei, die einen Batch mit SQL-Anweisungen oder gespeicherten Prozeduren enthält. Sie können mehrere Dateien angeben, die der Reihe nach gelesen und verarbeitet werden. Verwenden Sie keine Leerzeichen zwischen Dateinamen. sqlcmd prüft zunächst, ob alle angegebenen Dateien vorhanden sind. Wenn eine oder mehrere Dateien nicht vorhanden sind, wird sqlcmd beendet. Die Optionen -i und -Q/-q schließen sich gegenseitig aus.

Beispiele für Pfade:

-i C:\<filename>

-i \\<Server>\<Share$>\<filename>

-i "C:\Some Folder\<file name>"

Dateipfade, die Leerzeichen enthalten, müssen in Anführungszeichen eingeschlossen werden.

Diese Option kann mehrmals verwendet werden: -iinput_file -I input_file.

-o Ausgabedatei
Identifiziert die Datei, in die die Ausgabe von sqlcmd geschrieben wird.

Ist -u angegeben, wird die Ausgabedatei im Unicode-Format gespeichert. Wenn der Dateiname ungültig ist, wird eine Fehlermeldung generiert und sqlcmd beendet. sqlcmd unterstützt nicht das gleichzeitige Schreiben mehrerer sqlcmd-Prozesse in die gleiche Datei. In diesem Fall wäre die Dateiausgabe beschädigt oder fehlerhaft. Weitere Informationen zu Dateiformaten finden Sie in den Erläuterungen zum Schalter -f . Falls sie noch nicht vorhanden ist, wird die Datei erstellt. Eine möglicherweise aus einer früheren sqlcmd-Sitzung verbliebene Datei wird überschrieben. Bei der hier angegebenen Datei handelt es sich nicht um die stdout -Datei. Wenn eine stdout -Datei angegeben ist, wird diese Datei nicht verwendet.

Beispiele für Pfade:

-o C:\< Dateiname>

-o \\<Server>\<Share$>\<filename>

**-o "**C:\Some Folder\<file name>"

Dateipfade, die Leerzeichen enthalten, müssen in Anführungszeichen eingeschlossen werden.

-r[0 | 1]
Leitet die Ausgabe der Fehlermeldung auf den Bildschirm um (stderr). Wenn Sie keinen Parameter bzw. wenn Sie 0angeben, werden nur Fehlermeldungen mit dem Schweregrad 11 oder höher umgeleitet. Wenn Sie 1angeben, wird die gesamte Fehlermeldungsausgabe (einschließlich der Ausgabe von PRINT) umgeleitet. Dies hat keine Wirkung, wenn Sie die Option -o verwenden. Standardmäßig werden Meldungen an stdoutgesendet.

-R
Dient sqlcmd zum Lokalisieren numerischer, Währungs-, Datums- und Uhrzeitspalten, die von SQL Server basierend auf dem Gebietsschema des Clients abgerufen werden. Standardmäßig werden diese Spalten entsprechend den regionalen Einstellungen des Servers angezeigt.

-u
Gibt an, dass Ausgabedatei unabhängig vom Format von Eingabedateiim Unicode-Format gespeichert wird.

Abfrageausführungsoptionen
-e
Schreibt Eingabeskripts in das Standardausgabegerät (stdout).

-I
Legt die SET QUOTED_IDENTIFIER-Verbindungsoption auf ON fest. Die Standardeinstellung ist OFF. Weitere Informationen finden Sie unter SET QUOTED_IDENTIFIER (Transact-SQL).

-q" cmdline-Abfrage "
Führt eine Abfrage aus, wenn sqlcmd startet, beendet sqlcmd jedoch nicht, nachdem die Ausführung der Abfrage abgeschlossen ist. Es können mehrere durch Semikolons getrennte Abfragen ausgeführt werden. Schließen Sie die Abfrage in Anführungszeichen ein, wie im folgenden Beispiel gezeigt wird.

Geben Sie an der Eingabeaufforderung Folgendes ein:

sqlcmd -d AdventureWorks2012 -q "SELECT FirstName, LastName FROM Person.Person WHERE LastName LIKE 'Whi%';"

sqlcmd -d AdventureWorks2012 -q "SELECT TOP 5 FirstName FROM Person.Person;SELECT TOP 5 LastName FROM Person.Person;"

Wird -b zusammen mit dieser Option angegeben, wird sqlcmd mit einem Fehler beendet. Der Schalter -b wird weiter unten in diesem Thema beschrieben.

-Q" cmdline-Abfrage "
Führt eine Abfrage aus, wenn sqlcmd startet, und beendet sqlcmd unmittelbar im Anschluss. Es können mehrere durch Semikolons getrennte Abfragen ausgeführt werden.

Schließen Sie die Abfrage in Anführungszeichen ein, wie im folgenden Beispiel gezeigt wird.

Geben Sie an der Eingabeaufforderung Folgendes ein:

sqlcmd -d AdventureWorks2012 -Q "SELECT FirstName, LastName FROM Person.Person WHERE LastName LIKE 'Whi%';"

sqlcmd -d AdventureWorks2012 -Q "SELECT TOP 5 FirstName FROM Person.Person;SELECT TOP 5 LastName FROM Person.Person;"

Wird -b zusammen mit dieser Option angegeben, wird sqlcmd mit einem Fehler beendet. Der Schalter -b wird weiter unten in diesem Thema beschrieben.

-t Abfragetimeout
Gibt die Anzahl von Sekunden an, bevor ein Befehl (oder eine SQL-Anweisung) eine Zeitüberschreitung vorgibt. Diese Option legt die sqlcmd Skriptvariable SQLCMDSTATTIMEOUT fest. Wenn kein time_out Wert angegeben ist, wird kein Timeout für den Befehl ausgeführt. Die Abfrage**time_out muss eine Zahl zwischen 1 und 65534 sein. Wenn der angegebene Wert kein numerischer Wert ist oder außerhalb dieses Bereichs liegt, generiert sqlcmd eine Fehlermeldung.

-vvar = Wert[ var = Wert...]
Erstellt eine sqlcmdSkriptvariable, die in einem sqlcmd Skript verwendet werden kann. Setzen Sie den Wert in Anführungszeichen, falls er Leerzeichen enthält. Sie können mehrere Var="values-Werte angeben. Wenn einer der angegebenen Werte fehlerhaft ist, generiert sqlcmd eine Fehlermeldung und wird beendet.

sqlcmd -v MyVar1=something MyVar2="some thing"

sqlcmd -v MyVar1=something -v MyVar2="some thing"

-x
Bewirkt, dass sqlcmd Skriptvariablen ignoriert. Dies erweist sich als nützlich, wenn ein Skript mehrere INSERT-Anweisungen enthält, die Zeichenfolgen im selben Format wie reguläre Variablen enthalten können, etwa $(Variablenname).

Formatierungsoptionen
-h headers
Gibt die Anzahl der Zeilen an, die zwischen den Spaltenüberschriften ausgegeben werden. Standardmäßig werden die Überschriften für jedes Resultset der Abfrage einmal gedruckt. Diese Option legt die sqlcmd Skriptvariable SQLCMDHEADERS fest. Mit -1 können Sie angeben, dass keine Überschriften ausgegeben werden sollen. Ein ungültiger Wert bewirkt, dass sqlcmd eine Fehlermeldung generiert und dann beendet wird.

-k [1 | 2]
Entfernt alle Steuerzeichen aus der Ausgabe, z. B. Tabstoppzeichen und Neue-Zeile-Zeichen. Hierdurch bleibt die Spaltenformatierung erhalten, wenn Daten zurückgegeben werden. Wenn 1 angegeben wird, werden die Steuerzeichen durch ein einzelnes Leerzeichen ersetzt. Wenn 2 angegeben wird, werden aufeinanderfolgende Steuerzeichen durch ein einzelnes Leerzeichen ersetzt. -k ist der Gleiche wie -k1.

-s col_separator
Gibt das Spaltentrennzeichen an. Der Standardwert ist ein Leerzeichen. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDCOLSEP festgelegt. Um Zeichen verwenden zu können, die für das Betriebssystem eine besondere Bedeutung haben, z. B. das kaufmännische Und-Zeichen (&) oder das Semikolon (;), müssen Sie das Zeichen in Anführungszeichen (") einschließen. Das Spaltentrennzeichen kann ein beliebiges 8-Bit-Zeichen sein.

-w Spaltenbreite
Gibt die Bildschirmbreite für die Ausgabe an. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDCOLWIDTH festgelegt. Die Spaltenbreite muss eine Zahl größer als 8 und kleiner als 65536 sein. Wenn die angegebene Spaltenbreite außerhalb dieses Bereichs liegt, generiert sqlcmd eine Fehlermeldung. Die Standardbreite beträgt 80 Zeichen. Wenn eine Ausgabezeile die angegebene Spaltenbreite überschreitet, wird sie in die nächste Zeile umbrochen.

-W
Mit dieser Option werden nachfolgende Leerzeichen aus einer Spalte entfernt. Verwenden Sie diese Option zusammen mit der Option -s , um Daten vorzubereiten, die in eine andere Anwendung exportiert werden sollen. Diese Option kann nicht mit der Option -y oder -Y verwendet werden.

-y Anzeigebreite_bei_Typen_mit_variabler_Länge
Legt die sqlcmd-Skriptvariable SQLCMDMAXVARTYPEWIDTH fest. Der Standardwert ist 256. Sie begrenzt die Anzahl der Zeichen, die für die großen Datentypen variabler Länge zurückgegeben werden:

• varchar(max)

• nvarchar(max)

• varbinary(max)

• xml

• UDT (user-defined data types)

• text

• ntext

• image

-Y Anzeigebreite_bei_Typen_mit_fester_Länge
Legt die sqlcmd-Skriptvariable SQLCMDMAXFIXEDTYPEWIDTH fest. Der Standardwert ist 0 (unbegrenzt). Er begrenzt die Anzahl der zurückgegebenen Zeichen für die folgenden Datentypen:

• char(n ), wobei 1<=n<=8000

• nchar(nn ), wobei 1<=n<=4000

• varchar(nn ), wobei 1<=n<=8000

• nvarchar(nn ), wobei 1<=n<=4000

• varbinary(nn ), wobei 1<=n<=4000

• variant

Optionen für die Fehlerberichterstellung
-b
Gibt an, dass sqlcmd beendet und ein DOS ERRORLEVEL-Wert zurückgegeben wird, wenn ein Fehler auftritt. Für die DOS ERRORLEVEL-Variable wird der Wert 1 zurückgegeben, wenn der Schweregrad der SQL Server-Fehlermeldung größer als 10 ist. Andernfalls wird der Wert 0 zurückgegeben. Wenn die Option -V zusätzlich zu -b festgelegt wurde, meldet sqlcmd keinen Fehler, wenn der Schweregrad kleiner ist als die mithilfe von -V festgelegten Werte. Mit Eingabeaufforderungs-Batchdateien kann der Wert von ERRORLEVEL getestet und der Fehler entsprechend behoben werden. sqlcmd meldet keine Fehler für Schweregrad 10 (Informationsmeldungen).

Wenn das sqlcmd-Skript einen falschen Kommentar bzw. einen Syntaxfehler enthält oder eine Skriptvariable fehlt, wird der ERRORLEVEL-Wert 1 zurückgegeben.

-m Fehlerebene
Steuert, welche Fehlermeldungen an stdoutgesendet werden. Fehlermeldungen mit einem Schweregrad, der größer oder gleich diesem Wert ist, werden gesendet. Wenn dieser Wert auf -1festgelegt ist, werden alle Meldungen gesendet, einschließlich der Informationsmeldungen. Es sind keine Leerzeichen zwischen -m und -1zulässig. Beispielsweise ist -m-1 gültig, -m -1 jedoch nicht.

Mit dieser Option wird außerdem die sqlcmd-Skriptvariable SQLCMDERRORLEVEL festgelegt. Diese Variable hat den Standardwert 0.

-Verror_severity_level
Steuert den Schweregrad, der zur Festlegung der ERRORLEVEL-Variable verwendet wird. Für Fehlermeldungen mit einem Schweregrad, der größer oder gleich diesem Wert ist, wird ERRORLEVEL festgelegt. Werte kleiner 0 werden als 0 zurückgegeben. Batch- und CMD-Dateien können verwendet werden, um den Wert der ERRORLEVEL-Variable zu testen.

Sonstige Optionen
-a Paketgröße
Fordert ein Paket einer anderen Größe an. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDPACKETSIZE festgelegt. packet_size muss einen Wert zwischen 512 und 32767 haben. Der Standardwert lautet 4096. Ein höherer Wert für die Paketgröße kann das Leistungsverhalten beim Ausführen von Skripts verbessern, die zahlreiche SQL-Anweisungen zwischen GO-Befehlen aufweisen. Sie können eine größere Paketgröße anfordern. Wird die Anforderung jedoch verweigert, verwendet sqlcmd die Standardeinstellung des Servers für die Paketgröße.

-c Batchterminator
Gibt das Batchabschlusszeichen an. Standardmäßig werden Befehle abgeschlossen und an SQL Server gesendet, indem das Wort „GO“ in eine eigene Zeile eingegeben wird. Wenn Sie das Batchabschlusszeichen neu festlegen, dürfen Sie keine für Transact-SQL reservierten Schlüsselwörter oder Zeichen verwenden, die eine spezielle Bedeutung für das Betriebssystem haben, und zwar auch dann nicht, wenn vor dem Wort bzw. Zeichen ein umgekehrter Schrägstrich steht.

-L[c]
Listet die lokal konfigurierten Servercomputer sowie die Namen der Servercomputer auf, die Broadcastnachrichten über das Netzwerk senden. Dieser Parameter kann nicht in Verbindung mit anderen Parametern verwendet werden. Es können maximal 3.000 Servercomputer aufgelistet werden. Wenn die Serverliste aufgrund der Puffergröße abgeschnitten wurde, wird eine Warnmeldung angezeigt.

Wenn der optionale Parameter c angegeben ist, wird die Ausgabe ohne die Kopfzeile Server: angezeigt. Jede Serverzeile wird ohne führende Leerzeichen ausgegeben. Dies wird als einfache Ausgabe bezeichnet. Durch die einfache Ausgabe wird die Verarbeitungsleistung von Skriptsprachen verbessert.

-p[1]
Gibt Leistungsstatistiken für jedes Resultset aus. Folgende Ausgabe ist ein Beispiel für das Format von Leistungsstatistiken:

Network packet size (bytes): n

x xact[s]:

Clock Time (ms.): total t1 avg t2 (t3 xacts per sec.)

Hierbei gilt:

x = Anzahl der Transaktionen, die von SQL Server verarbeitet werden.

t1 = Gesamtdauer aller Transaktionen.

t2 = Durchschnittliche Dauer einer einzelnen Transaktion.

t3 = Durchschnittliche Anzahl von Transaktionen pro Sekunde.

Alle Zeitangaben erfolgen in Millisekunden.

Wird der optionale Parameter 1 angegeben, wird die Statistik im durch Doppelpunkte getrennten Format ausgegeben, das problemlos in eine Kalkulationstabelle importiert oder von einem Skript verarbeitet werden kann.

Wenn der optionale Parameter ein anderer Wert als 1 ist, wird ein Fehler generiert und sqlcmd beendet.

-X[1]
Deaktiviert Befehle, die die Systemsicherheit gefährden können, wenn sqlcmd von einer Batchdatei aus ausgeführt wird. Die deaktivierten Befehle werden weiterhin erkannt; sqlcmd gibt eine Warnmeldung aus und setzt die Ausführung fort. Wenn der optionale Parameter 1 angegeben ist, sqlcmd wird eine Fehlermeldung generiert und dann beendet. Die folgenden Befehle werden deaktiviert, wenn die Option -X verwendet wird:

• ED

• !! Befehl

Die Angabe der Option -X verhindert, dass Umgebungsvariablen an sqlcmd übergeben werden. Sie verhindert darüber hinaus die Ausführung des Startskripts, das mithilfe der SQLCMDINI-Skriptvariablen angegeben wurde. Weitere Informationen zu sqlcmd Skriptvariablen finden Sie unter Verwenden von sqlcmd mit Skriptvariablen.

-?
Zeigt eine Syntaxzusammenfassung der sqlcmd-Optionen an.

Hinweise

Die Optionen müssen nicht in der Reihenfolge verwendet werden, in der sie im Abschnitt zur Syntax gezeigt wurden.

Wenn mehrere Ergebnisse zurückgegeben werden, gibt sqlcmd eine Leerzeile zwischen den einzelnen Resultsets in einem Batch aus. Darüber hinaus wird die Meldung "<x> Zeilen betroffen" nicht angezeigt, wenn sie nicht auf die ausgeführte Anweisung angewendet wird.

Um interaktiv zu verwenden sqlcmd , geben Sie sqlcmd an der Eingabeaufforderung eine oder mehrere der weiter oben in diesem Thema beschriebenen Optionen ein. Weitere Informationen finden Sie unter Verwenden des Hilfsprogramms „sqlcmd“

Die gesamte Länge der sqlcmd-Befehlszeile in der Befehlsumgebung (Cmd.exe) einschließlich aller Argumente und erweiterten Variablen entspricht der Länge, die im Betriebssystem für Cmd.exe bestimmt wurde.

Rangfolge der Variablen (vom niedrigsten bis zum höchsten Rang)

1. Umgebungsvariablen auf Systemebene

2. Umgebungsvariablen auf Benutzerebene

3. Die Befehlsshell (SET X=Y) wird an der Eingabeaufforderung festgelegt, bevor Sie ausgeführt werden sqlcmd.

4. sqlcmd-v X=Y

5. :Setvar X Y

sqlcmd-Skriptvariablen

Variable	Damit verbundene Schalter	R/W	Standard
SQLCMDUSER	-U	R	""
SQLCMDPASSWORD	-P	--	""
SQLCMDSERVER	-S	R	"DefaultLocalInstance"
SQLCMDWORKSTATION	-H	R	"ComputerName"
SQLCMDDBNAME	-d	R	""
SQLCMDLOGINTIMEOUT	-l	R/W	"8" (Sekunden)
SQLCMDSTATTIMEOUT	-t	R/W	"0" = unbegrenzt warten
SQLCMDHEADERS	-H	R/W	"0"
SQLCMDCOLSEP	-S	R/W	" "
SQLCMDCOLWIDTH	-w	R/W	"0"
SQLCMDPACKETSIZE	-a	R	"4096"
SQLCMDERRORLEVEL	-M	R/W	0
SQLCMDMAXVARTYPEWIDTH	-y	R/W	"256"
SQLCMDMAXFIXEDTYPEWIDTH	-y	R/W	"0" = unlimited
SQLCMDEDITOR		R/W	"edit.com"
SQLCMDINI		R	""

SQLCMDUSER, SQLCMDPASSWORD und SQLCMDSERVER werden festgelegt, wenn :Connect

wird verwendet.

Durch R wird angezeigt, dass der Wert nur einmal während der Programminitialisierung festgelegt werden kann.

Durch R/W wird angezeigt, dass der Wert mithilfe des setvar -Befehls geändert werden kann und auf nachfolgende Befehle der neue Wert angewendet wird.

sqlcmd-Befehle

Zusätzlich zu Transact-SQL-Anweisungen in sqlcmdsind auch die folgenden Befehle verfügbar:

GO [Anzahl]	:List
[ : ] RESET	:Error
[ : ] ED	:Out
[:] !!	:Perftrace
[ : ] QUIT	:Connect
[ : ] EXIT	:On Error
:r	:Help
:ServerList	:XML [ON | OFF]
:Setvar	:Listvar

Beachten Sie bei der Verwendung von sqlcmd-Befehlen Folgendes:

• Mit Ausnahme von GO muss vor allen sqlcmd-Befehlen ein Doppelpunkt (:) angegeben werden.

  Wichtig

  Aus Gründen der Abwärtskompatibilität mit bestehenden osql -Skripts werden einige der Befehle auch ohne Angabe des Doppelpunkts erkannt. Dies wird durch [:] gekennzeichnet.

• sqlcmd-Befehle werden nur erkannt, wenn sie am Anfang einer Zeile stehen.

• Bei keinem sqlcmd-Befehl wird die Groß- und Kleinschreibung beachtet.

• Jeder Befehl muss in einer eigenen Zeile stehen. Auf einen Befehl darf keine Transact-SQL-Anweisung oder ein anderer Befehl folgen.

• Die Befehle werden sofort ausgeführt. Sie werden nicht wie Transact-SQL-Anweisungen im Ausführungspuffer abgelegt.

Bearbeitungsbefehle
[ : ] ED
Startet den Text-Editor. Mit diesem Editor kann der aktuelle Transact-SQL-Batch oder der zuletzt ausgeführte Batch bearbeitet werden. Um den zuletzt ausgeführten Batch zu bearbeiten, muss der ED -Befehl unmittelbar nach Abschluss der Ausführung des letzten Batches eingegeben werden.

Der Text-Editor wird durch die SQLCMDEDITOR-Umgebungsvariable definiert. Der Standardeditor ist 'Edit'. Sie können den Editor ändern, indem Sie die SQLCMDEDITOR-Umgebungsvariable festlegen. Wenn Sie beispielsweise den Microsoft-Editor als Editor festlegen möchten, müssen Sie Folgendes über die Eingabeaufforderung eingeben:

SET SQLCMDEDITOR=notepad

[ : ] RESET
Löscht den Anweisungscache.

:List
Gibt den Inhalt des Anweisungscaches aus.

Variablen
:Setvar<var> [ "value" ]
Definiert sqlcmd-Skriptvariablen. Skriptvariablen haben das folgende Format: $(VARNAME).

Bei Variablennamen wird die Groß- und Kleinschreibung nicht beachtet.

Skriptvariablen können folgendermaßen festgelegt werden:

• Implizit – mithilfe einer Befehlszeilenoption. Die Option "-l" legt z . B . die VARIABLE "SQLCMDLOGINTIMEOUT sqlcmd " fest.

• Explizit – mithilfe des :Setvar -Befehls.

• Durch die Definition einer Umgebungsvariablen vor der Ausführung von sqlcmd.

Wenn eine Variable, die mithilfe von :Setvar definiert wurde, denselben Namen wie eine Umgebungsvariable aufweist, ist die mit :Setvar definierte Variable vorrangig.

Variablennamen dürfen keine Leerzeichen enthalten.

Variablennamen können nicht dieselbe Form wie ein Variablenausdruck, z. B. $(var), haben.

Wenn der Zeichenfolgenwert der Skriptvariablen Leerzeichen enthält, müssen Sie den Wert in Anführungszeichen einschließen. Wenn für eine Skriptvariable kein Wert angegeben wird, wird die Skriptvariable ausgelassen.

:Listvar
Zeigt die Liste der zurzeit festgelegten Skriptvariablen an.

Ausgabebefehle
:Error
<Dateiname>| STDERR|STDOUT
Leitet die gesamte Fehlerausgabe in die mit Dateinameangegebene Datei, in stderr oder in stdoutum. Der Befehl Error kann mehrmals in einem Skript verwendet werden. Die Fehlerausgabe wird standardmäßig an stderrgesendet.

file name
Erstellt und öffnet eine Datei, in die die Ausgabe geschrieben wird. Wenn die Datei bereits vorhanden ist, wird sie auf 0 Byte gekürzt. Wenn der Zugriff auf die Datei aufgrund unzureichender Berechtigungen oder anderer Ursachen nicht möglich ist, wird die Ausgabe nicht umgeleitet, sondern an das zuletzt angegebene Ziel oder an das Standardziel gesendet.

STDERR
Leitet die Fehlerausgabe in den stderr -Datenstrom. Wenn dieser Datenstrom umgeleitet wurde, wird die Fehlerausgabe von dem Ziel empfangen, zu dem der Datenstrom umgeleitet wurde.

STDOUT
Leitet die Fehlerausgabe in den stdout -Datenstrom. Wenn dieser Datenstrom umgeleitet wurde, wird die Fehlerausgabe von dem Ziel empfangen, zu dem der Datenstrom umgeleitet wurde.

:Out < Dateiname >| STDERR| STDOUT
Erstellt und leitet alle Abfrageergebnisse in der bzw. an die durch Dateinameangegebene Datei, an stderr oder an stdoutum. Standardmäßig wird die Ausgabe an stdoutgesendet. Wenn die Datei bereits vorhanden ist, wird sie auf 0 Byte gekürzt. Der Befehl Out kann mehrmals in einem Skript verwendet werden.

:Perftrace < Dateiname >| STDERR| STDOUT
Erstellt und leitet alle Informationen zur Leistungsnachverfolgung in der bzw. an die durch Dateinameangegebene Datei, an stderr oder stdoutum. Standardmäßig wird die Ausgabe zur Leistungsnachverfolgung an stdoutgesendet. Wenn die Datei bereits vorhanden ist, wird sie auf 0 Byte gekürzt. Der Befehl Perftrace kann mehrmals in einem Skript verwendet werden.

Befehle zur Ausführungssteuerung
:On Error[ exit | ignore]
Legt die Aktion fest, die ausgeführt werden soll, wenn ein Fehler während der Skript- oder Batchausführung auftritt.

Wird die Option exit verwendet, wird sqlcmd mit dem entsprechenden Fehlerwert beendet.

Wenn die Option ignore verwendet wird, ignoriert sqlcmd den Fehler und setzt die Batch- oder Skriptausführung fort. Standardmäßig wird eine Fehlermeldung ausgegeben.

[ : ] QUIT
Bewirkt, dass sqlcmd beendet wird.

[:] EXIT[ (statement) ]
Gibt Ihnen die Möglichkeit, das Ergebnis einer SELECT-Anweisung als Rückgabewert von sqlcmd zu verwenden. Wenn numerisch, wird die erste Spalte der letzten Ergebniszeile in eine 4 Byte lange ganze Zahl (Long) konvertiert. MS-DOS übergibt das niedrige Byte an den übergeordneten Prozess oder an die Fehlerebene des Betriebssystems. Windows 200x übergibt die gesamte 4 Bytes lange ganze Zahl. Die Syntax ist:

:EXIT(query)

Beispiel:

:EXIT(SELECT @@ROWCOUNT)

Sie können den EXIT -Parameter auch als Teil einer Batchdatei einschließen. Geben Sie an der Eingabeaufforderung z. B. Folgendes ein:

sqlcmd -Q "EXIT(SELECT COUNT(*) FROM '%1')"

Das sqlcmd Hilfsprogramm sendet alles zwischen den Klammern () an den Server. Wenn eine gespeicherte Systemprozedur eine Menge auswählt und einen Wert zurückgibt, wird nur die Auswahl zurückgegeben. Eine EXIT**()**-Anweisung ohne Angabe zwischen den Klammern führt alle im Batch vorhergehenden Anweisungen aus und beendet das Hilfsprogramm dann ohne Rückgabewert.

Wird eine fehlerhafte Abfrage angegeben, wird sqlcmd beendet, ohne dass ein Wert zurückgegeben wird.

Folgende Liste enthält eine Aufstellung von EXIT-Formaten:

• :EXIT

Führt den Batch nicht aus, beendet das Hilfsprogramm sofort und gibt keinen Wert zurück.

• :EXIT( )

Führt den Batch aus, beendet dann das Hilfsprogramm und gibt keinen Wert zurück.

• :EXIT(query)

Führt den Batch mit der darin enthaltenen Abfrage aus und beendet dann das Hilfsprogramm, nachdem die Ergebnisse der Abfrage zurückgegeben wurden.

Wenn RAISERROR innerhalb eines sqlcmd Skripts verwendet wird und ein Status von 127 ausgelöst wird, sqlcmd wird die Nachrichten-ID beendet und an den Client zurückgegeben. Zum Beispiel:

RAISERROR(50001, 10, 127)

Dieser Fehler bewirkt, dass das sqlcmd-Skript beendet und die Meldungs-ID 50001 an den Client zurückgegeben wird.

Die Rückgabewerte -1 bis -99 sind von SQL Server reserviert. sqlcmd definiert die folgenden zusätzlichen Rückgabewerte:

Rückgabewerte	BESCHREIBUNG
-100	Vor dem Auswählen des Rückgabewerts ist ein Fehler aufgetreten.
-101	Beim Auswählen eines Rückgabewerts wurden keine Zeilen gefunden.
-102	Beim Auswählen des Rückgabewerts ist ein Konvertierungsfehler aufgetreten.

GO [Anzahl]
GO signalisiert sowohl das Ende eines Batches als auch die Ausführung aller zwischengespeicherten Transact-SQL-Anweisungen. Wenn ein Wert für Anzahl angegeben ist, werden die zwischengespeicherten Anweisungen so oft, wie durch Anzahl angegeben, in Form eines einzigen Batches ausgeführt.

Sonstige Befehle
:r < Dateiname >
Analysiert zusätzliche Transact-SQL-Anweisungen und sqlcmd Befehle aus der durch **<filename>**angegebenen Datei in den Anweisungscache.

Wenn die Datei Transact-SQL-Anweisungen enthält, die nicht von GO gefolgt sind, müssen Sie GO in der ersten Zeile nach :r eingeben.

Die Datei wird gelesen und ausgeführt, nachdem ein Batchabschlusszeichen gefunden wurde. Sie können den Befehl :r mehrmals verwenden. Die Datei kann beliebige sqlcmd-Befehle enthalten, Dies schließt das Batchabschlusszeichen GOein.

:Serverlist
Listet die lokal konfigurierten Server sowie die Namen der Server auf, die Nachrichten über das Netzwerk senden.

:Connect server_name[\instance_name] [-l timeout] [-U user_name [-P password]]
Stellt eine Verbindung mit einer Instanz von SQL Server her. Schließt außerdem die aktuelle Verbindung.

Timeoutoptionen:

0	unbegrenzte Wartezeit
n>0	Wartezeit beträgt n Sekunden

Die SQLCMDSERVER-Skriptvariable spiegelt die zurzeit aktive Verbindung wider.

Wenn Timeout nicht angegeben wird, gilt standardmäßig der Wert der SQLCMDLOGINTIMEOUT-Variablen.

Wenn nur Benutzername angegeben wird (entweder als Option oder als Umgebungsvariable), wird der Benutzer zur Eingabe eines Kennworts aufgefordert. Dies trifft nicht zu, wenn die Umgebungsvariable SQLCMDUSER oder SQLCMDPASSWORD festgelegt wurde. Wenn weder Optionen noch Umgebungsvariablen angegeben werden, wird der Windows-Authentifizierungsmodus für die Anmeldung verwendet. Wenn Sie beispielsweise eine Verbindung mit einer Instanz von instance1SQL Server herstellen möchten, myserververwenden Sie die folgende integrierte Sicherheit:

:connect myserver\instance1

Wenn mithilfe von Skriptvariablen eine Verbindung mit der Standardinstanz auf myserver hergestellt werden soll, würden Sie Folgendes eingeben:

:setvar myusername test

:setvar myservername myserver

:connect $(myservername) $(myusername)

[ : ] !!<Befehl>
Führt Betriebssystembefehle aus. Um einen Betriebssystembefehl auszuführen, geben Sie zwei Ausrufezeichen ( !! ) gefolgt von dem Betriebssystembefehl in eine neue Zeile ein. Beispiel:

:!! Dir

:XML [ON | OFF]
Weitere Informationen finden Sie unter "XML-Ausgabeformat" weiter unten in diesem Thema.

Hilfe:
Listet die sqlcmd-Befehle zusammen mit einer kurzen Beschreibung jedes Befehls auf.

sqlcmd-Dateinamen

sqlcmd Eingabedateien können mit der Option -i oder dem Befehl :r angegeben werden. Ausgabedateien können mit der Option -o oder den Befehlen :Error, :Out und :Perftrace angegeben werden. Es folgen einige Richtlinien für das Verwenden dieser Dateien:

• :Error, :Out und :Perftrace sollten separate <filename> verwenden. Falls derselbe <filename> verwendet wird, werden die Eingaben der Dateien womöglich vermischt.

• Wenn eine Eingabedatei auf einem Remoteserver einen Laufwerksdateipfad wie z. B. :out c:\OutputFile.txt enthält und von sqlcmd auf einem lokalen Computer aufgerufen wird, wird die Ausgabedatei auf dem lokalen Computer und nicht auf dem Remoteserver erstellt.

• Gültige Dateipfade sind: C:\<filename>, \\<Server>\<Share$>\<filename> und "C:\Some Folder\<file name>". Verwenden Sie Anführungszeichen, wenn der Pfad ein Leerzeichen enthält.

• Mit jeder neuen sqlcmd-Sitzung werden eventuell schon vorhandene gleichnamige Dateien überschrieben.

Informationsmeldungen

sqlcmd gibt alle vom Server gesendeten Informationsmeldungen aus. Im folgenden Beispiel wird eine Informationsmeldung ausgegeben, nachdem die Transact-SQL-Anweisungen ausgeführt wurden.

Geben Sie an der Eingabeaufforderung Folgendes ein:

sqlcmd

At the sqlcmd prompt type:

USE AdventureWorks2012;

GO

Wenn Sie die EINGABETASTE drücken, wird folgende Informationsmeldung ausgegeben: Der Datenbankkontext wurde in "AdventureWorks2012" geändert.

Ausgabeformat von Transact-SQL-Abfragen

sqlcmd gibt zuerst eine Spaltenüberschrift aus, die die in der SELECT-Liste angegebenen Spaltennamen enthält. Die Spaltennamen werden durch das SQLCMDCOLSEP-Zeichen getrennt. Standardmäßig handelt es sich hierbei um ein Leerzeichen. Wenn der Spaltenname kürzer als die Spaltenbreite ist, wird die Ausgabe bis zur nächsten Spalte mit Leerzeichen aufgefüllt.

Auf diese Zeile folgt eine Trennlinie, die durch eine Reihe von Bindestrichen dargestellt wird. Die folgende Ausgabe zeigt ein Beispiel.

Starten Sie sqlcmd. Geben Sie an der sqlcmd Eingabeaufforderung Folgendes ein:

USE AdventureWorks2012;

SELECT TOP (2) BusinessEntityID, FirstName, LastName

FROM Person.Person;

GO

Wenn Sie die EINGABETASTE drücken, wird das folgende Resultset zurückgegeben.

BusinessEntityID FirstName LastName

---------------- ------------ ----------

285 Syed Abbas

293 Catherine Abel

(2 row(s) affected)

Obwohl die BusinessEntityID -Spalte nur 4 Zeichen breit ist, wurde sie erweitert, um den längeren Spaltennamen aufzunehmen. Standardmäßig wird die Ausgabe mit dem 80. Zeichen beendet. Dies kann geändert werden, indem Sie die Option -w verwenden oder die SQLCMDCOLWIDTH-Skriptvariable festlegen.

XML-Ausgabeformat

Die XML-Ausgabe, die sich aus der FOR XML-Klausel ergibt, wird unformatiert in einem fortlaufenden Datenstrom ausgegeben.

Verwenden Sie den Befehl :XML ON, wenn Sie eine Ausgabe im XML-Format erwarten.

Verwenden Sie den folgenden Befehl, um den XML-Modus zu deaktivieren: :XML OFF.

Der GO-Befehl sollte nicht verwendet werden, bevor der XML OFF-Befehl ausgegeben wurde, da XML OFF bewirkt, dass sqlcmd zur zeilenbasierten Ausgabe zurückkehrt.

Es ist nicht möglich, XML-Daten (Datenstrom) und Rowsetdaten zu mischen. Wenn der XML ON-Befehl nicht verwendet wurde, bevor eine Transact-SQL-Anweisung, die XML-Datenströme ausgibt, ausgeführt wurde, wird die Ausgabe nicht richtig dargestellt. Wenn der XML ON-Befehl verwendet wurde, können Sie keine Transact-SQL-Anweisungen ausführen, die reguläre Rowsets ausgeben.

Bewährte Methoden für die Verwendung von sqlcmd

Die folgenden Methoden haben sich dazu bewährt, Sicherheit und Effizienz zu optimieren.

• Verwenden Sie die integrierte Sicherheit von Windows.

• Verwenden Sie in automatisierten Umgebungen -X.

• Sichern Sie Eingabe- und Ausgabedateien, indem Sie die geeigneten NTFS-Dateisystemberechtigungen verwenden.

• Führen Sie aus Leistungsgründen möglichst alle Aufgaben in einer einzigen sqlcmd-Sitzung, nicht in einer Reihe von verschiedenen Sitzungen durch.

• Legen Sie für Batch- bzw. Abfragetimeouts Werte fest, die höher sind als die erwartete Ausführungsdauer.

Weitere Informationen

Starten des Hilfsprogramms „sqlcmd“
Ausführen von Transact-SQL-Skriptdateien mithilfe von sqlcmd
Verwenden des Hilfsprogramms sqlcmd
Verwenden von sqlcmd mit Skriptvariablen
Herstellen einer Verbindung mit der Datenbank-Engine mithilfe von sqlcmd
Bearbeiten von SQLCMD-Skripts mit dem Abfrage-Editor
Verwalten von Auftragsschritten
Erstellen eines CmdExec-Auftragsschritts