sqlcmd-Dienstprogramm

Gilt für:SQL ServerAzure SQL-DatenbankAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)SQL-Datenbank in Microsoft Fabric

Mit dem Hilfsprogramm sqlcmd können Sie Transact-SQL-Anweisungen, Systemprozeduren und Skriptdateien in verschiedenen Modi eingeben:

• An einer Eingabeaufforderung.
• Im Abfrage-Editor im SQLCMD-Modus.
• In einer Windows-Skriptdatei.
• In einem Auftragsschritt eines SQL Server-Agent-Auftrags für ein Betriebssystem (cmd.exe)

sqlcmd-Varianten

Es gibt zwei Varianten von sqlcmd:

• sqlcmd (Go): Die go-mssqldb-basierte sqlcmd, manchmal als go-sqlcmd formatiert. Diese Version ist ein eigenständiges Tool, das Sie unabhängig von SQL Server herunterladen können. Sie wird unter Windows, macOS, Linux und in Containern ausgeführt.

• sqlcmd (ODBC): Die plattformorientierte, ODBC-basierte sqlcmd, verfügbar mit SQL Server oder microsoft Command Line Utilities und Teil des mssql-tools Pakets unter Linux. Sie wird auch unter Windows, macOS, Linux und in Containern ausgeführt.

Informationen dazu, welche Variante und Version von sqlcmd auf Ihrem System installiert ist, finden Sie unter Überprüfen der installierten Version des sqlcmd-Hilfsprogramms.

Informationen zum Abrufen von sqlcmd finden Sie unter Herunterladen und Installieren des sqlcmd-Hilfsprogramms.

TDS 8.0-Unterstützung

Sql Server 2025 (17.x) Preview führt die TDS 8.0-Unterstützung für das sqlcmd-Hilfsprogramm ein.

Syntax

Usage:
  sqlcmd [flags]
  sqlcmd [command]

Examples:
# Install/Create, Query, Uninstall SQL Server
  sqlcmd create mssql --accept-eula --using https://aka.ms/AdventureWorksLT.bak
  sqlcmd open ads
  sqlcmd query "SELECT @@version"
  sqlcmd delete
# View configuration information and connection strings
  sqlcmd config view
  sqlcmd config cs

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  config      Modify sqlconfig files using subcommands like "sqlcmd config use-context mssql"
  create      Install/Create SQL Server, Azure SQL, and Tools
  delete      Uninstall/Delete the current context
  help        Help about any command
  open        Open tools (e.g ADS) for current context
  query       Run a query against the current context
  start       Start current context
  stop        Stop current context

Flags:
  -?, --?                  help for backwards compatibility flags (-S, -U, -E etc.)
  -h, --help               help for sqlcmd
      --sqlconfig string   configuration file (default "/Users/<currentUser>/.sqlcmd/sqlconfig")
      --verbosity int      log level, error=0, warn=1, info=2, debug=3, trace=4 (default 2)
      --version            print version of sqlcmd

Use "sqlcmd [command] --help" for more information about a command.

sqlcmd
   -a packet_size
   -A (dedicated administrator connection)
   -b (terminate batch job if there is an error)
   -c batch_terminator
   -C (trust the server certificate)
   -d db_name
   -D
   -e (echo input)
   -E (use trusted connection)
   -f codepage | i:codepage[,o:codepage] | o:codepage[,i:codepage]
   -g (enable column encryption)
   -G (use Azure Active Directory for authentication)
   -h rows_per_header
   -H workstation_name
   -i input_file
   -I (enable quoted identifiers)
   -j (Print raw error messages)
   -k[1 | 2] (remove or replace control characters)
   -K application_intent
   -l login_timeout
   -L[c] (list servers, optional clean output)
   -m error_level
   -M multisubnet_failover
   -N (encrypt connection)
   -o output_file
   -p[1] (print statistics, optional colon format)
   -P password
   -q "cmdline query"
   -Q "cmdline query" (and exit)
   -r[0 | 1] (msgs to stderr)
   -R (use client regional settings)
   -s col_separator
   -S [protocol:]server[instance_name][,port]
   -t query_timeout
   -u (unicode output file)
   -U login_id
   -v var = "value"
   -V error_severity_level
   -w screen_width
   -W (remove trailing spaces)
   -x (disable variable substitution)
   -X[1] (disable commands, startup script, environment variables, optional exit)
   -y variable_length_type_display_width
   -Y fixed_length_type_display_width
   -z new_password
   -Z new_password (and exit)
   -? (usage)

