Программа sqlcmd

Синтаксис

sqlcmd 
[{ { -U login_id [ -P password ] } | –E trusted connection }] 

[ -N encrypt connection ][ -C trust the server certificate ]
[ -z new password ] [ -Z new password and exit]
[ -S [protocol:]server[\instance_name][,port] ] [ -H wksta_name ] [ -d db_name ]
[ -l login time_out ] [ -A dedicated admin connection] 
[ -i input_file ] [ -o output_file ]
[ -f < codepage > | i: < codepage > [ < , o: < codepage > ] ]
[ -u unicode output] [ -r [ 0 | 1 ] msgs to stderr ] 
[ -R use client regional settings]
[ -q "cmdline query" ] [ -Q "cmdline query" and exit] 
[ -e echo input ] [ -t query time_out ] 
[ -I enable Quoted Identifiers ] 
[ -v var = "value"...] [ -x disable variable substitution ]
[ -h headers ][ -s col_separator ] [ -w column_width ] 
[ -W remove trailing spaces ]
[ -k [ 1 | 2 ] remove[replace] control characters ] 
[ -y display_width ] [-Y display_width ]
[ -b on error batch abort] [ -V severitylevel ] [ -m error_level ] 
[ -a packet_size ][ -c cmd_end ] 
[ -L [ c ] list servers[clean output] ] 
[ -p [ 1 ] print statistics[colon format]] 
[ -X [ 1 ] ] disable commands, startup script, enviroment variables [and exit] 
[ -? show syntax summary]

Параметры командной строки

• Параметры, связанные с именем входа

• -Ulogin_id
  Идентификатор входа пользователя.

  Примечание
  В целях обратной совместимости доступна переменная среды OSQLUSER. Переменная среды SQLCMDUSER имеет больший приоритет, чем OSQLUSER. То есть программы sqlcmd и osql могут функционировать одновременно, не мешая друг другу. Это означает также, что существующие скрипты osql не перестанут работать.

  Если не указаны ни параметр -U, ни параметр -P, то программа sqlcmd пытается подключиться с помощью режима проверки подлинности Microsoft Windows. При этом используется учетная запись пользователя Windows, который запустил программу sqlcmd.

  Если параметры -U и -E (описаны ниже в этом разделе) указаны одновременно, то будет выдано сообщение об ошибке. Если после параметра –U указано более одного аргумента, то выдается сообщение об ошибке и программа завершает свою работу.

• -Ppassword
  Пароль, заданный пользователем. Пароли учитывают регистр. Если указан параметр -U, а параметр -P отсутствует и не установлена переменная среды SQLCMDPASSWORD, программа sqlcmd запрашивает пароль у пользователя. Если параметр -P указывается в конце командной строки без указания пароля, то программа sqlcmd использует пароль по умолчанию (NULL).

  Примечание по безопасности
  Не используйте пустые пароли. Выбирайте надежные пароли. Дополнительные сведения см. в разделе Надежные пароли.

  Запрос на ввод пароля выводится на консоль следующим образом: Password:

  Вводимые пользователем данные на экране не отображаются. то есть символы не выводятся и курсор остается на месте.

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

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

  SET SQLCMDPASSWORD= p@a$$w0rd

  Примечание по безопасности
  Пароль будет отображаться на мониторе компьютера.

  В командной строке введите:

  sqlcmd

  Если обнаружено неверное сочетание имени пользователя и пароля, поставщик OLE DB выдает сообщение об ошибке.

  Примечание
  Переменная среды OSQLPASSWORD была сохранена в целях обратной совместимости. Переменная среды SQLCMDPASSWORD имеет больший приоритет, чем переменная среды OSQLPASSWORD. Это означает, что программы sqlcmd и osql могут использоваться одновременно, не мешая друг другу, и скрипты прежних версий не перестанут работать.

  Если параметр -P указан одновременно с параметром -E, то выдается сообщение об ошибке.

  Если после параметра -P указано более одного аргумента, то выдается сообщение об ошибке и программа завершает свою работу.

• -E trusted connection
  Использует для соединения с SQL Server вместо имени пользователя и пароля доверительное соединение. По умолчанию, если параметр -E не указан, программа sqlcmd использует доверительное соединение.

  Параметр -E не использует имя пользователя и пароль, указанные в переменных среды SQLCMDPASSWORD и др. Если параметр -E используется в сочетании с параметром -U или -P, то будет выдано сообщение об ошибке.

