Verwenden von „sqlcmd“ mit Skriptvariablen

Artikel
07/12/2024

Gilt für: SQL Server Azure SQL-Datenbank Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

Variablen, die in Skripts verwendet werden, werden als Skriptvariablen bezeichnet. Durch Skriptvariablen wird ein Skript aktiviert, das in verschiedenen Szenarien verwendet wird. Wenn Sie beispielsweise ein einzelnes Skript auf mehreren Servern ausführen möchten, anstatt das Skript für jeden Server zu ändern, können Sie eine Skriptvariable für den Servernamen verwenden. Durch das Ändern des Servernamens für die Skriptvariable kann das gleiche Skript auf verschiedenen Servern ausgeführt werden.

Skriptvariablen können explizit mithilfe des Befehls setvar oder implizit mithilfe der Option sqlcmd -v definiert werden.

Dieser Artikel enthält auch Beispiele zum Definieren von Umgebungsvariablen an der Eingabeaufforderung von „Cmd.exe“ mithilfe von SET.

Festlegen von Skriptvariablen mit dem Befehl „setvar“

Der Befehl setvar wird zum Definieren von Skriptvariablen verwendet. Mithilfe des Befehls setvar definierte Variablen werden intern gespeichert. Skriptvariablen dürfen nicht mit Umgebungsvariablen verwechselt werden, die an der Eingabeaufforderung mithilfe von SET definiert werden. Wenn ein Skript auf eine Variable verweist, die keine Umgebungsvariable ist oder nicht mithilfe von setvar definiert wurde, wird eine Fehlermeldung zurückgegeben und die Ausführung des Skripts unterbrochen. Weitere Informationen finden Sie unter der Option -b in sqlcmd.

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

Wenn mehrere Variablentypen denselben Namen aufweisen, wird die Variable mit der höchsten Rangfolge verwendet.

Umgebungsvariablen auf Systemebene
Umgebungsvariablen auf Benutzerebene
Die vor dem Starten von sqlcmd an der Eingabeaufforderung festgelegte Befehlsshell (SET X=Y)
sqlcmd -v X=Y
:Setvar X Y

Hinweis

Öffnen Sie in der Systemsteuerung die Option System, und wählen Sie anschließend die Registerkarte Erweitert aus, um die Umgebungsvariablen anzuzeigen.

Implizites Festlegen von Skriptvariablen

Wenn Sie sqlcmd mit einer Option starten, die eine verknüpfte sqlcmd -Variable aufweist, wird die sqlcmd -Variable implizit auf den Wert festgelegt, der mithilfe der Option angegeben wurde. Im folgenden Beispiel beginnt sqlcmd mit der Option -l . Dadurch wird implizit die Variable SQLLOGINTIMEOUT festgelegt.

sqlcmd -l 60

Sie können auch die Option -v verwenden, um eine Skriptvariable festzulegen, die in einem Skript vorhanden ist. Im folgenden Skript (der Dateiname lautet testscript.sql) wird ColumnName als Skriptvariable verwendet.

USE AdventureWorks2022;

SELECT x.$(ColumnName)
FROM Person.Person x
WHERE x.BusinessEntityID < 5;

Sie können daraufhin den Namen der Spalte angeben, die mithilfe der Option -v zurückgegeben werden soll:

sqlcmd -v ColumnName ="FirstName" -i c:\testscript.sql

Ändern Sie den Wert der ColumnName -Skriptvariablen, um eine andere Spalte mithilfe desselben Skripts zurückzugeben.

sqlcmd -v ColumnName ="LastName" -i c:\testscript.sql

Richtlinien für Namen und Werte von Skriptvariablen

Die folgenden Richtlinien sollten bei der Benennung von Skriptvariablen berücksichtigt werden:

Variablennamen dürfen keine Leerzeichen oder Anführungszeichen enthalten.
Variablennamen dürfen nicht die gleiche Form wie Variablenausdrücke (beispielsweise $(var) ) aufweisen.
Bei Skriptvariablen wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Hinweis