Befehlszeilenoptionen

In der folgenden Tabelle sind die Befehlszeilenoptionen aufgeführt, die in sqlcmd verfügbar sind und welche Betriebssysteme unterstützt werden.

Anmeldungsbezogene Optionen

-A

Gilt für: Nur Windows. Linux und macOS werden nicht unterstützt.

Meldet sich bei SQL Server über eine dedizierte Administratorverbindung (DAC) an. Diese Verbindungsart wird verwendet, um Serverprobleme zu behandeln. Diese Verbindung funktioniert nur bei Servercomputern, 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. Die -A-Option wird mit der -G-Option nicht unterstützt. Wenn Sie unter Verwendung von -A eine Verbindung mit Azure SQL-Datenbank herstellen, müssen Sie Administrator*in für den logischen SQL-Server sein. DAC ist für einen Microsoft Entra-Administrator nicht verfügbar.

-C

Diese Option 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.

Für das Hilfsprogramm sqlcmd (Go) gelten auch die folgenden Bedingungen:

• Wenn -N und -C nicht angegeben werden, verhandelt sqlcmd die Authentifizierung mit dem Server, ohne das Serverzertifikat zu überprüfen.
• Wenn -N angegeben ist, -C jedoch nicht, schreibt sqlcmd eine Überprüfung des Serverzertifikats vor. Ein false-Wert für die Verschlüsselung kann weiterhin zur Verschlüsselung des Anmeldepakets führen.
• Wenn -N und -C angegebenen werden, verwendet sqlcmd deren Werte für die Verschlüsselungsverhandlung.

-d db_name

Gibt eine USE <db_name>-Anweisung aus, wenn Sie sqlcmd starten. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDDBNAME festgelegt. Dieser Parameter gibt die Ausgangsdatenbank an. Der Standardwert ist die Standarddatenbank-Eigenschaft des Logins. Wenn die Datenbank nicht vorhanden ist, wird eine Fehlermeldung generiert, und sqlcmd wird beendet.

-D

Diese Option interpretiert den an -S übergebenen Servernamen als DSN anstatt als Hostnamen. Weitere Informationen finden Sie unter DSN-Unterstützung in sqlcmd und bcp.

-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 einer sqlcmd-Anmeldung beträgt acht Sekunden. Wenn Sie die -G-Option verwenden, um eine Verbindung zu Azure SQL-Datenbank oder Azure Synapse Analytics herzustellen und sich mit Microsoft Entra ID zu authentifizieren, wird ein Timeoutwert von mindestens 30 Sekunden empfohlen. Der Anmelde-Timeout 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 verwendet -E die Option für vertrauenswürdige Verbindung, wenn 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.

-g

Hiermit wird die Einstellung „Spaltenverschlüsselung“ auf Enabled festgelegt. Weitere Informationen hierzu finden Sie unter Always Encrypted. Es werden nur Hauptschlüssel unterstützt, die im Windows-Zertifikatspeicher gespeichert sind. Für die -g-Option ist mindestens die sqlcmd-Version 13.1 erforderlich. Um die Version zu bestimmen, führen Sie sqlcmd -?aus.

-G

Diese Option wird vom Client beim Herstellen einer Verbindung mit azure SQL-Datenbank oder Azure Synapse Analytics verwendet, um anzugeben, dass der Benutzer mit der Microsoft Entra-Authentifizierung authentifiziert wird. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDUSEAAD = true festgelegt. Für die -G-Option ist mindestens die sqlcmd-Version 13.1 erforderlich. Um die Version zu bestimmen, führen Sie sqlcmd -?aus. Weitere Informationen finden Sie unter Microsoft Entra-Authentifizierung für Azure SQL. Die -A-Option wird mit der -G-Option nicht unterstützt.

