使用 sqlcmd 进行连接

下载 ODBC 驱动程序

可以在 Linux 和 macOS 上结合使用 sqlcmd 实用工具与 Microsoft ODBC Driver for SQL Server。

以下命令分别演示如何使用 Windows 身份验证 (Kerberos) 和 SQL Server 身份验证:

sqlcmd -E -Sxxx.xxx.xxx.xxx
sqlcmd -Sxxx.xxx.xxx.xxx -Uxxx -Pxxx

可用选项

Linux 和 macOS 上的 sqlcmd 中提供以下选项:

-?
显示 sqlcmd 使用情况。

-a
请求数据包大小。

-b
如果发生错误,则终止批处理作业。

-c batch_terminator
指定批处理终止符。

-C
信任服务器证书。

-ddatabase_name
启动 sqlcmd 时发出 USE database_name 语句。

-D
使值传递给将解释为数据源名称 (DSN) 的 sqlcmd -S 选项。 有关详细信息,请参阅本文末尾的“sqlcmdbcp 中的 DSN 支持”。

-e
将输入脚本写入标准输出设备 (stdout)。

-E
使用可信连接(集成身份验证)。有关从 Linux 或 macOS 客户端建立使用集成身份验证的可信连接的详细信息,请参阅使用集成身份验证

-fcodepage | i:codepage[,o:codepage] | o:codepage[,i:codepage]
指定输入和输出代码页。 代码页页码是指定已安装的 Linux 代码页的数值。 (自 17.5.1.1 起提供)

-G
当连接到 SQL 数据库或 Azure Synapse Analytics 时,客户端将使用此开关指定该用户使用 Azure Active Directory 身份验证来进行身份验证。 只需将它与 -P 选项结合使用即可使用访问令牌身份验证 (v17.8+)。 此选项设置 sqlcmd 脚本变量 SQLCMDUSEAAD = true。 -G 开关至少需要 sqlcmd 版本 17.6。 若要确定你的版本,请执行 sqlcmd -?

重要

-G 选项仅适用于 Azure SQL 数据库和 Azure Synapse Analytics。 Linux 或 macOS 目前不支持 AAD 交互式身份验证。 AAD 集成身份验证要求 Microsoft ODBC Driver 17 for SQL Server 版本 17.6.1 或更高版本以及正确配置的 Kerberos 环境

-hnumber_of_rows
指定要在列标题之间打印的行数。

-H
指定工作站名称。

-iinput_file[,input_file[,...]]
标识包含一批 SQL 语句或存储过程的文件。

-I
SET QUOTED_IDENTIFIER 连接选项设置为“开”。

-k
删除或替换控制字符。

-Kapplication_intent
连接到服务器时声明应用程序工作负荷类型。 目前唯一支持的值是 ReadOnly。 如果未指定 -K,sqlcmd 将不支持连接到 Always On 可用性组中的次要副本。 有关详细信息,请参阅 Linux 和 macOS 上的 ODBC 驱动程序 - 高可用性和灾难恢复

注意

-K 在适用于 SUSE Linux 的 CTP 中不受支持。 但是,可以在传递给 sqlcmd 的 DSN 文件中指定 ApplicationIntent=ReadOnly 关键字 。 有关详细信息,请参阅本文末尾的“sqlcmdbcp 中的 DSN 支持”。

-ltimeout
指定在尝试连接到服务器时 sqlcmd 登录超时时间(以秒为单位)。

-merror_level
控制将哪些错误消息发送到 stdout。

-Mmultisubnet_failover
在连接到 SQL Server 2012 (11.x) 可用性组或 SQL Server 2012 (11.x) 故障转移群集实例的可用性组侦听程序时,应始终指定 -M。 -M 将为(当前)活动服务器提供更快的故障检测和连接速度 。 如果未指定 -M,则 -M 处于关闭状态。 有关 Always On 可用性组的详细信息,请参阅 Linux 和 macOS 上的 ODBC 驱动程序 - 高可用性和灾难恢复

注意

-M 在适用于 SUSE Linux 的 CTP 中不受支持。 但是,可以在传递给 sqlcmd 的 DSN 文件中指定 MultiSubnetFailover=Yes 关键字 。 有关详细信息,请参阅本文末尾的“sqlcmdbcp 中的 DSN 支持”。

