Поделиться через

Служебная программа sqlcmd

Применимо: SQL Server База данных SQL Azure Управляемый экземпляр SQL Azureбазе данных SQL Azure Synapse Analytics Analytics Platform System (PDW)в Microsoft Fabric

Служебная программа sqlcmd позволяет вводить инструкции Transact-SQL, системные процедуры и файлы скриптов с помощью различных режимов:

  • В командной строке.
  • В режиме SQLCMD в редакторе запросов.
  • В файле скрипта Windows.
  • На шаге задания операционной системы (cmd.exe) агент SQL Server задания.

Примечание.

Хотя идентификатор Microsoft Entra — это новое имя Azure Active Directory (Azure AD), чтобы предотвратить нарушение существующих сред, Azure AD по-прежнему остается в некоторых жестко закодированных элементах, таких как поля пользовательского интерфейса, поставщики подключений, коды ошибок и командлеты. В этой статье два имени являются взаимозаменяемыми.

Варианты sqlcmd

Существует два варианта sqlcmd:

  • sqlcmd (Go): go-mssqldb-версия sqlcmd, иногда стилизуется как go-sqlcmd. Эта версия является автономным инструментом, который можно скачать независимо от SQL Server. Он работает в Windows, macOS, Linux и в контейнерах.

  • sqlcmd (ODBC): адаптированный к платформе, sqlcmd на основе ODBC, доступный с SQL Server или служебными программами командной строки Microsoft, а также как часть пакета mssql-tools в Linux. Он также работает в Windows, macOS, Linux и в контейнерах.

Чтобы узнать, какой вариант и версия sqlcmd установлены в системе, см. статью "Проверка установленной версии служебной программы sqlcmd".

Сведения о том, как получить sqlcmd, см. в разделе "Скачать и установить служебную программу sqlcmd".

Поддержка TDS 8.0

Предварительная версия SQL Server 2025 (17.x) содержит поддержку TDS 8.0 для служебной программы sqlcmd .

Синтаксис

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 и использовании см. в синтаксисе ODBC sqlcmd.

Критические изменения из sqlcmd (ODBC)

Несколько коммутаторов и поведения изменяются в служебной программе sqlcmd (Go). Чтобы получить наиболее актуальный список отсутствующих флагов для обратной совместимости, перейдите к обсуждению GitHub по приоритету реализации флагов back-compats GitHub.

  • В более ранних версиях sqlcmd (Go) -P переключатель временно удален, а пароли для проверки подлинности SQL Server можно предоставить только с помощью этих механизмов:

    • Переменная среды SQLCMDPASSWORD
    • Команда :CONNECT
    • При появлении запроса пользователь может ввести пароль для завершения подключения.

  • -r требует аргумента 0 или 1.

  • Параметр -R удален.

  • Параметр -I удален. Чтобы отключить поведение идентификатора с разделителем, добавьте в скрипты SET QUOTED IDENTIFIER OFF.

  • -N принимает строковое значение, которое может быть одним из true, falseили disable указать выбор шифрования. (default — то же самое, что и пропуск параметра.)

    • Если -N и -C не предоставлены, sqlcmd согласовывает проверку подлинности с сервером без проверки сертификата сервера.
    • Если -N указано, но -C нет, sqlcmd требует проверки сертификата сервера. false Значение шифрования по-прежнему может привести к шифрованию пакета входа.
    • -N Если оба и -C указано, sqlcmd использует их значения для согласования шифрования.
    • Дополнительные сведения о согласовании шифрования клиента и сервера см. в разделе MS-TDS PRELOGIN.

    Внимание

    В предварительной версии SQL Server 2025 (17.x) -N может быть o (для optional), m (для mandatory, по умолчанию) или s (для strict). Если вы не включаете -N, -Nm (для mandatory) является значением по умолчанию. Это критическое изменение с SQL Server 2022 (16.x) и более ранних версий.

  • -u Созданный выходной файл Юникода содержит метку байтового порядка (BOM) UTF-16.

  • Некоторые поведения, которые были сохранены для обеспечения совместимости с OSQL, могли измениться, например выравнивание заголовков столбцов для некоторых типов данных.

  • Все команды должны помещаться в одну строку, даже EXIT. Интерактивный режим не проверяет наличие открытых скобок или кавычек для команд и не запрашивает последовательные строки. Это поведение отличается от версии ODBC, которая позволяет выполнять EXIT(query) запрос несколькими строками.