• -Nencrypt connection
  С помощью этого переключателя клиент запрашивает шифрованное соединение. Этот параметр аналогичен параметру ADO.net ENCRYPT = true.

• -Ctrust the server certificate
  С помощью этого переключателя клиент настраивает неявное доверие к сертификату сервера без проверки. Этот параметр аналогичен параметру ADO.net TRUSTSERVERCERTIFICATE = true.

• -z new password
  Сменить пароль:

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

• -Z new password and exit
  Сменить пароль и выйти:

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

• -S [protocol:]server[**\instance_name][,**port]
  Указывает экземпляр SQL Server, к которому выполняется подключение. Устанавливает переменную скрипта SQLCMDSERVER программы sqlcmd.

  Укажите server для подключения к экземпляру SQL Server по умолчанию на этом сервере. Укажите server[ **\**instance_name], чтобы подключиться к именованному экземпляру SQL Server на этом сервере. Если сервер не указан, программа sqlcmd установит соединение с экземпляром SQL Server по умолчанию на локальном компьютере. Этот параметр необходим при выполнении программы sqlcmd с удаленного компьютера в сети.

  Ключевое слово protocol может иметь значение tcp (TCP/IP), lpc (общая память) или np (именованные каналы). Дополнительные сведения о протоколах см. в разделе Выбор сетевого протокола.

  Если значение server[ **\**instance_name] при запуске программы sqlcmd не указано, то SQL Server проверит наличие переменной среды SQLCMDSERVER и, если она установлена, использует ее значение.

  Примечание
  Переменная среды OSQLSERVER была сохранена в целях обратной совместимости. Переменная среды SQLCMDSERVER имеет больший приоритет, чем переменная среды OSQLSERVER. Это означает, что программы sqlcmd и osql могут функционировать одновременно, не мешая друг другу, и скрипты прежних версий не перестанут работать.

• -Hwksta_name
  Имя рабочей станции. Этот параметр устанавливает переменную скрипта SQLCMDWORKSTATION программы sqlcmd. Имя рабочей станции заносится в столбец hostname представления каталога sys.processes и может быть возвращено с помощью хранимой процедуры sp_who. Если этот параметр не указан, по умолчанию используется текущее имя компьютера. Это имя может использоваться для идентификации сеансов работы программы sqlcmd.

• -ddb_name
  Выдает инструкцию USE db_name при запуске программы sqlcmd. Этот параметр устанавливает переменную скрипта SQLCMDDBNAME программы sqlcmd. Она задает начальную базу данных. По умолчанию свойство default-database имени входа. Если база данных не существует, то выдается сообщение об ошибке и программа sqlcmd завершает свою работу.

• -llogintime_out
  Задает время ожидания (в секундах) при подключении программы sqlcmd через поставщик OLE DB при попытке соединения с сервером. Этот параметр устанавливает переменную скрипта SQLCMDLOGINTIMEOUT программы sqlcmd. По умолчанию время ожидания входа для программы sqlcmd составляет восемь секунд. Время ожидания входа должно быть числом в диапазоне от 0 до 65 534. Если указанное значение не является числом или выходит за пределы указанного диапазона, то программа sqlcmd выдаст сообщение об ошибке. Значение 0 задает неограниченное время ожидания.

• -A dedicated admin connection
  Входит на SQL Server посредством выделенного административного соединения. Этот вид соединения предназначен для устранения неполадок на сервере. Параметр будет работать только с теми серверами, которые поддерживают выделенные административные соединения. Если такое соединение недоступно, то программа sqlcmd выдает сообщение об ошибке и завершает свою работу. Дополнительные сведения о языке DAC см. в разделе Использование выделенного административного соединения.

• Input/Output Options

• -i input_file[***,***input_file2...]
  Указывает файл, содержащий пакет инструкций или хранимых процедур SQL. Можно указать несколько файлов, которые будут считываться и обрабатываться в указанном порядке. Не разделяйте имена файлов пробелами. Программа sqlcmdсначала производит проверку наличия всех указанных файлов. Если хотя бы один из файлов не найден, то программа sqlcmd завершит работу. Параметры -i и -Q/-q являются взаимоисключающими.

  Примеры пути:

  -i C:\<имя_файла>

  -i \\<Сервер>\<Общая_папка$>\<имя_файла>

  -i "C:\Некоторая папка\<имя файла>"

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

  Этот параметр можно указывать многократно: -i input_file -i I input_file.