Die Option -G gilt nur für Azure SQL-Datenbank und Azure Synapse Analytics.

Die interaktive Microsoft Entra-Authentifizierung wird unter Linux und macOS derzeit nicht unterstützt. Die integrierte Microsoft Entra-Authentifizierung erfordert das Herunterladen des ODBC-Treibers für SQL Server, Version 17.6.1 oder höher und eine ordnungsgemäß konfigurierte Kerberos-Umgebung.

Weitere Informationen zur Microsoft Entra-Authentifizierung finden Sie unter Authenticate with Microsoft Entra ID in sqlcmd.

-H workstation_name

Der Name einer Arbeitsstation. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDWORKSTATION festgelegt. Der Name der Arbeitsstation wird in der hostname-Spalte der sys.sysprocesses-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.

-j

Gibt unformatierte Fehlermeldungen auf dem Bildschirm aus

-K Anwendungszweck

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 sqlcmd keine Konnektivität mit einem sekundären Replikat in einer Verfügbarkeitsgruppe. Weitere Informationen finden Sie unter Auslagern von schreibgeschützten Workloads auf ein sekundäres Replikat einer Always On-Verfügbarkeitsgruppe.

Weitere Informationen finden Sie unter Hoher Verfügbarkeit und Notfallwiederherstellung unter Linux und macOS.

-M multisubnet_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, ist -M deaktiviert.

Weitere Informationen finden Sie unter:

• Mit einem Always On-Verfügbarkeitsgruppen-Listener verbinden
• Referenz für die Erstellung und Konfiguration von Always On-Verfügbarkeitsgruppen
• Failover Clustering und Always On-Verfügbarkeitsgruppen (SQL Server)
• Auslagern der schreibgeschützten Arbeitslast auf die sekundäre Replik einer Always On-Verfügbarkeitsgruppe

Weitere Informationen finden Sie unter Hoher Verfügbarkeit und Notfallwiederherstellung unter Linux und macOS.

-N

Diese Option wird vom Client verwendet, um eine verschlüsselte Verbindung anzufordern.

Für das Sqlcmd-Hilfsprogramm (Go) nimmt -N einen Zeichenfolgenwert an, der einer von true, false oder disable ist, um die Verschlüsselungsauswahl anzugeben. (default entspricht dem Auslassen des Parameters):

• Wenn -N und -C nicht angegeben werden, verhandelt sqlcmd die Authentifizierung mit dem Server, ohne das Serverzertifikat zu überprüfen.

• Wenn -N angegeben ist, -C jedoch nicht, schreibt sqlcmd eine Überprüfung des Serverzertifikats vor. Ein false-Wert für die Verschlüsselung kann weiterhin zur Verschlüsselung des Anmeldepakets führen.

• Wenn -N und -C angegebenen werden, verwendet sqlcmd deren Werte für die Verschlüsselungsverhandlung.

• In sqlcmd (ODBC) verwenden Sie -F, um den Hostnamen im Zertifikat anzugeben. Zum Beispiel:

  sqlcmd -S server01 -Q "SELECT TOP 100 * FROM WideWorldImporters.Sales.Orders" -A -Ns -F server01.adventure-works.com
  

  Hinweis

  Dies unterscheidet sich von dem -F Schalter für sqlcmd (Go), der zum Drucken von Ergebnissen mit einem vertikalen Format verwendet wird.

- P-Kennwort

Dies ist ein von den Benutzer*innen angegebenes Kennwort. Bei Kennwörtern wird nach Groß- und Kleinschreibung unterschieden. Wenn die -U Option verwendet wird, wird die -P Option nicht verwendet, und die SQLCMDPASSWORD Umgebungsvariable wird nicht festgelegt, sqlcmd fordert den Benutzer zur Eingabe eines Kennworts auf. Die Verwendung eines NULL-Kennworts (leer) wird nicht empfohlen, aber Sie können es angeben, indem Sie ein Paar zusammenhängender doppelter Anführungszeichen für den Parameterwert verwenden ("").