Подключения из служебной программы sqlcmd (Go) ограничены TCP-подключениями. Именованные каналы на данный момент не поддерживаются в драйвере go-mssqldb .

Усовершенствования

  • :Connectимеет необязательный -G параметр, чтобы выбрать один из методов проверки подлинности для базы данных SQL Azure — SqlAuthentication, ActiveDirectoryDefault, ActiveDirectoryIntegrated, ActiveDirectoryServicePrincipalActiveDirectoryManagedIdentity. ActiveDirectoryPassword Дополнительные сведения см. в разделе Аутентификация с помощью идентификатора Microsoft Entra в sqlcmd. Если -G это не указано, используется встроенная безопасность или проверка подлинности SQL Server в зависимости от наличия -U параметра имени пользователя.

  • Параметр командной строки --driver-logging-level позволяет просматривать трассировки от драйвера go-mssqldb. Для просмотра всех трассировок используйте 64.

  • sqlcmd (Go) может распечатать результаты с помощью вертикального формата. Используйте переключатель командной строки -F vertical, чтобы задать его. Переменная SQLCMDFORMAT скрипта также управляет ею.

    Примечание.

    Это отличается от переключателя -F для sqlcmd (ODBC), который используется с -N для указания имени узла в сертификате.

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

В следующей таблице перечислены параметры командной строки, доступные в sqlcmd, и какие операционные системы они поддерживают.

Параметр командной строки Поддерживается в Windows Поддерживается в Linux и macOS
Параметры, связанные с именем входа
-A Да нет
-C Да Да
-d db_name Да Да
-D Да Да
-l login_timeout Да Да
-E Да Да
-g Да Да
-G Да Да
-H workstation_name Да Да
-j Да Да
-K намерение_приложения Да Да
-M multisubnet_failover Да Да
-N Да Да
-P пароль Да Да
-S [протокол:]server[\instance_name][,port] Да Да
-U login_id Да Да
-z new_password Да Да
-Z new_password Да Да
Параметры ввода и вывода
-f codepage | i:codepage[,o:codepage] | o:codepage[,i:codepage] Да Да
-i input_file[,input_file2...] Да Да
-o output_file Да Да
-r[0 | 1] Да Да
-R Да Да
-u Да Да
Параметры выполнения запроса
-e Да Да
-Я Да Да
-q "cmdline query" Да Да
-Q "запрос cmdline" Да Да
-t query_timeout Да Да
-v var = value [ var = value... ] Да нет
-x Да Да
Параметры форматирования
-h заголовки Да Да
-k [1 | 2] Да Да
-s разделитель_столбцов Да Да
-w screen_width Да Да
-W Да Да
-y variable_length_type_display_width Да Да
-Y fixed_length_type_display_width Да Да
Параметры отчетов об ошибках
-b Да Да
-m error_level Да Да
-V error_severity_level Да Да
Другие параметры
-a packet_size Да Да
-c batch_terminator Да Да
-L[c] Да нет
-p[1] Да Да
-X[1] Да Да
-? Да Да

-A

применяется только к: Windows. Linux и macOS не поддерживаются.

Войдите в SQL Server с помощью выделенного подключения администратора (DAC). Этот вид соединения предназначен для устранения неполадок на сервере. Это подключение работает только с серверными компьютерами, поддерживающими выделенное административное подключение (DAC). Если DAC недоступен, sqlcmd создает сообщение об ошибке, а затем завершает работу. Дополнительные сведения о DAC см. в разделе "Диагностика подключения для администраторов баз данных". Параметр -A не поддерживается с параметром -G . При подключении к База данных SQL Azure с помощью -Aнеобходимо быть администратором на логическом сервере SQL Server. DAC недоступен для администратора Microsoft Entra.