• -ooutput_file
  Указывает файл, в который поступают выходные данные программы sqlcmd.

  Если указан параметр -u, output_file сохраняется в Юникоде. Если имя файла недопустимо, выдается сообщение об ошибке и программа sqlcmd завершает работу. Одновременная запись нескольких процессов в один файл не поддерживается. В этом случае выводимые в файл данные будут неверны или повреждены. Дополнительные сведения о форматах файлов см. в разделе о параметре -f. Если этот файл не существует, он будет создан. Файл от предыдущего сеанса работы программы sqlcmd с тем же именем будет перезаписан. Указанный здесь файл не является файлом stdout. Если указан файл stdout, то этот файл не будет использоваться.

  Примеры пути:

  -o C:\< имя_файла>

  -o \\<Сервер>\<Общая_папка$>\<имя_файла>

  **-o "**C:\Некоторая папка\<имя файла>"

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

• -f < codepage > | i: < codepage > [ <, o: < codepage > ]
  Задает входные и выходные кодовые страницы. Номер кодовой страницы — это числовое значение, которое определяет установленную кодовую страницу Windows. Дополнительные сведения см. в разделе Настройка параметров сортировки в программе установки.

  Правила преобразования кодовых страниц:

  • Если кодовая страница не задана, то программа sqlcmd использует текущую кодовую страницу как для входных, так и для выходных файлов. Если входной файл в Юникоде, то в этом случае преобразование не требуется.

  • Программа sqlcmd автоматически распознает входные файлы в Юникоде как с прямым, так и с обратным порядком байтов. Если задан параметр -u, то выходные данные всегда будут в Юникоде с прямым порядком следования байтов.

  • Если выходной файл не задан, то выходные данные будут иметь кодовую страницу консоли. Это обеспечивает правильное отображение данных на консоли.

  • Предполагается, что все входные файлы имеют одинаковую кодовую страницу. Входные файлы в Юникоде и не в Юникоде можно обрабатывать вместе.

  Чтобы проверить кодовую страницу Cmd.exe, введите в командной строке команду chcp.

• -u unicode output
  Указывает, что output_file хранится в Юникоде вне зависимости от формата файла input_file.

• -r[ 0 | 1] msgs to stderr
  Перенаправляет вывод сообщений об ошибке на экран (stderr). Если параметр не указан или если указано значение 0, происходит перенаправление только сообщений об ошибках с уровнем серьезности 11 и выше. Если указать 1, то происходит перенаправление всех сообщений об ошибках (включая команду PRINT). Не имеет эффекта, если указан параметр -o. По умолчанию сообщения отправляются в stdout.

• -R use client regional settings
  Дает sqlcmd указание локализовать числовые столбцы, а также столбцы валюты, даты и времени, полученные от SQL Server, с учетом локали клиента. По умолчанию значения в этих столбцах отображаются согласно региональным стандартам, заданным на сервере.

• Параметры выполнения запроса

• -q" cmdline query "
  При запуске программы sqlcmd выполняет запрос, но выход из программы sqlcmd по завершении его выполнения не производится. Могут быть выполнены несколько запросов, разделенных точкой с запятой. Заключайте запрос в кавычки, как показано в следующем примере.

  В командной строке введите:

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

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

  Важно!
  Не используйте в запросе признак конца GO.

  Если вместе с этим параметром указан аргумент -b, то при возникновении ошибки работа программы sqlcmd будет завершена. Аргумент -b будет описан далее в этом разделе.

• **-Q"**cmdline query " and exit
  При запуске программы sqlcmd выполняет запрос и немедленно завершает работу. Могут быть выполнены несколько запросов, разделенных точкой с запятой.

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

  В командной строке введите:

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

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

  Важно!
  Не используйте в запросе признак конца GO.

  Если вместе с этим параметром указан аргумент -b, то при возникновении ошибки работа программы sqlcmd будет завершена. Аргумент -b будет описан далее в этом разделе.

• -e echo input
  Выдает входные скрипты на стандартное устройство вывода (stdout).

• -I enable Quoted Identifiers
  Устанавливает значение ON для параметра соединения SET QUOTED_IDENTIFIER. По умолчанию этот параметр имеет значение OFF. Дополнительные сведения см. в разделе SET QUOTED_IDENTIFIER (Transact-SQL).