Wenn einer sqlcmd -Umgebungsvariablen kein Wert zugewiesen wird, wird die Variable entfernt. Bei Verwendung von :setvar VarName ohne einen Wert wird die Variable gelöscht.

Die folgenden Richtlinien sollten beim Angeben von Werten für Skriptvariablen berücksichtigt werden:

Variablenwerte, die mit setvar oder mit der Option -v definiert werden, müssen in Anführungszeichen eingeschlossen werden, sofern im Zeichenfolgenwert Leerzeichen enthalten sind.
Wenn Anführungszeichen Bestandteil des Variablenwerts sind, müssen sie mit Escapezeichen versehen werden. Beispiel: :setvar MyVar "spac""e".

Richtlinien für Werte und Namen der SET-Variable von Cmd.exe

Mit SET definierte Variablen sind Teil der Cmd.exe-Umgebung, und es kann mit sqlcmd auf sie verwiesen werden. Berücksichtigen Sie die folgenden Richtlinien:

Variablennamen dürfen keine Leerzeichen oder Anführungszeichen enthalten.
Variablenwerte dürfen Leerzeichen oder Anführungszeichen enthalten.

sqlcmd-Skriptvariablen

Mithilfe von sqlcmd definierte Variablen werden als Skriptvariablen bezeichnet. In der folgenden Tabelle sind die sqlcmd -Skriptvariablen aufgelistet.

Variable	Zugehörige Option	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 bei Verwendung von :Connect festgelegt.

² 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 Befehls setvar zurückgesetzt werden kann. Für nachfolgende Befehle wird der neue Wert verwendet.

Beispiele

A. Verwenden des setvar-Befehls in einem Skript

Viele sqlcmd -Optionen können in einem Skript mithilfe des Befehls setvar gesteuert werden. Im folgenden Beispiel wird das Skript test.sql erstellt, in dem die Variable SQLCMDLOGINTIMEOUT auf 60 Sekunden festgelegt ist. Eine weitere Skriptvariable ( server) wird auf testserverfestgelegt. Der folgende Code befindet sich in test.sql.

:setvar SQLCMDLOGINTIMEOUT 60
:setvar server "testserver"
:connect $(server) -l $(SQLCMDLOGINTIMEOUT)

USE AdventureWorks2022;

SELECT FirstName, LastName
FROM Person.Person;

Das Skript wird anschließend mit „sqlcmd“ aufgerufen:

sqlcmd -i c:\test.sql

B. Interaktives Verwenden des setvar-Befehls

Im folgenden Beispiel wird veranschaulicht, wie eine Skriptvariable mithilfe des setvar -Befehls interaktiv festgelegt wird.

sqlcmd
:setvar MYDATABASE AdventureWorks2022
USE $(MYDATABASE);
GO

Hier sehen Sie das Ergebnis.

Changed database context to 'AdventureWorks2022'
1>

C. Verwenden von Umgebungsvariablen der Eingabeaufforderung in „sqlcmd“

Im folgenden Beispiel werden vier Umgebungsvariablen are festgelegt und dann von sqlcmd aufgerufen.

SET tablename=Person.Person
SET col1=FirstName
SET col2=LastName
SET title=Ms.
sqlcmd -d AdventureWorks2022
1> SELECT TOP 5 $(col1) + ' ' + $(col2) AS Name
2> FROM $(tablename)
3> WHERE Title ='$(title)'
4> GO

D: Verwenden von Umgebungsvariablen auf Benutzerebene in „sqlcmd“

Im folgenden Beispiel wird die Umgebungsvariable %Temp% auf Benutzerebene an der Eingabeaufforderung festgelegt und an die Eingabedatei sqlcmd übergeben. Zum Abrufen der Umgebungsvariable auf Benutzerebene doppelklicken Sie unter Systemsteuerungauf System. Wählen Sie die Registerkarte Erweitert und dann Umgebungsvariablen aus.

In der Eingabedatei C:\testscript.txtist der folgende Code enthalten:

:OUT $(MyTempDirectory)
USE AdventureWorks2022;

SELECT FirstName
FROM AdventureWorks2022.Person.Person
WHERE BusinessEntityID < 5;