Примечание.

Сведения о том, как сделать подключение к выделенному администратору (DAC) в macOS или Linux, см. в руководствах по программированию.

C-

Этот параметр используется клиентом, чтобы настроить его для неявного доверия сертификату сервера без проверки. Этот параметр аналогичен параметру ADO.NET TRUSTSERVERCERTIFICATE = true.

Для служебной программы sqlcmd (Go) также применяются следующие условия:

  • Если -N и -C не предоставлены, sqlcmd согласовывает проверку подлинности с сервером без проверки сертификата сервера.
  • Если -N указано, но -C нет, sqlcmd требует проверки сертификата сервера. false Значение шифрования по-прежнему может привести к шифрованию пакета входа.
  • -N Если оба и -C указано, sqlcmd использует их значения для согласования шифрования.

-d db_name

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

-D

Интерпретирует имя сервера, предоставленное -S как dsN, вместо имени узла. Дополнительные сведения см. в статье о поддержке DSN в sqlcmd и bcp.

Примечание.

Этот -D параметр доступен только в клиентах Linux и macOS. В клиентах Windows он относится к устаревшему варианту, который был удален и игнорируется.

-l login_timeout

Задает время ожидания (в секундах) при подключении программы sqlcmd через драйвер ODBC при попытке соединения с сервером. Этот параметр задает . Время ожидания по умолчанию для входа в sqlcmd составляет 8 секунд. При использовании -G параметра подключения к базе данных SQL Azure или Azure Synapse Analytics и аутентификации с помощью идентификатора Microsoft Entra рекомендуется время ожидания не менее 30 секунд. Время ожидания входа должно быть числом между 0 и 65534. Если указанное значение не является числовым или не попадает в этот диапазон, sqlcmd создает сообщение об ошибке. Значение, указывающее 0 время ожидания, которое должно быть бесконечным.

E-

Для входа в SQL Server вместо имени пользователя и пароля использует доверительное соединение. По умолчанию без -E указания sqlcmd использует параметр доверенного подключения.

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

Примечание.

Дополнительные сведения о создании доверенных подключений, использующих встроенную проверку подлинности из клиента Linux или macOS, см. в разделе "Использование встроенной проверки подлинности".

g-

Задает для параметра Enabledшифрования столбцов значение . Дополнительные сведения см. в разделе Постоянное шифрование. Поддерживаются только главные ключи, хранящиеся в хранилище сертификатов Windows. Для -g этого параметра требуется по крайней мере sqlcmd версии 13.1. Чтобы определить версию, выполните sqlcmd -?.

-G

Этот параметр используется клиентом при подключении к базе данных SQL Azure или Azure Synapse Analytics, чтобы указать, что пользователь проходит проверку подлинности с помощью проверки подлинности Microsoft Entra. Этот параметр задает . Для -G этого параметра требуется по крайней мере sqlcmd версии 13.1. Чтобы определить версию, выполните sqlcmd -?. Дополнительные сведения см. в статье Microsoft Entra authentication for Azure SQL. Параметр -A не поддерживается с параметром -G .

Параметр -G применяется только для Базы данных SQL Azure и Azure Synapse Analytics.

Интерактивная проверка подлинности Microsoft Entra в настоящее время не поддерживается в Linux или macOS. Для встроенной проверки подлинности Microsoft Entra требуется скачать драйвер ODBC для SQL Server версии 17.6.1 или более поздней версии и правильно настроенную среду Kerberos.

Дополнительные сведения о проверке подлинности Microsoft Entra см. в разделе Аутентификация с помощью идентификатора Microsoft Entra в sqlcmd.

-H workstation_name

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

-j

Выводит необработанные сообщения об ошибках на экран.

-K предназначение_приложения