• -tquerytime_out
  Задает число секунд времени ожидания команды (или инструкции SQL). Этот параметр устанавливает переменную скрипта SQLCMDSTATTIMEOUT программы sqlcmd. Если значение time_out не указывается, то команда имеет неограниченное время ожидания. Значение аргумента querytime_out должно быть из интервала от 1 до 65 535. Если указанное значение не является числом или выходит за пределы указанного диапазона, то программа sqlcmd выдаст сообщение об ошибке.

  Примечание
  Фактическое время ожидания может отличаться от указанного значения time_out на несколько секунд.

• -vvar*=value[ var=*value...]
  Создает переменную скрипта sqlcmd, которая может быть использована в скрипте sqlcmd. Если значение содержит пробелы, заключите его в кавычки. Можно определить несколько пар переменная="values". Если в каком-либо из указанных значений обнаружена ошибка, программа sqlcmd выдает сообщение об этом и завершает работу.

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

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

• -x disable variable substitution
  Указывает, что программа sqlcmd не должна обрабатывать переменные скрипта. Это может оказаться полезным в том случае, если в скрипте содержится много инструкций INSERT, которые могут содержать строки, имеющие тот же формат, что и обычные переменные, т.е. $(variable_name).

• Параметры форматирования

• -hheaders
  Указывает количество строк для печати между заголовками столбцов. По умолчанию заголовки печатаются один раз для каждого набора результатов запроса. Этот параметр устанавливает переменную скрипта SQLCMDHEADERS программы sqlcmd. Используйте значение -1 для отмены печати заголовков. Любое недопустимое значение приводит к тому, что программа sqlcmd создает сообщение об ошибке и завершает свою работу.