-N[s|m|o]
将连接加密模式分别设置为“严格”、“强制”或“可选”。 如果未指定,则默认为“强制”。 (sqlcmd 18.0 中添加了 [s|m|o]

-ooutput_file
标识从 sqlcmd 接收输出的文件。

-p
打印每个结果集的性能统计信息。

-P
指定用户密码。 在不使用 -U 选项的情况下与 -G 选项结合使用时,则指定一个文件,其中包含访问令牌 (v17.8+)。 令牌文件的格式应为 UTF-16LE(无 BOM)。

可以通过各种方法获取访问令牌。 务必确保访问令牌的每个字节都是正确的,因为它将按原样发送。 下面是一个用于获取访问令牌的示例命令。 该命令使用 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

-qcommandline_query
启动 sqlcmd 时执行查询,但是在查询结束运行时不退出。

-Qcommandline_query
启动 sqlcmd 时执行查询。 查询结束时,sqlcmd 将退出。

-r
将错误消息重定向到 stderr。

-R
使驱动程序使用客户端区域设置来将货币以及日期和时间数据转换为字符数据。 当前仅使用 en_US(美国英语)格式设置。

-scolumn_separator_char
指定列分隔符字符。

-S [protocol:] server[,port]
指定要连接的 SQL Server 实例,如果使用的是 -D,则指定 DSN。 Linux 和 macOS 上的 ODBC 驱动程序需要 -S。 唯一有效的协议值是 tcp。

-t query_timeout
指定命令(或 SQL 语句)超时之前的秒数。

-u
指定以 Unicode 格式存储 output_file,无需考虑 input_file 的格式。

-U
login_id 指定用户登录 ID。

-V error_severity_level
控制用于设置 ERRORLEVEL 变量的严重级别。

-wcolumn_width
指定用于输出的屏幕宽度。

-W
删除列的尾随空格。

-x
禁用变量替换

-X
禁用命令、启动脚本和环境变量。

-y variable_length_type_display_width
设置 sqlcmd 脚本变量 SQLCMDMAXFIXEDTYPEWIDTH

-Y fixed_length_type_display_width
设置 sqlcmd 脚本变量 SQLCMDMAXVARTYPEWIDTH

-zpassword
更改密码。

-Zpassword
更改密码并退出

可用的命令

在当前版本中,可以使用以下命令:

  • [:]!!

  • :Connect

  • :Error

  • [:]EXIT

  • GO [count]

  • :Help

  • :List

  • :Listvar

  • :On Error

  • :Out

  • :Perftrace

  • [:]QUIT

  • :r

  • :RESET

  • :setvar

不可用选项

在当前版本中,以下选项不可用:

-A
使用专用管理员连接 (DAC) 登录到 SQL Server 。 有关如何建立专用管理员连接 (DAC) 的信息,请参阅编程指南

-L
列出本地配置的服务器计算机和在网络上播发的服务器计算机的名称。

-v
创建可用于 sqlcmd 脚本中的 sqlcmd 脚本变量。

可以使用以下替代方法:将参数放入一个文件中,然后可以将其附加到另一个文件。 此方法将有助于你使用参数文件来替换值。 例如,创建一个名为 a.sql 的文件(参数文件),其中包含以下内容:

:setvar ColumnName object_id
:setvar TableName sys.objects

然后创建一个名为 b.sql 的文件,其中包含用于替换的参数:

select $(ColumnName) from $(TableName)

在命令行下,使用以下命令将 a.sqlb.sql 合并为 c.sql

cat a.sql > c.sql

cat b.sql >> c.sql

运行 sqlcmd 并将 c.sql 用作输入文件:

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

不可用的命令

在当前版本中,以下命令不可用:

  • :ED

  • :ServerList

  • :XML

sqlcmd 和 bcp 中的 DSN 支持

如果指定 -D,则可以在 sqlcmd 或 bcp-S 选项(或 sqlcmd :Connect 命令)中指定数据源名称 (DSN) 而不是服务器名称。 -D 使 sqlcmd 或 bcp 通过 -S 选项连接到 DSN 中指定的服务器。

系统 DSN 存储在 ODBC SysConfigDir 目录的 odbc.ini 文件(即标准安装上的 /etc/odbc.ini)中。 用户 DSN 存储在用户主目录 (~/.odbc.ini) 的 .odbc.ini 中。

在 Windows 系统中,系统和用户 DSN 存储在注册表中,通过 odbcad32.exe 进行管理。 bcp 和 sqlcmd 不支持文件 DSN。

有关驱动程序支持的条目列表,请参阅 DSN 和连接字符串关键字和属性

在 DSN 中,只有 DRIVER 项是必需的;但若要连接到远程服务器,sqlcmdbcp 需要 SERVER 元素中的值。 如果 SERVER 元素为空或不存在于 DSN 中,sqlcmdbcp 将尝试连接到本地系统上的默认实例。

在 Windows 系统上使用 bcp 时,SQL Server 2017 (14.x) 及更早版本需要 SQL Native Client 11 驱动程序 (sqlncli11.dll),而 SQL Server 2019 (15.x) 及更高版本需要 Microsoft ODBC Driver 17 for SQL Server 驱动程序 (msodbcsql17.dll)。

如果在 DSN 和 sqlcmdbcp 命令行中指定了相同的选项,命令行选项将替代 DSN 中使用的值。 例如,如果 DSN 具有 DATABASE 项且 sqlcmd 命令行包含 -d,将使用传递给 -d 的值 。 如果在 DSN 中指定了 Trusted_Connection=yes ,便会使用 Kerberos 身份验证,并忽略用户名 (-U ) 和密码 (-P )(若有)。

通过定义别名 alias isql="sqlcmd -D",可将调用 isql 的现有脚本修改为使用 sqlcmd

另请参阅

使用 bcp 连接
发行说明