Объявляет тип рабочей нагрузки приложения при соединении с сервером. Единственным поддерживаемым в настоящее время значением является ReadOnly. Если -K не указано, sqlcmd не поддерживает подключение к вторичной реплике в группе доступности. Дополнительные сведения см. в разделе «Перенос рабочей нагрузки только для чтения на вторичную реплику группы доступности Always On».

Примечание.

-K не поддерживается в SUSE Linux Enterprise Server (SLES). Однако можно указать ключевое слово ApplicationIntent=ReadOnly в файле DSN, переданном в sqlcmd. Дополнительные сведения см. в разделе Поддержка DSN в sqlcmd и bcp далее в этой статье.

Дополнительные сведения см. в статье "Высокий уровень доступности и аварийное восстановление" в Linux и macOS.

-M multisubnet_failover

Всегда указывать -M при подключении к прослушивателю группы доступности группы доступности SQL Server или экземпляру отказоустойчивого кластера SQL Server. -M обеспечивает более быстрое обнаружение активного (в данный момент) сервера и соединение с ним. Если -M этот параметр не указан, -M отключен.

Дополнительные сведения можно найти здесь

Примечание.

-M не поддерживается в SUSE Linux Enterprise Server (SLES). Однако можно указать ключевое слово MultiSubnetFailover=Yes в файле DSN, переданном в sqlcmd. Дополнительные сведения см. в разделе Поддержка DSN в sqlcmd и bcp далее в этой статье.

Дополнительные сведения см. в статье "Высокий уровень доступности и аварийное восстановление" в Linux и macOS.

N-

Этот параметр используется клиентом для запроса зашифрованного подключения.

Для служебной программы sqlcmd (Go) принимается строковое значение, которое может быть одним из следующих вариантов: -N, true, или false для указания выбора шифрования. (default совпадает с пропуском параметра):

Примечание.

На Linux и macOS [s|m|o] были добавлены в sqlcmd версии 18.0. -N может быть o (для optional), m (для mandatory, по умолчанию) или s (для strict). В предварительной версии SQL Server 2025 (17.x), если вы не включаете -N, значение по умолчанию — -Nm для mandatory. Это изменение, которое имеет критическое значение, начиная с SQL Server 2022 (16.x) и более ранних версий, где -No был значением по умолчанию.

  • Если -N и -C не предоставлены, sqlcmd согласовывает проверку подлинности с сервером без проверки сертификата сервера.

  • Если -N указано, но -C нет, sqlcmd требует проверки сертификата сервера. false Значение шифрования по-прежнему может привести к шифрованию пакета входа.

  • -N Если оба и -C указано, sqlcmd использует их значения для согласования шифрования.

  • В sqlcmd (ODBC) используется -F для указания имени узла в сертификате. Например:

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

    Примечание.

    Это отличается от переключателя -F для sqlcmd (Go), который используется для печати результатов в вертикальном формате.

- P-пароль

Указанный пользователем пароль. В паролях учитывается регистр символов. Если используется параметр -U, параметр -P не используется, и переменная среды SQLCMDPASSWORD не задана, sqlcmd предлагает пользователю ввести пароль. Мы не рекомендуем использовать пароль NULL (пустой), но можно указать пароль NULL с помощью пары смежных двойных кавычки для значения параметра ("").

Внимание

Использование -P должно считаться небезопасным. Не указываете пароль в командной строке. Кроме того, используйте SQLCMDPASSWORD переменную среды или в интерактивном режиме введите пароль, опустив -P параметр.

Рекомендуется выбрать надежный пароль.

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

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

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

В командной строке введите следующую команду. Замените <password> допустимым паролем.

SET SQLCMDPASSWORD=<password>
sqlcmd

SET SQLCMDPASSWORD=<password>
sqlcmd

SET SQLCMDPASSWORD=<password>
sqlcmd

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

Примечание.

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

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

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

Пароль, содержащий специальные символы, может создать сообщение об ошибке. Вместо этого следует экранировать специальные символы при использовании -Pили использовать SQLCMDPASSWORD переменную среды.

В Linux и macOS, когда используется параметр -G без -U, -P указывает на файл, содержащий токен доступа (версия 17.8+). Файл токена должен находиться в формате UTF-16LE (без BOM).