Es wird empfohlen, ein sicheres Kennwort zu verwenden.

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 Umgebungsvariable SQLCMDPASSWORD 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 -Variable an der Eingabeaufforderung festgelegt und dann auf das Hilfsprogramm SQLCMDPASSWORDsqlcmd zugegriffen.

Geben Sie an der Eingabeaufforderung den folgenden Befehl ein. Ersetzen Sie <password> durch ein gültiges Kennwort.

SET SQLCMDPASSWORD=<password>
sqlcmd

SET SQLCMDPASSWORD=<password>
sqlcmd

SET SQLCMDPASSWORD=<password>
sqlcmd

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

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

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

Ein Kennwort mit Sonderzeichen kann eine Fehlermeldung generieren. Sie sollten bei Verwendung von -P Sonderzeichen mit Escapezeichen versehen oder stattdessen die Umgebungsvariable SQLCMDPASSWORD verwenden.

Unter Linux und macOS gibt -G bei Verwendung der -U-Option ohne -P eine Datei an, die ein Zugriffstoken (v17.8+) enthält. Die Tokendatei sollte im UTF-16LE-Format (ohne BOM) vorliegen.

Zugriffstoken können über verschiedene Methoden abgerufen werden. Sie müssen sicherstellen, dass das Zugriffstoken byteweise korrekt ist, da es gesendet wird as-is. Nachfolgend sehen Sie einen Beispielbefehl, der ein Zugriffstoken abruft. Der Befehl verwendet die Azure CLI und Linux-Befehle und speichert sie in einer Datei im richtigen Format. Wenn die Standardcodierung Ihres Systems oder Terminals nicht ASCII oder UTF-8 ist, müssen Sie die iconv Optionen möglicherweise anpassen. Die resultierende Datei muss zuverlässig geschützt und gelöscht werden, sobald sie nicht mehr benötigt wird.

az account get-access-token --resource https://database.windows.net --output tsv | cut -f 1 | tr -d '\n' | iconv -f ascii -t UTF-16LE > /tmp/tokenFile

-S [protocol:]server[\instance_name][,port]

Gibt die SQL Server-Instanz an, mit der eine Verbindung hergestellt werden soll. Dadurch 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[\instance_name] an, um eine Verbindung mit der benannten Instanz von SQL Server auf diesem Servercomputer herzustellen. Wenn kein Servercomputer angegeben wird, stellt sqlcmd eine Verbindung mit der Standardinstanz von SQL Server auf dem lokalen Computer her. Diese Option ist erforderlich, wenn sqlcmd von einem Remotecomputer im Netzwerk ausgeführt wird.

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

Wenn Sie server_name[\instance_name] beim Starten von sqlcmd nicht angeben, sucht SQL Server nach der Umgebungsvariable SQLCMDSERVER und verwendet diese.

Der ODBC-Treiber unter Linux und macOS erfordert -S. Der einzige gültige Protokollwert ist tcp.

-U login_id

Dies ist der Anmeldename oder der für die eigenständige Datenbank verwendete Benutzername. Für Benutzer*innen einer eingeschlossenen Datenbank müssen Sie die Option für den Datenbanknamen (-d) angeben.

Wenn Sie weder die -U-Option noch die -P-Option angegeben, versucht sqlcmd, die Verbindung mithilfe des Windows-Authentifizierungsmodus herzustellen. Die Authentifizierung basiert auf dem Windows-Konto des Benutzers, der sqlcmdausführt.

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

-z new_password

Ändern Sie das Kennwort. Ersetzen Sie <oldpassword> es durch das alte Kennwort und <newpassword> durch das neue Kennwort.

sqlcmd -U someuser -P <oldpassword> -z <newpassword>