• -scol_separator
  Задает символ-разделитель столбцов. Значением по умолчанию является пробел. Этот параметр устанавливает переменную скрипта SQLCMDCOLSEP программы sqlcmd. Чтобы использовать символы, имеющие специальное значение для операционной системы, такие как амперсанд (&) или точка с запятой (;), заключайте этот символ в кавычки ("). Разделитель столбцов может быть любым 8-разрядным символом.

• -wcolumn_width
  Задает ширину экрана для вывода. Этот параметр устанавливает переменную скрипта SQLCMDCOLWIDTH программы sqlcmd. Ширина столбца должна находиться в диапазоне от 8 до 65 536. Если указанное значение ширины столбца выходит за пределы указанного диапазона, то программа sqlcmd выдаст сообщение об ошибке. Ширина по умолчанию составляет 80 символов. Когда строка вывода превышает указанную ширину столбца, вывод переносится на следующую строку.

• -W remove trailing spaces
  Этот параметр удаляет конечные пробелы в столбце. При подготовке данных для экспорта в другое приложение указывайте этот параметр вместе с параметром -s. Не может указываться одновременно с параметром -y или -Y.

• -k[ 1 | 2 ] remove[replace] control characters
  Удаляет из выходных данных все управляющие символы, такие как символы табуляции и символы новой строки. Это сохраняет формат столбцов при возврате данных. При указании значения 1 управляющие символы заменяются одиночным пробелом. Если указано значение 2, все последовательные управляющие символы заменяются одиночным пробелом.

• -ydisplay_width
  Этот параметр устанавливает переменную скрипта SQLCMDMAXFIXEDTYPEWIDTH программы sqlcmd. Ограничивает число символов, возвращаемых для больших типов данных переменной длины:

  • varchar(max)

  • nvarchar(max)

  • varbinary(max)

  • xml

  • UDT (user-defined data types)

  • text

  • ntext

  • image

  Примечание
  Определяемые пользователем типы могут иметь фиксированную длину в зависимости от реализации. Если фиксированная длина определяемого пользователем типа короче, чем значение переменной display_width, то значение типа возвращается без изменений. Однако если длина превышает значение display_width, то производится усечение выходных данных.

  Если для параметра «ширина_экрана» указано значение 0, происходит усечение размера выходных данных до 1 МБ. Чтобы предотвратить усечение данных, можно воспользоваться командой :XML ON. Эта команда описана далее в этом разделе.

  Важно!
  Пользуйтесь параметром -y 0 с особой осторожностью, поскольку при большом объеме возвращаемых данных это может значительно снизить производительность работы сервера и сети.

• -Ydisplay_width
  Этот параметр устанавливает переменную скрипта SQLCMDMAXVARTYPEWIDTH программы sqlcmd. Значение по умолчанию равно 256. Ограничивает число символов, возвращаемых для следующих типов данных:

  • char

  • nchar

  • varchar(n), где 1<n<8000

  • nvarchar(n), где 1<n<4000

  • sql_variant

• Параметры отчета об ошибках

• -b on error batch abort
  Указывает, что в случае ошибки программа sqlcmd завершает работу и возвращает значение DOS ERRORLEVEL. Значение, возвращаемое в переменную DOS ERRORLEVEL, равно 1, если сообщение об ошибке SQL Server имеет степень серьезности выше 10. В противном случае возвращаемое значение равно 0. Если параметр -V был указан вместе с параметром -b, то программа sqlcmd не будет выдавать сообщение об ошибках, степень серьезности которых ниже значения, заданного параметром -V. Пакетный файл командной строки может проверить значение ERRORLEVEL и выполнить соответствующую обработку ошибки. Программа sqlcmd не выдает сообщений об ошибках со степенью серьезности 10 (информационные сообщения).

  Если скрипт программы sqlcmd содержит неверный комментарий, синтаксическую ошибку или обнаружено отсутствие переменной скрипта, то возвращается значение ERRORLEVEL, равное 1.

• -V severitylevel
  Управляет степенью серьезности, используемой для задания переменной ERRORLEVEL. Сообщения об ошибках со степенями серьезности, меньшими или равными этому значению, устанавливают переменную ERRORLEVEL. Значения меньше 0 сообщаются как 0. Пакетные файлы и CMD-файлы могут быть использованы для проверки значения переменной ERRORLEVEL.

• -merror_level
  Определяет, какие сообщения об ошибках передаются в stdout. Передаются сообщения со степенью серьезности, меньшей или равной заданной. Если это значение равно -1, передаются все сообщения, в том числе информационные. Пробелы между -m и -1 не допускаются. Например, узел -m-1 является допустимым, а узел -m-1 — недопустимым.

  Этот параметр также задает переменную скрипта sqlcmd SQLCMDERRORLEVEL. По умолчанию ее значение равно 0.

• Различные параметры

• -apacket_size
  Запрашивает пакет другого размера. Этот параметр устанавливает переменную скрипта SQLCMDPACKETSIZE программы sqlcmd. Параметр packet_size должен иметь значение в диапазоне от 512 до 32 767. Значение по умолчанию 4096. Увеличение размера пакета повышает производительность выполнения скриптов, содержащих большое количество инструкций SQL между командами GO. Вы можете запросить больший размер пакета. Однако в том случае, если запрос будет запрещен, программа sqlcmd использует размер пакета по умолчанию для сервера.

• -ccmd_end
  Задает признак конца пакета. По умолчанию команды завершаются и отправляются на SQL Server при вводе слова «GO» в отдельной строке. При сбросе признака конца пакета не используйте зарезервированные ключевые слова или символы Transact-SQL, которые имеют специальное значение для операционной системы, даже если перед ними присутствует символ обратной косой черты.

• -L [ c ] list servers[clean output]
  Выводит список локально настроенных серверов и имена серверов, осуществляющих передачу данных в сети. Этот параметр не может использоваться в сочетании с другими параметрами. Максимальное число компьютеров серверов, которое можно указать, составляет 3 000. При усечении списка серверов в связи с нехваткой размера буфера выдается предупреждающее сообщение.

  Примечание
  Из-за особенностей сетевого широковещания программа sqlcmd не всегда своевременно получает ответ от всех серверов. Поэтому возвращаемый список серверов от вызова к вызову может различаться.

  Если указан дополнительный параметр «c», выводимые данные отображаются без строки заголовка «Серверы», а строка каждого сервера выводится без начальных пробелов. Это называется «чистым выводом». Чистый выход улучшает производительность обработки языков скриптов.

• -p[ 1 ] print statistics[colon format]
  Выводит на печать статистику производительности для каждого результирующего набора. Далее представлен пример формата для статистики производительности:

  Network packet size (bytes): n

  x xact[s]:

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

  Где:

  x = Количество транзакций, обработанных SQL Server.

  t1 = Общее время обработки всех транзакций.

  t2 = Среднее время обработки одной транзакции.

  t3 = Среднее количество транзакций, обрабатываемых в секунду.

  Все значения времени приведены в миллисекундах.

  Если указывается необязательный параметр 1, статистика выводится в формате со столбцами, разделенными двоеточиями, и может быть легко импортирована в электронную таблицу или обработана скриптом.

  Если необязательный параметр имеет любое значение, кроме 1, то выводится сообщение об ошибке и программа sqlcmd завершает работу.

• -X [ 1 ] disable commands, startup script, enviroment variables [and exit]
  Отключает команды, которые могут поставить под угрозу безопасность системы при выполнении программы sqlcmd из пакетного файла. Отключенные команды по-прежнему распознаются: sqlcmd выдает предупреждающее сообщение и продолжает работу. Если необязательный параметр равен 1, программа sqlcmd выдает сообщение об ошибке и завершает работу. При использовании параметра -X происходит отключение следующих команд:

  • ED

  • **!!**command

  Указание параметра -X блокирует передачу переменных среды программе sqlcmd. Он также препятствует выполнению сценария запуска, указанного с помощью переменной скрипта SQLCMDINI. Дополнительные сведения об использовании переменных скрипта sqlcmd см. в разделе Использование программы sqlcmd с переменными скрипта.

• -? show syntax summary
  Отображает сводку по синтаксису параметров программы sqlcmd.

Замечания

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

Если возвращается несколько результатов, то программа sqlcmd выводит между результирующими наборами в пакете пустую строку. Кроме того, сообщение «обработано строк: <x>» не выдается, если оно не соответствует выполненной инструкции.

Для работы с программой sqlcmd в интерактивном режиме введите в командной строке sqlcmd, указав любой из параметров, описанных ранее в этом разделе. Дополнительные сведения см. в разделе Использование программы sqlcmd.

Примечание
При указании параметра -L, -Q, -Z или -i программа sqlcmd завершает работу после выполнения.

Суммарная длина командной строки программы sqlcmd в командной среде (Cmd.exe), включая все аргументы и расширение переменных, соответствует длине для программы Cmd.exe и определяется операционной системой.

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

1. Переменные среды системного уровня.

2. Переменные среды пользовательского уровня

3. Командная оболочка (SET X=Y) перед запуском программы sqlcmd выдает подсказку командной строки.

4. sqlcmd-v X=Y

5. :Setvar X Y

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

Переменные скрипта sqlcmd

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

Пометка «Чтение» означает, что значение может быть задано только один раз в процессе инициализации программы.

Пометка «Чтение и запись» означает, что переменная может быть изменена командой setvar и все последующие команды будут использовать новое значение.

Команды sqlcmd

В дополнение к инструкциям Transact-SQL в программе sqlcmd доступны также следующие команды:

При использовании команд программы sqlcmd следует учитывать следующие особенности.

• Все команды sqlcmd, за исключением GO, должны предваряться двоеточием (:).

  Важно!
  Для поддержки обратной совместимости с существующими скриптами osql некоторые команды будут распознаваться без двоеточия. На это указывают символы [:].

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

• Во всех командах sqlcmd регистр символов не учитывается.

• Каждая команда должна находиться на отдельной строке. За командой не должна следовать инструкция Transact-SQL или другая команда.

• Команды выполняются немедленно. Они не помещаются в буфер выполнения, как инструкции Transact-SQL.

• Команды изменения

• [:] ED
  Производит запуск текстового редактора. Этот редактор может использоваться для изменения текущего пакета Transact-SQL или последнего выполненного пакета. Для изменения последнего выполненного пакета необходимо ввести команду ED сразу после выполнения последнего пакета.

  Текстовый редактор определяется переменной среды SQLCMDEDITOR. Редактором по умолчанию является «Edit». Чтобы изменить редактор, установите переменную среды SQLCMDEDITOR. Например, чтобы установить в качестве редактора Блокнот (Майкрософт), в командной строке введите:

  SET SQLCMDEDITOR=notepad

• [:] RESET
  Очистка кэша инструкций.

• :List
  Вывод содержимого кэша инструкций.

• Переменные

• :Setvar <var> [ "value" ]
  Определяет переменные скрипта sqlcmd. Переменные скрипта имеют следующий формат: $(VARNAME).

  Имена переменных не зависят от регистра символов.

  Переменные скрипта могут быть установлены следующими способами.

  • Неявно, с помощью параметра командной строки. Например, параметр -l устанавливает переменную скрипта SQLCMDLOGINTIMEOUT программы sqlcmd.

  • Явным образом, с помощью команды :Setvar.

  • Путем установки переменной среды до запуска программы sqlcmd.

  Примечание
  Параметр -X предотвращает передачу переменных среды программе sqlcmd.

  Если существует переменная среды, имеющая то же имя, что и переменная, определенная командой :Setvar, то больший приоритет имеет последняя.

  Имена переменных не должны содержать пробелы.

  Имена переменных не могут иметь тот же формат, что и выражение переменной: $(переменная).

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

• :Listvar
  Список переменных скрипта, заданных в настоящее время.

  Примечание
  Отображаются только переменные, установленные программой sqlcmd и командой :Setvar.

• Команды вывода

• :Error **<filename>|STDERR|STDOUT
  Перенаправляет вывод всех сообщений об ошибках в файл, указываемый параметром file name, в поток stderr или stdout. Команда Error может встречаться в скрипте несколько раз. По умолчанию вывод об ошибках направляется в STDERR.

  • file name
    Создает и открывает файл, который принимает выходные данные. Если файл уже существует, он будет усечен до 0 байт. Если файл недоступен по причине нехватки разрешений или по другим причинам, вывод перенаправляется не в него, а в последнее указанное назначение или в назначение по умолчанию.

  • STDERR
    Перенаправляет вывод сообщений об ошибках в поток stderr. Если было выполнено перенаправление, то адресат, которому был перенаправлен поток, получит выход ошибок.

  • STDOUT
    Перенаправляет выход ошибок в поток stdout. Если было выполнено перенаправление, то адресат, которому был перенаправлен поток, получит выход ошибок.

• :Out <filename>| STDERR| STDOUT
  Создает и переадресовывает все результаты запроса в файл, указываемый параметром file name, в stderr или в stdout. По умолчанию вывод направляется в stdout. Если файл уже существует, он будет усечен до 0 байт. Команда Out может встречаться в скрипте несколько раз.

• :Perftrace <filename>| STDERR| STDOUT
  Создает и переадресовывает все данные трассировки производительности в файл, указываемый параметром file name, в stderr или в stdout. По умолчанию вывод об отслеживании производительности направляется в stdout. Если файл уже существует, он будет усечен до 0 байт. Команда Perftrace может встречаться в скрипте несколько раз.

• Команды контроля выполнения

• :On Error[ exit | ignore]
  Установка действия, выполняемого при возникновении ошибки во время исполнения скрипта или пакета.

  Когда используется параметр exit, программа sqlcmd закрывается с указанием значения соответствующей ошибки.

  Если указан параметр ignore, то ошибка пропускается и продолжается выполнение пакета или скрипта. По умолчанию будет распечатано сообщение об ошибке.

• [:] QUIT
  Вызывает завершение работы программы sqlcmd.

• [:] EXIT[ (statement) ]
  Позволяет использовать результат выполнения инструкции SELECT в качестве возвращаемого значения программы sqlcmd. Если числовой, первый столбец последней строки результатов преобразуется в 4-байтовое целое число (long). В MS-DOS младший байт передается родительскому процессу или уровню ошибки операционной системы. В Windows 200x передается 4-байтовое целое число. Синтаксис:

  :EXIT(query)

  Например:

  :EXIT(SELECT @@ROWCOUNT)

  Также можно включить параметр EXIT в пакетный файл. Например, в командной строке введите:

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

  Программа sqlcmd отправляет на сервер все, что заключено в круглые скобки (). Если хранимая системная процедура выбирает набор и возвращает значение, то возвращается только выбранный набор. Инструкция EXIT ( ) с пустыми круглыми скобками выполняет все, что предшествует ей в пакете, а затем завершается, не возвращая значения.

  Если указан неверный запрос, программа sqlcmd завершит работу, не возвращая значения.

  Список форматов инструкции EXIT:

  • :EXIT

  Не выполняет пакет, немедленно завершает работу и не возвращает значения.

  • :EXIT( )

  Выполняет пакет, завершает выполнение и не возвращает значения.

  • :EXIT(query)

  Выполняет пакет, включая запрос, возвращает результаты запроса и завершает работу.

  Если в скрипте sqlcmd используется RAISERROR и при этом возникает состояние 127, то программа sqlcmd завершает выполнение и возвращает клиенту идентификатор сообщения. Например:

  RAISERROR(50001, 10, 127)

  Эта ошибка приведет к завершению скрипта sqlcmd, а клиенту будет возвращено сообщение с идентификатором 50001.

  Возвращаемые значения от -1 до -99 зарезервированы SQL Server. Программа sqlcmd дополнительно определяет следующие коды возврата:

  Возвращаемые значения	Описание
  -100	Перед выбором возвращаемого значения произошла ошибка.
  -101	При выборе возвращаемого значения не найдены строки.
  -102	При выборе возвращаемого значения произошла ошибка преобразования.

• GO [число]
  GO обозначает конец пакетного файла и исполнения любых кэшированных инструкций Transact-SQL. При задании значения для параметра count кэшируемые инструкции будут выполняться указанное count раз в виде единого пакета.

• Различные команды

• :r<filename>
  Производит синтаксический анализ дополнительных инструкций Transact-SQL и команд программы sqlcmd в файле с именем <filename>* *, загружая их в кэш инструкций.

  Если файл содержит инструкции Transact-SQL, за которыми не следует GO, необходимо ввести GO в строку, следующую за :r.

  Примечание
  Файл с именем <filename> считывается относительно стартового каталога, в котором была запущена программа sqlcmd.

  Файл будет считан и выполнен после обнаружения признака конца пакета. Можно указывать несколько команд :r. В файле могут содержаться любые команды программы sqlcmd, в том числе признак конца пакета GO.

  Примечание
  Число строк, отображаемых в интерактивном режиме, для каждой найденной команды :r будет увеличено на 1. Команда :r отображается в выводе команды list.

• :Serverlist
  Выводит список локально настроенных серверов и имена серверов, осуществляющих трансляцию данных в сети.

• :Connect server_name[**\**instance_name] [-l timeout] [-U user_name [-P password]]
  Соединяется с экземпляром SQL Server. Также закрывает текущее соединение.

  Параметры времени ожидания:

  0	ждать бесконечно
  n>0	ждать в течение n секунд

  Переменная скрипта SQLCMDSERVER отображает текущее активное соединение.

  Если не указан параметр timeout, то берется значение переменной SQLCMDLOGINTIMEOUT по умолчанию.

  Если указано только user_name(в виде параметра или в виде переменной среды), то у пользователя будет запрошен пароль. Однако этого не произойдет, если установлены переменные среды SQLCMDUSER или SQLCMDPASSWORD. Если ни параметры, ни переменные среды не введены, то для входа используется режим проверки подлинности Windows. Например, для подключения к экземпляру instance1 сервера SQL Server с именем myserver с использованием встроенной безопасности следует ввести следующую команду:

  :connect myserver\instance1

  Для подключения к экземпляру myserver по умолчанию с использованием переменных скрипта следует ввести следующее выражение:

  :setvar myusername test

  :setvar myservername myserver

  :connect $(myservername) $(myusername)

• [:] !!< command>
  Исполнение команд операционной системы. Чтобы выполнить команду операционной системы, запустите строку, содержащую два восклицательных знака (!!) и далее команду операционной системы. Например:

  :!! Dir

  Примечание
  Команда выполняется на компьютере, где работает программа sqlcmd.

• :XML [ON | OFF]
  Дополнительные сведения см. в подразделе «Формат выходных XML-данных» далее в этом разделе.

• :Help
  Выводит список команд программы sqlcmd вместе с кратким описанием каждой из них.

Имена файлов sqlcmd

Информационные сообщения

Формат вывода результатов выполнения запросов Transact-SQL

Формат вывода XML

Выходные XML-данные, получаемые в результате выполнения предложения FOR XML, выводятся непрерывным потоком в неформатированном виде.

Если ожидается вывод XML-данных, воспользуйтесь следующей командой: :XML ON.

Примечание
Программа sqlcmd выводит сообщения об ошибках в обычном формате. Обратите внимание, что сообщения об ошибках также выводятся в текстовый поток в формате XML. Если указать параметр :XML ON, программа sqlcmd не выводит информационные сообщения.

Чтобы отключить режим XML, введите следующую команду: :XML OFF.

Команда GO не должна указываться раньше команды XML OFF, поскольку последняя возвращает sqlcmd в режим вывода с построчным форматированием.

Не допускается смешивать XML-данные (потоковые) и данные набора строк. Если перед выполнением инструкции Transact-SQL, которая выводит потоки XML-данных, не была введена команда XML ON, то вывод будет искажен. Если была выполнена команда XML ON, то нельзя выполнить инструкции Transact-SQL, которые выводят обычные наборы строк.

Примечание
Команда :XML не поддерживает инструкцию SET STATISTICS XML.

Рекомендации по использованию sqlcmd

Чтобы добиться максимальной безопасности и эффективности, придерживайтесь следующих правил.

• Используйте встроенную безопасность.

• В автоматизированных средах указывайте параметр -X.

• Обеспечьте защиту входных и выходных файлов при помощи соответствующих разрешений файловой системы NTFS.

• В целях повышения производительности выполняйте как можно больше работы в одном сеансе программы sqlcmd.

• Задайте значение времени ожидания для выполнения пакетов или запросов выше, чем ожидаемое время их выполнения.

См. также

Задания

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