Der folgende Code wird an der Eingabeaufforderung eingegeben:

SET MyTempDirectory=%Temp%\output.txt
sqlcmd -i C:\testscript.txt

Das folgende Ergebnis wird an die Ausgabedatei C:\Documents and Settings\<user>\Local Settings\Temp\output.txt gesendet.

Changed database context to 'AdventureWorks2022'.
FirstName
--------------------------------------------------
Gustavo
Catherine
Kim
Humberto

(4 rows affected)

E. Verwenden eines Startskripts

Beim Starten von sqlcmd wird ein sqlcmd -Startskript ausgeführt. Im folgenden Beispiel wird die Umgebungsvariable SQLCMDINIfestgelegt. Dies ist der Inhalt von init.sql.

SET NOCOUNT ON
GO

DECLARE @nt_username nvarchar(128)
SET @nt_username = (SELECT rtrim(convert(nvarchar(128), nt_username))
FROM sys.dm_exec_sessions WHERE spid = @@SPID)
SELECT  @nt_username + ' is connected to ' +
rtrim(CONVERT(nvarchar(20), SERVERPROPERTY('servername'))) +
' (' +`
rtrim(CONVERT(nvarchar(20), SERVERPROPERTY('productversion'))) +
')'
:setvar SQLCMDMAXFIXEDTYPEWIDTH 100
SET NOCOUNT OFF
GO

:setvar SQLCMDMAXFIXEDTYPEWIDTH

Damit wird die Datei init.sql beim Starten von sqlcmd aufgerufen.

SET sqlcmdini=c:\init.sql
sqlcmd

Dies ist die Ausgabe.

1> <user> is connected to <server> (9.00.2047.00)

Hinweis

Mit der Option -X wird die Startskriptfunktion deaktiviert.

F. Variablenerweiterung

Im folgenden Beispiel wird die Verwendung von Daten in Form einer sqlcmd -Variablen veranschaulicht.

USE AdventureWorks2022;
GO
CREATE TABLE AdventureWorks2022.dbo.VariableTest (Col1 NVARCHAR(50));
GO

Fügen Sie eine Zeile in Col1 von dbo.VariableTest ein, in der der Wert $(tablename)enthalten ist.

INSERT INTO AdventureWorks2022.dbo.VariableTest (Col1)
VALUES ('$(tablename)');
GO

Wenn an der Eingabeaufforderung sqlcmd keine Variable den Wert $(tablename) aufweist, geben die folgenden Anweisungen die Zeile sowie die Meldung „Die tablename-Skriptvariable ist nicht definiert“ aus. Das sqlcmd-Flag -b ist standardmäßig nicht festgelegt. Wenn -b festgelegt ist, wird sqlcmd nach dem Fehler „Variable nicht definiert“ beendet.

sqlcmd
1> SELECT Col1 FROM dbo.VariableTest WHERE Col1 = '$(tablename)';
2> GO
3> SELECT Col1 FROM dbo.VariableTest WHERE Col1 = N'$(tablename)';
4> GO

Hier sehen Sie das Ergebnis.

1> Col1
2> ------------------
3> $(tablename)
4>
5> (1 rows affected)

Es wird angenommen, dass die Variable MyVar auf $(tablename)festgelegt ist.

6> :setvar MyVar $(tablename)

Die Zeile wird mit diesen Anweisungen zurückgegeben. Außerdem wird die Meldung "Die 'tablename'-Skriptvariable ist nicht definiert." zurückgegeben.

6> SELECT Col1 FROM dbo.VariableTest WHERE Col1 = '$(tablename)';
7> GO

1> SELECT Col1 FROM dbo.VariableTest WHERE Col1 = N'$(tablename)';
2> GO

Die Zeile wird mit diesen Anweisungen zurückgegeben.

1> SELECT Col1 FROM dbo.VariableTest WHERE Col1 = '$(MyVar)';
2> GO

1> SELECT Col1 FROM dbo.VariableTest WHERE Col1 = N'$(MyVar)';
2> GO

Teilen über