Использование программы sqlcmd с переменными сценария

Статья
12/15/2008

Изменения: 17 июля 2006 г.

Переменные, которые используются в сценариях, называются переменными сценария. Переменные сценария позволяют использовать один сценарий в различных обстоятельствах. Например, если нужно выполнить один сценарий на нескольких серверах, вместо изменения сценария для каждого сервера можно указать для имени сервера соответствующую переменную сценария. Изменяя имя сервера, указываемое в переменной сценария, можно выполнять один и тот же сценарий на разных серверах.

Переменные сценария можно определить явно с помощью команды setvar или неявно с помощью параметра -v программы sqlcmd.

Кроме того, этот раздел содержит примеры определения переменных среды в командной строке Cmd.exe с помощью инструкции SET.

Настройка переменных сценария с помощью команды setvar

Команда setvar используется для определения переменных сценария. Переменные, определенные с помощью команды setvar, предназначены для внутреннего хранения. Переменные сценария не следует путать с переменными среды, которые определяются в командной строке с помощью инструкции SET. Если сценарий ссылается на переменную, которая не является переменной среды или не определена с помощью команды setvar, то возвращается сообщение об ошибке, и выполнение сценария останавливается. Дополнительные сведения см. в описании параметра -b в разделе Программа sqlcmd.

Приоритет переменных (от низкого к высокому)

Если несколько переменных имеют одинаковое имя, то используется переменная с более высоким приоритетом.

Системные переменные среды.
Пользовательские переменные среды.
Командная оболочка (SET X=Y), заданная в командной строке перед запуском sqlcmd.
sqlcmd-v X=Y.
:Setvar X Y.

Примечание.
Чтобы просмотреть переменные среды, на панели управления откройте компонент Система и перейдите на вкладку Дополнительно.

Неявное задание переменных сценария

При запуске программы sqlcmd с параметром, с которым связана переменная sqlcmd, переменной sqlcmd неявно присваивается значение, заданное для этого параметра. В следующем примере программа sqlcmd запускается с параметром -l. Этим неявно определяется переменная SQLLOGINTIMEOUT.

c:\> sqlcmd -l 60

Кроме того, переменные сценария, которые есть в сценарии, задаются с помощью параметра -v. В следующем сценарии (имя файла testscript.sql) ColumnName является переменной сценария.

USE AdventureWorks;

SELECT c.$(ColumnName)

FROM Person.Contact x

WHERE c.ContactID < 5;

Кроме того, с помощью параметра -v можно указать имя возвращаемого столбца:

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

Чтобы возвратить другой столбец с помощью того же сценария, измените значение переменной сценария ColumnName.

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

Правила выбора имен и значений переменных сценария

Присваивая имена переменным сценария, необходимо придерживаться следующих правил.

Имена переменных не должны содержать символов пробела и кавычек.
Имена переменных не должны иметь такую же форму, как у выражений переменных $(var).

В переменных сценария регистр не учитывается.

Примечание.
Если переменной среды sqlcmd не присвоено никакое значение, то переменная удаляется. При использовании :setvar VarName без значения переменная очищается.

Присваивая значения переменным сценария, необходимо придерживаться следующих правил.

Переменную, заданную с помощью параметра setvar или -v, необходимо заключать в кавычки, если строковая переменная содержит пробелы.
Если кавычки — часть значения переменной, то их необходимо экранировать. Например: :setvar MyVar "spac""e".

Правила присваивания значений и имен переменным с помощью команды Cmd.exe SET

Переменные, заданные с помощью инструкции SET, являются частью среды Cmd.exe, и на них может ссылаться программа sqlcmd. Необходимо учитывать следующие правила.

Имена переменных не должны содержать символов пробела и кавычек.
Значения переменных могут содержать символы пробела и кавычки.

Переменные сценария sqlcmd

Переменные, которые определяются программой sqlcmd, называются переменными сценария. В следующей таблице приведен список переменных сценария программы sqlcmd.

Переменная	Связанный параметр	R/W	По умолчанию
SQLCMDUSER*	-U	R	""
SQLCMDPASSWORD*	-P	--	""
SQLCMDSERVER*	-S	R	"DefaultLocalInstance"
SQLCMDWORKSTATION	-H	R	"ComputerName"
SQLCMDDBNAME	-d	R	""
SQLCMDLOGINTIMEOUT	-l	R/W	"8" (секунд)
SQLCMDSTATTIMEOUT	-t	R/W	"0" = неограниченное время ожидания
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" = неограниченное время ожидания
SQLCMDEDITOR		R/W	"edit.com"
SQLCMDINI		R	""

* SQLCMDUSER, SQLCMDPASSWORD и SQLCMDSERVER устанавливаются при использовании команды :Connect.

R соответствует значению, которое может быть задано только один раз в процессе инициализации программы.

R/W указывает, что значение можно изменить с помощью команды setvar, и последующие команды будут использовать уже новое значение.

Примеры

А. Использование команды setvar в сценарии

Команда setvar позволяет управлять многими параметрами программы sqlcmd. В следующем примере создается сценарий test.sql, в котором переменной SQLCMDLOGINTIMEOUT присваивается значение 60, а другой переменной сценария, server, присваивается значение testserver. Следующий код входит в сценарий test.sql.

:setvar SQLCMDLOGINTIMEOUT 60