sqlcmd -U someuser -P <oldpassword> -z <newpassword>

sqlcmd -U someuser -P <oldpassword> -z <newpassword>

-Z new_password

Ändern Sie das Kennwort und melden Sie sich ab. Ersetzen Sie <oldpassword> es durch das alte Kennwort und <newpassword> durch das neue Kennwort.

sqlcmd -U someuser -P <oldpassword> -Z <newpassword>

sqlcmd -U someuser -P <oldpassword> -Z <newpassword>

sqlcmd -U someuser -P <oldpassword> -Z <newpassword>

Eingabe- bzw. Ausgabeoptionen

-f codepage | i:codepage[,o:codepage] | o:codepage[,i:codepage]

Gibt die Eingabe- und Ausgabe-Code-Seiten an. Die Codepagenummer ist ein numerischer Wert, der eine installierte Windows-Codepage angibt.

Codeseitenkonvertierungsregeln:

• 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 -u-Option angegeben wurde, handelt es sich bei der Ausgabe stets um Unicode-Dateien im Little-Endian-Format.

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

• 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...]

Hiermit wird die Datei identifiziert, die einen Batch mit Transact-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:

sqlcmd -i <input_file1> -i <input_file2>

sqlcmd -i <input_file1> -i <input_file2>

sqlcmd -i <input_file1> -i <input_file2>

-o Ausgabedatei

Identifiziert die Datei, die die Ausgabe von sqlcmderhält.

Ist -u angegeben, wird die Ausgabedatei im Unicode-Format gespeichert. Wenn der Dateiname ungültig ist, wird eine Fehlermeldung generiert, und sqlcmd wird beendet. sqlcmd unterstützt keine parallelen Schreibvorgänge mehrerer sqlcmd-Prozesse in dieselbe Datei. In diesem Fall ist die Dateiausgabe beschädigt oder fehlerhaft. Die -f-Option ist auch für Dateiformate relevant. Falls sie noch nicht vorhanden ist, wird die Datei erstellt. Eine Datei mit demselben Namen aus einer früheren sqlcmd-Sitzung 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:< filename>
-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 angeben bzw. 0 festlegen, werden nur Fehlermeldungen mit dem Schweregrad 11 oder höher umgeleitet. Wenn Sie 1 angeben, wird die gesamte Fehlermeldungsausgabe (einschließlich PRINT) umgeleitet. Diese Option hat keine Auswirkungen, wenn Sie -o verwenden. Standardmäßig werden Meldungen an stdoutgesendet.

-R

Gilt nur für: ODBC sqlcmd.

Bewirkt, dass sqlcmd aus SQL Server abgerufene numerische Spalten sowie Währungs-, Datums- und Zeitspalten basierend auf dem Gebietsschema des Clients lokalisiert. 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).

-Ich

Gilt nur für: ODBC sqlcmd.

Hiermit wird die Verbindungsoption SET QUOTED_IDENTIFIER auf ON festgelegt. Die Standardeinstellung ist OFF. Weitere Informationen finden Sie unter SET QUOTED_IDENTIFIER.

-q "CMD-Befehlszeilenabfrage"

Führt eine Abfrage aus, wenn sqlcmd gestartet wird, aber sqlcmd nicht beendet, wenn die Abfrage abgeschlossen ist. Mehrere durch Semikolons getrennte Abfragen können 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 AdventureWorks2022 -q "SELECT FirstName, LastName FROM Person.Person WHERE LastName LIKE 'Whi%';"
sqlcmd -d AdventureWorks2022 -q "SELECT TOP 5 FirstName FROM Person.Person;SELECT TOP 5 LastName FROM Person.Person;"

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

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

Wenn -b zusammen mit dieser Option angegeben wird, wird sqlcmd beim Auftreten eines Fehlers beendet. -b wird an anderer Stelle in diesem Artikel beschrieben.

-Q "Cmdline-Abfrage"