Токены доступа можно получить через различные способы. Необходимо убедиться, что токен доступа является правильным байт к байту, поскольку он отправляется as-is. Ниже приведен пример команды, которая получает маркер доступа. Команда использует команды Azure CLI и Linux и сохраняет его в файле в правильном формате. Если кодировка по умолчанию системы или терминала не является ASCII или UTF-8, может потребоваться настроить параметры iconv. Не забудьте тщательно защитить полученный файл и удалить его, когда он больше не требуется.

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 [протокол:]server[\instance_name][,port]

Указывает экземпляр SQL Server, к которому выполняется подключение. Он задает .

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

протокол может быть tcp (TCP/IP), lpc (общая память) или np (именованные каналы).

Если при запуске sqlcmd

Примечание.

Переменная OSQLSERVER среды хранится для обратной совместимости. Переменная SQLCMDSERVER среды имеет приоритет над переменной OSQLSERVER среды. То есть программы sqlcmd и osql могут применяться одновременно, не мешая друг другу. Старые скрипты продолжают работать.

Для драйвера ODBC в Linux и macOS требуется -S. Единственным допустимым значением протокола является tcp.

-U login_id

Имя входа или имя пользователя автономной базы данных. Для пользователей автономной базы данных необходимо указать параметр имени базы данных (-d).

Примечание.

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

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

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

-z new_password

Измените пароль. Замените <oldpassword> старым паролем и <newpassword> новым паролем.

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

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

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

-Z new_password

Измените пароль и выход. Замените <oldpassword> старым паролем и <newpassword> новым паролем.

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

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

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

Параметры ввода и вывода

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

Задает входные и выходные кодовые страницы. Номер кодовой страницы — это числовое значение, которое определяет установленную кодовую страницу Windows.

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

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

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

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

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

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

Примечание.

В Linux кодовая страница — это числовое значение, указывающее установленную кодовую страницу Linux (доступно с 17.5.1.1).

-i input_file[,input_file2...]

Определяет файл, содержащий пакет инструкций Transact-SQL или хранимых процедур. Можно указать несколько файлов, которые считываются и обрабатываются в порядке. Не используйте пробелы между именами файлов. sqlcmd сначала проверяет, существуют ли все указанные файлы. Если один или несколько файлов не существуют, sqlcmd завершает работу. -i -Q / Варианты -q являются взаимоисключающими.

Примечание.

Если вы используете -i параметр, за которым следует один или несколько дополнительных параметров, необходимо использовать пробел между параметром и значением. Это известная проблема в sqlcmd (Go).

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

-i C:\<filename>
-i \\<Server>\<Share$>\<filename>
-i "C:\Some Folder\<file name>"

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

Этот параметр можно использовать несколько раз:

sqlcmd -i <input_file1> -i <input_file2>

sqlcmd -i <input_file1> -i <input_file2>

sqlcmd -i <input_file1> -i <input_file2>

-o файл_вывода

Указывает файл, получающий выходные данные программы sqlcmd.

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

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

-o C:< filename>
-o \\<Server>\<Share$>\<filename>
-o "C:\Some Folder\<file name>"

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

-r[0 | 1]

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

Примечание.

Для служебной (Go) требуется -r аргумент или 0 аргумент.

-R

Применяется только к ODBC sqlcmd .

Указывает sqlcmd, что локализация в столбцах числовых и денежных данных, значений даты и времени, полученных из SQL Server, должна выполняться с учетом языка и региональных параметров клиента. По умолчанию эти столбцы отображаются с использованием региональных параметров сервера.

Примечание.

На Linux и macOS -R в настоящее время используется только форматирование по стандарту en_US (английский США).

u

Указывает, что выходной_файл хранится в Юникоде независимо от формата файла входной_файл.

Примечание.

Для служебной программы sqlcmd (Go) созданный выходной файл Юникода содержит метку порядка байтов (BOM) UTF-16.

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

-e