:setvar server "testserver"

:connect $(server) -l $(SQLCMDLOGINTIMEOUT)

USE AdventureWorks;

SELECT FirstName, LastName

FROM Person.Contact;

The script is then called by using sqlcmd:

sqlcmd -i c:\test.sql

Б. Интерактивное использование команды setvar

В следующем примере показана интерактивная установка переменной сценария с помощью команды setvar.

sqlcmd

:setvar MYDATABASE AdventureWorks

USE $(MYDATABASE);

GO

Ниже приводится результирующий набор.

Changed database context to 'AdventureWorks'

1>

В. Использование переменных среды командной строки в программе sqlcmd

В следующем примере устанавливаются четыре переменные среды, которые затем вызываются из sqlcmd.

C:\>SET tablename=Person.Contact

C:\>SET col1=FirstName

C:\>SET col2=LastName

C:\>SET title=Ms.

C:\>sqlcmd -d AdventureWorks

1> SELECT TOP 5 $(col1) + ' ' + $(col2) AS Name

2> FROM $(tablename)

3> WHERE Title ='$(title)'

4> GO

Г. Использование переменных среды уровня пользователя в программе sqlcmd

В следующем примере пользовательская переменная среды %Temp% устанавливается в командной строке и передается входному файлу sqlcmd. Чтобы просмотреть пользовательские переменные среды, в панели управления дважды щелкните компонент Система. Перейдите на вкладку Дополнительно и щелкните Переменные среды.

Следующий программный код является частью входного файла c:\testscript.txt:

:OUT $(MyTempDirectory)

USE AdventureWorks;

SELECT FirstName

FROM AdventureWorks.Person.Contact

WHERE ContactID < 5;

Следующий программный код вводится в командной строке:

C:\ >SET MyTempDirectory=%Temp%\output.txt

C:\ >sqlcmd -i C:\testscript.txt

Следующий результат передается выходному файлу «C:\Documents and Settings\<user>\Local Settings\Temp\output.txt».

Changed database context to 'AdventureWorks'.

FirstName

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

Gustavo

Catherine

Kim

Humberto

(4 rows affected)

Д. Использование сценария запуска

Сценарий запуска sqlcmd представляет собой сценарий, выполняемый при запуске программы sqlcmd. В следующем примере задается переменная среды SQLCMDINI. Ниже приведено содержимое сценария init.sql.

SET NOCOUNT ON

GO

DECLARE @nt_user_name nvarchar(128)

SET @nt_user_name = (SELECT rtrim(convert(nvarchar(128), nt_user_name))

FROM sys.dm_exec_sessions WHERE session_id = @@SPID);

SELECT @nt_user_name + ' is connected to ' +

rtrim(CONVERT(nvarchar(20), SERVERPROPERTY('servername'))) + ' (' +

rtrim(CONVERT(nvarchar(20), SERVERPROPERTY('productversion'))) + ')';

:setvar SQLCMDMAXFIXEDTYPEWIDTH 100

SET NOCOUNT OFF

GO

:setvar SQLCMDMAXFIXEDTYPEWIDTH

Таким образом файл init.sql вызывается при запуске sqlcmd.

C:\> SET sqlcmdini=c:\init.sql

>1 Sqlcmd

Результат.

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

Примечание. Параметр -X отключает функцию запуска в сценарии.

Е. Использование расширения переменных

В следующем примере показана работа с данными с помощью переменной sqlcmd.

USE AdventureWorks;

CREATE TABLE AdventureWorks.dbo.VariableTest

(

Col1 nvarchar(50)

);

GO

Вставляет одну строку в столбец Col1 объекта базы данных dbo.VariableTest, содержащего значение $(tablename).

INSERT INTO AdventureWorks.dbo.VariableTest(Col1)

VALUES('$(tablename)');

GO

В командной строке sqlcmd, если ни одна переменная не равна $(tablename), следующие инструкции возвращают эту строку.

C:\> sqlcmd

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

>2 GO

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

>4 GO

Ниже приводится результирующий набор.

>1 Col1

>2 ------------------

>3 $(tablename)

>4

>5 (1 rows affected)

При условии, что переменная MyVar равна $(tablename).

>6 :setvar MyVar $(tablename)

Эти инструкции возвращают строку и сообщение «Переменная сценария "tablename" не определена».

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

>7 GO

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

>2 GO

Эти инструкции возвращают строку.

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

>2 GO

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

>2 GO

Журнал изменений

Версия	Журнал
17 июля 2006 г.	Добавления Добавлены примеры.

См. также

Использование программы sqlcmd с переменными сценария

Настройка переменных сценария с помощью команды setvar

Приоритет переменных (от низкого к высокому)

Неявное задание переменных сценария

Правила выбора имен и значений переменных сценария

Правила присваивания значений и имен переменным с помощью команды Cmd.exe SET

Переменные сценария sqlcmd

Примеры

А. Использование команды setvar в сценарии

Б. Интерактивное использование команды setvar

В. Использование переменных среды командной строки в программе sqlcmd

Г. Использование переменных среды уровня пользователя в программе sqlcmd

Д. Использование сценария запуска

Е. Использование расширения переменных

Журнал изменений

См. также

Основные понятия

Другие ресурсы

Справка и поддержка

Дополнительные ресурсы