Führt eine Abfrage aus, wenn sqlcmd startet, und beendet sqlcmdunmittelbar 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 AdventureWorks2022 -Q "SELECT FirstName, LastName FROM Person.Person WHERE LastName LIKE 'Whi%';"
sqlcmd -d AdventureWorks2022 -Q "SELECT TOP 5 FirstName FROM Person.Person;SELECT TOP 5 LastName FROM Person.Person;"

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

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

Wenn -b zusammen mit dieser Option angegeben wird, wird sqlcmd beim Auftreten eines Fehlers beendet. -b wird an anderer Stelle in diesem Artikel beschrieben.

-t query_timeout

Hiermit wird angegeben, wie viele Sekunden verstreichen, bevor für einen Befehl (oder eine Transact-SQL-Anweisung) ein Timeout auftritt. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDSTATTIMEOUT festgelegt. Wenn kein query_timeout-Wert angegeben wird, tritt für den Befehl kein Timeout auf. query_timeout muss einer Zahl zwischen 1 und 65534 entsprechen. Wenn der angegebene Wert kein numerischer Wert ist oder außerhalb dieses Bereichs liegt, generiert sqlcmd eine Fehlermeldung.

-v var = Wert [ var = Wert... ]

Gilt für: Nur Windows. Linux und macOS werden nicht unterstützt.

Hiermit wird eine sqlcmd-Skriptvariable erstellt, die in einem sqlcmd-Skript verwendet werden kann.

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

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

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

:setvar ColumnName object_id
:setvar TableName sys.objects

SELECT $(ColumnName) FROM $(TableName)

cat a.sql > c.sql
cat b.sql >> c.sql

sqlcmd -S<...> -P<..> -U<..> -I c.sql

-x

Bewirkt, dass sqlcmd Skriptvariablen ignoriert. Dieser Parameter ist nützlich, wenn ein Skript viele INSERT Anweisungen enthält, die Zeichenfolgen enthalten können, die dasselbe Format wie normale Variablen aufweisen, z. B. $(<variable_name>).

Formatoptionen

-h Kopfzeilen

Gibt die Anzahl der Zeilen an, die zwischen den Spaltenüberschriften ausgegeben werden Standardmäßig werden die Überschriften für jede Ergebnismenge der Abfrage einmal gedruckt. Durch diese Option wird die sqlcmd-Skriptvariable SQLCMDHEADERS festgelegt. 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 Mit diesem Parameter bleibt die Spaltenformatierung erhalten, wenn Daten zurückgegeben werden.

• -k entfernt Steuerzeichen.
• -k1 ersetzt jedes Steuerzeichen durch ein Leerzeichen.
• -k2 ersetzt aufeinander folgende Steuerzeichen durch ein einzelnes Leerzeichen.

-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 screen_width

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 auf die nächste Zeile umbrochen.

-W

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

-y variable_length_type_display_width

Dadurch wird die sqlcmd -Skriptvariable SQLCMDMAXVARTYPEWIDTHfestgelegt. Der Standardwert lautet 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
• Benutzerdefinierte Datentypen (UDTs)
• Text
• ntext
• Abbildung

UDTs können je nach Implementierung eine feste Länge aufweisen. Wenn die Länge eines UDT mit fester Länge den Wert für display_width unterschreitet, hat dies keinen Einfluss auf den Wert des zurückgegebenen UDT. Wenn die Länge den Wert für Anzeigebreitejedoch überschreitet, wird die Ausgabe abgeschnitten.

-Y fixed_length_type_display_width

Dadurch wird die sqlcmd -Skriptvariable SQLCMDMAXFIXEDTYPEWIDTHfestgelegt. 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(n), wobei 1 <= n<= 4000
• varchar(n), wobei 1 <= n<= 8000
• nvarchar(n), wobei 1 <= n<= 4000
• varbinary(n), wobei 1 <= n<= 4000
• sql_variant

Optionen für die Fehlerberichterstellung

-b