Записывает входные скрипты на стандартное выходное устройство (stdout).

I-

Применяется только к ODBC sqlcmd .

SET QUOTED_IDENTIFIER Задает для параметра подключения значение ON. Значение по умолчанию равно OFF. Дополнительные сведения см. в описании SET QUOTED_IDENTIFIER.

Примечание.

Чтобы отключить поведение кавычек идентификатора в служебной программе sqlcmd (Go), добавьте SET QUOTED IDENTIFIER OFF в скрипты.

-q "запрос командной строки"

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

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

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;"

Внимание

Не используйте GO терминатор в запросе.

Если -b этот параметр указан вместе с этим параметром, sqlcmd завершает работу с ошибкой. -b описано в других частях этой статьи.

-Q "запрос cmdline"

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

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

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

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;"

Внимание

Не используйте GO терминатор в запросе.

Если -b этот параметр указан вместе с этим параметром, sqlcmd завершает работу с ошибкой. -b описано в других частях этой статьи.

-t query_timeout

Указывает время ожидания команды (или инструкции Transact-SQL). Этот параметр задает . Если значение query_timeout не указано, команда не истекает. Query_timeout должен быть числом между 1 и 65534. Если указанное значение не является числовым или не попадает в этот диапазон, sqlcmd создает сообщение об ошибке.

Примечание.

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

-v var = value [ var = value... ]

применяется только к: Windows. Linux и macOS не поддерживаются.

Создает переменную скрипта sqlcmd, которая может использоваться в скрипте sqlcmd.

Если значение содержит пробелы, заключите его в кавычки. Можно указать несколько <var>="<value>" значений. Если в каком-либо из указанных значений обнаружена ошибка, программа sqlcmd выдает сообщение и завершает работу.

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"

-x

Указывает, что программа sqlcmd не должна обрабатывать переменные скрипта. Этот параметр полезен, если скрипт содержит множество операторов INSERT, которые могут содержать строки, имеющие тот же формат, что и обычные переменные, например $(<variable_name>).

Параметры формата

-h заголовки

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

-k [1 | 2]

Удаляет из выходных данных все управляющие символы, такие как символы табуляции и символы новой строки. Этот параметр сохраняет формат столбцов при возврате данных.

  • -k удаляет управляющие символы.
  • -k1 заменяет каждый символ элемента управления пробелом.
  • -k2 заменяет последовательные символы элемента управления одним пробелом.

-s разделитель_столбца

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

-w screen_width

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

-W

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

-y variable_length_type_display_width

Задает переменную скрипта sqlcmdSQLCMDMAXVARTYPEWIDTH. Значение по умолчанию — 256. Ограничивает число символов, возвращаемых для больших типов данных переменной длины:

  • varchar(max)
  • nvarchar(max)
  • varbinary(max)
  • xml
  • определяемые пользователем типы данных (определяемые пользователем)
  • текст
  • ntext
  • Изображение

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

Внимание

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

-Y fixed_length_type_display_width

Задает переменную скрипта sqlcmdSQLCMDMAXFIXEDTYPEWIDTH. Значение по умолчанию — ( 0 неограниченно). Ограничивает число символов, возвращаемых для следующих типов данных:

  • char(n), где 1 <= n<= 8000
  • nchar(n), где 1 <= n<= 4000
  • varchar(n), где 1 <= n<= 8000
  • nvarchar(n), где 1 <= n<= 4000
  • varbinary(n), где 1 <= n<= 4000
  • sql_variant

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

-b

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

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

-m error_level

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

Этот параметр также задает . Эта переменная имеет значение по умолчанию 0.

-V уровень_серьезности_ошибки

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

Прочие параметры

-a packet_size

Запрашивает пакет другого размера. Этот параметр задает . packet_size должно быть значением между 512 и 32767. Значение по умолчанию — 4096. Больший размер пакета может повысить производительность выполнения скриптов с большим количеством инструкций Transact-SQL между GO командами. Можно запросить больший размер пакета. Но в случае отклонения запроса программа sqlcmd использует размер пакета по умолчанию для сервера.

-c batch_terminator

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

-L[c]

применяется только к: Windows. Linux и macOS не поддерживаются.

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

Примечание.

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

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

-p[1]

Выводит на печать статистику производительности для каждого результирующего набора. Далее представлен пример формата для статистики производительности:

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]

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

  • ED
  • !! команда

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

-?

Отображает версию программы sqlcmd и сводку по синтаксису параметров для sqlcmd .

Примечание.

В macOS выполните ( sqlcmd '-?' с кавычками) вместо этого.

Замечания

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

Примечание.

Если вы используете -i параметр, за которым следует один или несколько дополнительных параметров, необходимо использовать пробел между параметром и значением. Это известная проблема в sqlcmd (Go).

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

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

Примечание.

Параметры -l-Q-Z или -i причина выхода sqlcmd после выполнения.

Общая длина командной строки sqlcmd в командной среде (например cmd.exe , или bash), включая все аргументы и развернутые переменные, определяется базовой операционной системой.

Поддержка DSN в sqlcmd и bcp

При указании можно указать имя источника данных (DSN) вместо имени сервера в bcp -S или sqlcmd :Connect параметре (или -D команде). -D вызывает подключение sqlcmd или bcp к серверу, указанному в dsN, по параметру -S .

Системные доменные сети хранятся в odbc.ini файле в каталоге ODBC SysConfigDir (/etc/odbc.ini на стандартных установках). Доменные имена пользователей хранятся в .odbc.ini домашнем каталоге пользователя (~/.odbc.ini).

В системах Windows доменные имена систем и пользователей хранятся в реестре и управляются с помощью odbcad32.exe. bcp и sqlcmd не поддерживают доменные имена файлов.

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

В DSN требуется только DRIVER запись, но для подключения к удаленному серверу sqlcmd или bcp требуется значение в элементе SERVER. SERVER Если элемент пуст или отсутствует в dsN, sqlcmd и bcp пытаются подключиться к экземпляру по умолчанию в локальной системе.

При использовании bcp в системах Windows для SQL Server 2017 (14.x) и более ранних версий требуется драйвер SQL Native Client 11 (sqlncli11.dll), тогда как для SQL Server 2019 (15.x) и более поздних версий требуется драйвер Microsoft ODBC Driver 17 для SQL Server (msodbcsql17.dll).

Если один и тот же параметр указан как в dsN, так и в командной строке sqlcmd или bcp , параметр командной строки переопределяет значение, используемое в dsN. Например, если dsN имеет DATABASE запись, а командная строка sqlcmd включает -d, используется значение, переданное -d . Если Trusted_Connection=yes указано в dsN, используется проверка подлинности Kerberos; имя пользователя () и пароль (-U-Pпри условии предоставления) игнорируются.

Существующие скрипты, которые вызываютсяisql, можно изменить для использования sqlcmd, определив следующий псевдоним: alias isql="sqlcmd -D"

Рекомендации по sqlcmd

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

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

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

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

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

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

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

  • Используется -V 16 для регистрации сообщений уровня серьезности 16. Сообщения серьезности 16 указывают на общие ошибки, которые могут быть исправлены пользователем.

  • Проверьте код выхода и DOS ERRORLEVEL переменную после завершения процесса. sqlcmd возвращается 0 обычно, в противном случае он задает ERRORLEVEL значение, настроенное в соответствии с параметром -V. Другими словами, не должно быть того же значения, что и номер ошибки, ERRORLEVEL сообщаемого из SQL Server. Номер ошибки — это конкретное значение SQL Server, соответствующее системной функции @@ERROR. ERRORLEVEL — это значение, зависящее от sqlcmd, указывающее, почему sqlcmd завершен, и его значение зависит от указания -b аргумента командной строки.

Использование -V 16 в сочетании с проверкой кода выхода и DOS ERRORLEVEL может помочь перехватывать ошибки в автоматизированных средах, особенно качественные шлюзы перед выпуском рабочей среды.

Связанный контент