Hiermit wird angegeben, dass sqlcmd beendet und ein DOS ERRORLEVEL-Wert zurückgegeben wird, wenn ein Fehler auftritt. Für die 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 -V-Option festgelegt ist, meldet -b neben keinen Fehler, wenn der Schweregrad niedriger ist als die Werte, die mit -V festgelegt wurden. 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 Fehlerstufe

Hiermit wird gesteuert, welche Fehlermeldungen an stdout gesendet 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. Zwischen -m und -1 sind keine Leerzeichen zulässig. Beispielsweise ist -m-1 zulässig, -m -1 jedoch nicht.

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

-V Fehlerschweregrad

Hiermit wird der Schweregrad gesteuert, der zur Festlegung der ERRORLEVEL-Variablen 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. Batchdateien und CMD-Dateien können verwendet werden, um den Wert der ERRORLEVEL-Variablen zu testen.

Sonstige Optionen

-a packet_size

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

-c batch_terminator

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]

Gilt für: Nur Windows. Linux und macOS werden nicht unterstützt.

Listet die lokal konfigurierten Servercomputer sowie die Namen der Servercomputer auf, die auf dem Netzwerk senden. Dieser Parameter kann nicht in Verbindung mit anderen Parametern verwendet werden. Es können maximal 3.000 Servercomputer aufgelistet werden. Sollte die Serverliste aufgrund der Puffergröße gekürzt werden, erscheint eine Warnnachricht.

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

-p[1]

Gibt Leistungsstatistiken für jedes Resultset aus Folgende Darstellung 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.)

Wo:

• x = Anzahl der von SQL Server verarbeiteten Transaktionen.
• 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.

Wird für den optionalen Parameter ein anderer Wert als 1angegeben, wird ein Fehler generiert und sqlcmd beendet.

-X[1]

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

• ED
• !!befehl

Wenn die -X-Option angegeben wird, verhindert sie die Übergabe von Umgebungsvariablen an sqlcmd. Sie verhindert auch die Ausführung des Startskripts, das mithilfe der Skriptvariablen SQLCMDINI angegeben wurde. Weitere Informationen zu sqlcmd-Skriptvariablen finden Sie unter Verwenden von „sqlcmd“ mit Skriptvariablen.

-?

Zeigt die Version von sqlcmd und 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. Außerdem wird die Meldung <x> rows affected nicht angezeigt, wenn sie für die ausgeführte Anweisung nicht gilt.

Wenn Sie sqlcmd interaktiv verwenden möchten, geben Sie sqlcmd an der Eingabeaufforderung und eine oder mehrere der weiter oben in diesem Artikel beschriebenen Optionen ein. Weitere Informationen finden Sie unter Verwenden von sqlcmd.

Die gesamte Länge der sqlcmd-Befehlszeile in der Befehlsumgebung (z. B. cmd.exe oder bash) einschließlich aller Argumente und erweiterten Variablen wird durch das zugrunde liegende Betriebssystem festgelegt.

DSN-Unterstützung in sqlcmd und bcp

Sie können einen Datenquellennamen (Data Source Name, DSN) anstelle eines Servernamens in sqlcmd oder bcp -S option (oder sqlcmd :Connect command) angeben, wenn Sie angeben -D. -D sorgt dafür, dass sqlcmd oder bcp eine Verbindung mit dem Server herstellen kann, der in DSN durch die Option -S angegeben ist.

System-DSNs werden in der odbc.ini Datei im ODBC-Verzeichnis SysConfigDir (/etc/odbc.ini in Standardinstallationen) gespeichert. Benutzer-DSNs werden in .odbc.ini im Basisverzeichnis eines Benutzers (~/.odbc.ini) gespeichert.

Auf Windows-Systemen werden System- und Benutzer-DSNs in der Registrierung gespeichert und über odbcad32.exediese verwaltet. bcp und sqlcmd unterstützen keine Datei-DSNs.

Eine Liste der Einträge, die vom Treiber unterstützt werden, finden Sie unter Schlüsselwörter und Attribute von DSN- und Verbindungszeichenfolgen.

In einem DSN ist nur der DRIVER Eintrag erforderlich, aber um eine Verbindung mit einem Remoteserver herzustellen, benötigt sqlcmd oder bcp einen Wert im SERVER Element. Wenn das SERVER Element im DSN leer oder nicht vorhanden ist, versuchen sqlcmd und bcp , eine Verbindung mit der Standardinstanz im lokalen System herzustellen.

Wenn Sie bcp auf Windows-Systemen verwenden, benötigen SQL Server 2017 (14.x) und frühere Versionen den SQL Native Client 11-Treiber (sqlncli11.dll), während SQL Server 2019 (15.x) und höhere Versionen den Microsoft ODBC-Treiber 17 für SQL Server-Treiber (msodbcsql17.dll) erfordern.

Wenn die gleiche Option sowohl im DSN als auch in der Befehlszeile "sqlcmd " oder "bcp " angegeben ist, überschreibt die Befehlszeilenoption den im DSN verwendeten Wert. Wenn z. B. der DSN einen DATABASE Eintrag enthält und die sqlcmd Befehlszeile -d enthält, wird der an -d übergebene Wert verwendet. Wenn Trusted_Connection=yes im DSN angegeben wird, wird die Kerberos-Authentifizierung verwendet; Benutzername (-U) und Kennwort (-P), falls angegeben, werden ignoriert.

Vorhandene Skripts, die aufgerufen isql werden, können so geändert werden, dass sqlcmd verwendet wird, indem der folgende Alias definiert wird: alias isql="sqlcmd -D"

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[1].

• Schützen Sie Eingabe- und Ausgabedateien, indem Sie die geeigneten Dateisystemberechtigungen verwenden.

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

• Legen Sie die Timeout-Werte für die Ausführung von Batches oder Abfragen höher fest, als Sie erwarten, dass die Ausführung des Batches oder der Abfrage dauert.

Maximieren Sie mit folgenden Methoden die Richtigkeit:

• Verwenden Sie -V 16, um Nachrichten des Schweregrads 16 zu protokollieren. Meldungen des Schweregrads 16 verweisen auf allgemeine Fehler, die die Benutzer*innen korrigieren können.

• Überprüfen Sie den Exit-Code und die Variable DOS ERRORLEVEL, nachdem der Prozess beendet ist. sqlcmd gibt normalerweise 0 zurück. Andernfalls wird der ERRORLEVEL-Wert wie von -V konfiguriert festgelegt. Mit anderen Worten: Erwarten Sie nicht, dass ERRORLEVEL mit der Fehlernummer übereinstimmt, die von SQL Server gemeldet wird. Die Fehlernummer ist ein SQL Server-spezifischer Wert, der der Systemfunktion @@ERROR entspricht. ERRORLEVEL ist ein sqlcmd-spezifischer Wert, der angibt, warum sqlcmd beendet wurde. Zudem wird der Wert durch Angabe des Befehlszeilenarguments -b beeinflusst.

Die Verwendung von -V 16 in Kombination mit der Überprüfung von Exitcode und DOS ERRORLEVEL kann dazu beitragen, Fehler in automatisierten Umgebungen zu erfassen, insbesondere Qualitätsschranken vor einer Produktionseinführung.

Zugehöriger Inhalt

• Überprüfen der installierten Version des sqlcmd-Hilfsprogramms
• Herunterladen und Installieren des sqlcmd-Hilfsprogramms
• Befehle im sqlcmd-Hilfsprogramm
• Verwenden von sqlcmd mit Skriptvariablen
• Schnellstart: Ausführen von SQL Server Linux-Containerimages mit Docker
• Starten des Hilfsprogramms „sqlcmd“
• Ausführen von T-SQL aus einer Skriptdatei mit sqlcmd
• Verwenden von sqlcmd
• Herstellen einer Verbindung mit SQL Server mit sqlcmd
• Bearbeiten von SQLCMD-Skripts mit dem Abfrage-Editor
• Erstellen eines CmdExec-Auftragsschritts