连接字符串属性

适用于: SQL Server Analysis Services Azure Analysis Services Fabric/Power BI Premium

本文介绍连接到 Azure Analysis Services(Azure AS)、SQL Server Analysis Services(SSAS)和 Power BI Premium 语义模型的客户端应用程序使用的连接字符串属性。 Analysis Services 客户端库、ADOMD.NET、AMO 和 OLE DB (MSOLAP) 提供程序为 Analysis Services 使用这些属性。 大多数连接字符串属性都可用于所有三个客户端库。 说明中会调用异常。

使用左侧目录上方 的版本 选择器,仅查看应用于特定平台或版本的那些属性。

连接属性

数据源

指定服务器实例。 所有连接都需要此属性。

Azure Analysis Services 的有效值包括<protocol>://<region>/<servername>协议是字符串asazure,在使用link服务器名称别名时,区域是在其中创建服务器的 URI(例如,westus.asazure.windows.net),服务器名称是区域中唯一服务器的名称。

Example Description
Data source=asazure://westus.asazure.windows.net/myasserver Azure Analysis Services。
Data source=link://friendlyname.salesapp.azurewebsites.net/ 使用服务器名称别名的 Azure Analysis Services。

Power BI Premium 的有效值包括 <protocol>://api.powerbi.com/v1.0/[tenant name]/[workspace name] 协议是字符串 powerbi、Uri、 api.powerbi.com租户名称是组织租户名称, myorg工作区名称是分配给专用容量的工作区的名称。

Example Description
Data source=powerbi://api.powerbi.com/v1.0/contoso.com/Sales Workspace Power BI Premium 工作区。

SQL Server Analysis Services 的有效值包括服务器的网络名称或 IP 地址、用于本地连接的本地或 localhost、如果为服务器配置了 HTTP 或 HTTPS 访问,或者本地多维数据集 (.cub) 文件的名称,则为 URL。

Example Description
Data source=AW-SRV01 SSAS 默认实例和端口(TCP 2383)。
Data source=AW-SRV01\Finance SSAS 命名实例。
Data source=AW-SRV01:8081 SSAS 默认实例,指定端口。
Data source=AW-SRV01.corp.Adventure-Works.com SSAS 完全限定的域名、默认实例和端口。
Data source=172.16.254.1 服务器的 SSAS IP 地址,绕过 DNS 服务器查找。 用于排查连接问题。
Provider

使用 OLE DB 访问接口(如 MSOLAP)时,连接字符串需要此属性。 它允许你使用与版本无关的提供程序(通常为最新提供程序),例如“Provider=MSOLAP”,也可以指定版本依赖提供程序,例如“Provider=MSOLAP.7”。 有效的版本依赖值遵循 MSOLAP 模式。<版本>,其中 <版本> 为 7 或 8。 例如,在 SQL Server 2016 中发布的 MSOLAP.7。 版本“.8”是最新的,被视为“evergreen”。 它预计会保持向后兼容性的更新。 早期版本号也是可能的,但这些版本的 MSOLAP 现在已脱离标准支持。

此属性对于 ADOMD.NET 和 AMO 是可选的。 复制 MSOLAP 连接字符串以用于 ADOMD.NET 和 AMO 时,可以方便使用。

Example Description
Provider=MSOLAP.7 需要 SQL Server 2016 版本的用于 Analysis Services 的 OLE DB 访问接口的连接。
多维数据集

多维数据集名称或透视名称。 数据库可以包含多个多维数据集和透视。 如果可能有多个目标,请在连接字符串中包含多维数据集或透视名称。

Example Description
Cube=Sales 名为 Sales 的多维数据集。
Cube=SalesPerspective 名为 SalesPerspective 的透视。

身份验证和安全属性

Azure Analysis Services 和 Power BI Premium 使用 Microsoft Entra ID - 通用 MFA(建议),Microsoft使用用户名和密码、Microsoft Entra 访问令牌或 Windows 身份验证的 Entra 身份验证。

SQL Server Analysis Services 仅使用 Windows 身份验证。 如果通过 MSMDPUMP.dll启用 HTTP 访问,则可以使用基本身份验证和匿名身份验证,如 IIS 8.0 上的“配置对 Analysis Services 的 HTTP 访问”一文中所述。 请参阅 步骤 3:配置 IIS 身份验证 ,详细了解如何通过 HTTP 为 Analysis Services 配置支持的身份验证方法。

属性按字母顺序列出。

EffectiveUserName

在服务器上必须模拟用户标识时使用。 对于 SSAS,请以域\用户格式指定。 对于 Azure AS 和 Power BI Premium,请以 UPN 格式指定。 若要使用此属性,调用方必须在 Analysis Services 中具有管理权限。 在 Power BI Premium 中,调用方必须是语义模型所在的工作区管理员。

CustomData

要传递给连接字符串中的引擎的字符串值,然后使用 CustomData() MDX 函数或 CUSTOMDATA() DAX 函数进行检索。 最常用于将 userID 或用户名作为值传递,然后在安全表达式的定义中指定该值。

加密密码

指定是否使用本地密码来加密本地多维数据集。 有效值为 True 或 False。 默认值为 False。

加密密码

用于解密加密本地多维数据集的密码。 默认值为空。 此值必须由用户显式设置。

模拟级别

指示模拟客户端时允许服务器使用的模拟级别。 有效值包括:

  • 匿名。 客户端是服务器的匿名客户端。 服务器进程无法获取有关客户端的信息,也不能模拟客户端。
  • 标识。 服务器进程可以获取客户端标识。 服务器可以根据授权目的模拟客户端标识,但不能以客户端身份访问系统对象。
  • 模拟。 这是默认值。 客户端标识可以模拟,但前提是建立连接,而不是每次调用时。
  • 委托。 服务器进程可以模拟客户端安全上下文,同时代表客户端执行作。 服务器进程还可以代表客户端执行作时向其他服务器发出传出调用。
集成安全性

调用者的 Windows 标识用于连接到 Analysis Services。 有效值为 SSPI、 空白、 基本和 ClaimsToken*。

SSPI 是 TCP 连接的默认值,允许 NTLM、Kerberos 或匿名身份验证。 对于 Azure AS 和 Power BI Premium,SSPI 指示 AD 翻译。 使用 SSPI 时, ProtectionLevel 属性必须设置为 Connect、Pkt 完整性或 Pkt 隐私。

空白是 HTTP 连接的默认值。

*Azure AS 和 Power BI Premium 支持 ClaimsToken。

交互式登录,标识模式

在与基于云的分析服务的 HTTP 连接中,身份验证默认基于无提示 SSO 流,该流将使用登录到Windows会话的当前用户的标识。 下面列出的属性可用于通过身份验证过程为用户和应用程序提供额外的控制。

某些高级连接方面可以由客户端配置设置控制。

交互式登录

“交互式登录”属性可用于控制交互式身份验证流的使用;可能的值包括:

  • 默认值。 应用程序确定身份验证流。 通常,如果无提示身份验证失败,则启用 SSO,并回退到交互式身份验证。 默认行为也受其他连接字符串属性的影响,例如,Integrated Security=SSPI 将强制进行无提示身份验证。

  • 已启用。 启用了交互式登录,但仅作为无提示 SSO 流故障的回退。

  • Disabled. 已禁用交互式登录 - 如果无提示身份验证失败,连接尝试将失败。

  • 始终。 无提示身份验证处于禁用状态,并且将使用交互式登录。

标识模式

“标识模式”属性可用于控制连接字符串未使用“用户 ID”属性显式定义时将使用的标识。 可能的值为:

  • 默认值。 标识模式由其他连接字符串属性和系统配置确定。

  • CurrentUser。 使用登录到Windows会话的当前用户。

  • 连接。 标识基于数据源确定,该数据源是连接的目标。 首次打开与特定数据源的连接时,用户可以以交互方式选择标识,该标识用于在应用程序进程的生存期内与同一数据源的任何后续连接。

  • 进程。 第一次连接尝试是交互式的,后续尝试使用在第一个连接上使用的标识。

持久保存安全信息

有效值为 True 或 False。 设置为 True 时,可以在建立连接后从连接获取安全信息(例如之前在连接字符串上指定的用户标识或密码)。 默认值为 False。

保护级别

确定在连接上使用的安全级别。 支持的值取决于基础传输。 有效值为:

  • 无。 未经身份验证或匿名连接。 对发送到服务器的数据不执行身份验证。
  • Connect. 经过身份验证的连接。 仅在客户端与服务器建立关系时进行身份验证。
  • Pkt 完整性。 加密连接。 验证是否从客户端接收所有数据,并且尚未在传输中更改数据。
  • Pkt 隐私。 仅 TCP 支持签名加密。 验证是否从客户端接收所有数据、传输中未更改数据,并通过加密来保护数据的隐私。

若要了解详细信息,请参阅 在 ADOMD.NET 中建立安全连接

角色

指定预定义角色的逗号分隔列表,以使用该角色传达的权限连接到服务器或数据库。 如果省略此属性,则使用所有角色,并且有效权限是所有角色的组合。 例如, Roles=' ' 将属性设置为空值意味着客户端连接没有角色成员身份。

使用此属性的管理员使用角色传达的权限进行连接。 如果角色未提供足够的权限,某些命令可能会失败。

如果在连接到 Power BI Premium 工作区时指定角色,请使用 Power BI 安全模型中的 工作区角色 。

SSPI

将 集成安全性 设置为 SSPI 时,显式指定用于客户端身份验证的安全包。 SSPI 支持多个包,但可以使用此属性指定特定包。 有效值为:

  • 协商
  • Kerberos (英语)
  • NTLM
  • 匿名用户

如果未设置此属性,则所有包都可用于连接。

对数据使用加密

加密数据传输。 有效值为 True 或 False。

用户 ID=...;Password=

当客户端应用程序中的当前活动用户无法自动传播到服务器时,用户 ID 和密码属性将为服务器提供适当的凭据。 行为取决于传输协议和要连接到的服务器:

  • 通过 TCP 连接到 SSAS 时,客户端库将使用指定的用户名和密码模拟 Windows 用户,然后像往常一样连接到服务器。

  • 通过 HTTP(S) 连接到 SSAS 时,会根据 Web 服务器上配置的身份验证模式(例如基本身份验证或 Windows 身份验证)向 Web 服务器提供凭据。在连接到 SSAS 服务器之前,Web 服务器将执行相应的 Windows 模拟,因此,为服务器提供正确的凭据流。

  • 连接到 Azure AS 或 Power BI Premium 时,用户 ID 和密码用于获取Microsoft Entra 令牌,然后在身份验证期间提供给服务。 Microsoft Entra ID 可能还需要多重身份验证(MFA),这可能需要额外的用户交互才能生成令牌。

  • 如果已从自己的应用程序中获取有效的 Microsoft Entra ID 持有者 访问令牌,则可以在建立连接之前设置 AdomdConnection 对象的 AccessToken 属性。 在相关连接对象的 AccessToken 属性(AdomdConnection、Server 等)中,请确保设置访问令牌并指定其过期时间。 用户以交互方式获取的持有者令牌以及使用 OAuth 2.0 On-Behalf-Of 流 (例如,代表用户连接到 Analysis Services 的中间层 Web 应用程序)支持身份验证。 在 AccessToken 属性中传递访问令牌时,省略令牌类型。 Analysis Services 客户端库会自动将身份验证方案值 “Bearer” 添加到访问令牌。 请务必记住以下事项:

    • Microsoft Entra 持有者访问令牌的生存期有限。 默认情况下,介于 60-90 分钟之间。 如果应用程序执行超过访问令牌生存期的长期运行作,则可以通过 AdomdConnection 对象的 OnAccessTokenExpired 属性提供回调函数,以便在当前访问令牌即将过期时刷新访问令牌。 或者,无需回调函数的帮助即可直接更新 AccessToken 属性。 建议使用回调函数来确保访问令牌在当前访问令牌的生存期内刷新。
    • 不建议使用 密码 连接字符串属性传递访问令牌。 你仍然可以省略连接字符串中的 用户 ID 属性,并且只能在 Password 属性中指定访问令牌,但在这些情况下,访问令牌无法刷新。 请改用 AccessToken 属性,以便在需要时为现有连接提供新的访问令牌。 不支持设置 Password 属性和 AccessToken 属性。

注意: “用户 ID”具有嵌入的空间。 用户 ID 的备用别名为 UID ,密码的备用别名为 PWD。

特殊用途属性

这些属性用于确保应用程序所需的特定连接行为。 属性按字母顺序列出。

应用程序名称

设置与连接关联的应用程序的名称。 监视跟踪事件时,此值非常有用,尤其是在有多个应用程序访问同一数据库时。 例如,将应用程序名称=“test”添加到连接字符串会导致“test”出现在 SQL Server Profiler 跟踪中。 此属性的别名包括 SspropInitAppName、 AppName。 若要了解详细信息,请参阅 SQL Server 连接的应用程序名称。

自动同步期

设置客户端和服务器缓存同步的频率(以毫秒为单位)。 ADOMD.NET 为具有最小内存开销的常用对象提供客户端缓存。 这有助于减少到服务器的往返次数。 默认值为 10,000 毫秒(或 10 秒)。 设置为 null 或 0 时,会自动关闭同步。

出于性能原因,客户端库从服务器缓存某些信息,例如某些架构行集。 自动同步期允许用户更改客户端库与服务器检查缓存是否需要清空的时间段。 一般情况下,无需更改默认值的值。

字符编码

定义如何在请求中对字符进行编码。 有效值为 Default 或 UTF-8 (这些值等效),以及 UTF-16。

CommitTimeout

XMLA 属性。 确定当前正在运行的命令的提交阶段在回滚之前等待的时间(以毫秒为单位)。 如果大于 0,则替代服务器配置中相应 CommitTimeout 属性的值。

CompareCaseSensitiveStringFlags

调整指定区域设置的区分大小写的字符串比较。

压缩级别

如果 压缩了 TransportCompression ,则可以设置压缩级别来控制使用的压缩量。 有效值为 0 到 9,0 具有最小压缩,9 个具有最大压缩。 提高压缩速度会降低性能。 默认值为 0。

连接超时

确定客户端在超时前尝试连接的最大时间(以秒为单位)。如果连接在此时间段内未成功,客户端会退出尝试连接并生成错误。

DbpropMsmdRequestMemoryLimit

替代连接的 Memory\QueryMemoryLimit 服务器属性值。

以千字节为单位指定,此属性可以从 QueryMemoryLimit 中允许的最大内存(指定为百分比) 减少 查询期间使用的内存量。 它不能增加使用的内存量超出了 QueryMemoryLimit 中指定的最大允许内存量。

默认 MDX 视觉模式

设置此属性可控制在应用维度安全性时如何聚合成员。

对于允许每个人查看的多维数据集数据,聚合所有成员是有意义的,因为所有参与总数的值都是可见的。 但是,如果基于用户标识筛选或限制维度,则根据所有成员(将受限值和允许的值合并为单个总计)显示总计可能会令人困惑或显示比应显示的信息更多。

若要指定在应用维度安全性时如何聚合成员,可以将此属性设置为 True 以仅使用聚合中允许的值,或 False 从总计中排除受限值。

在连接字符串上设置时,此值适用于多维数据集或透视级别。 在模型中,可以在更精细的级别控制视觉对象总计。

有效值为,

  • 0 是默认值。 目前,默认行为等效于 2,其中聚合包括用户隐藏的值。
  • 1 排除总计中的隐藏值。 这是 Excel 的默认值。
  • 2 包括总计中的隐藏值。 这是服务器上的默认值。

此属性的别名为 VisualMode。

MDX 兼容性

此属性的目的是确保针对发出 MDX 查询的应用程序使用一组一致的 MDX 行为。 Excel 使用 MDX 查询填充和计算连接到 Analysis Services 的数据透视表,将此属性设置为 1,以确保不规则层次结构中的占位符成员在数据透视表中可见。 有效值包括 0、1、2。

0 和 1 公开占位符成员;2 不。 如果这是空的,则假定为 0。

MDX 缺少成员模式

指示 MDX 语句中是否忽略缺少的成员。 有效值为 Default、 Error 和 Ignore。 默认值使用服务器定义的值。 当成员不存在时,错误将生成错误。 忽略指定应忽略缺失值。

优化响应

一个位掩码,指示启用了以下哪个查询响应优化。

  • 0x01使用 NormalTupleSet(默认值)。
  • 0x02切片器为空时使用。
数据包大小

仅适用于 TCP 连接。 512 到 32,767 之间的网络数据包大小(以字节为单位)。 默认网络数据包大小为 4096。

协议格式

设置 XMLA 通信协议使用的 XML 的格式。 有效值为 Default、 XML 或 Binary。 可以指定以二进制格式或文本 XML 发送 XML。 二进制格式对 XML 元素和属性进行编码,使其更小。 此外,还可以为消息启用压缩,以减少使用传输压缩选项的请求和响应的大小。 请求和响应可以使用不同的协议格式,具体取决于客户端和服务器支持的格式。 例如,客户端库可能仅支持响应的二进制文件,但不支持用于请求,或者服务器可能已禁用传入请求的二进制文件。

OLE DB 访问接口可以采用二进制格式或压缩格式设置请求和响应的格式。 AMO 和 ADOMD.NET 将请求的格式设置为“文本”,但接受采用二进制或压缩格式的响应。

此连接字符串属性等效于 EnableBinaryXML 和 EnableCompression 服务器配置设置。

实时 Olap

设置此属性以绕过缓存,导致所有存储查询从源系统提取数据。 默认情况下,未设置此属性。

安全选项

设置用户定义的函数和作的安全级别。 有效值为 0、 1、 2。 在 Excel 连接中,此属性为 Safety Options=2。 有关此选项的详细信息,请参阅 ConnectionString。

SQLQueryMode

指定 SQL 查询是否包括计算。 有效值为 Data、Calculated、 IncludeEmpty。 数据意味着不允许进行计算。 计算允许计算。 IncludeEmpty 允许在查询结果中返回计算和空行。

超时

指定客户端库在生成错误之前等待命令完成的时间(以秒为单位)。

传输压缩

定义如何压缩客户端和服务器通信。 有效值为 Default、 None、 Compressed。 无表示未使用压缩。 压缩使用 XPRESS 压缩。

UseExistingFile

连接到本地多维数据集时使用。 此属性指定是否覆盖本地多维数据集。 有效值为 True 或 False。 如果设置为 True,则多维数据集文件必须存在。 现有文件将是连接的目标。 如果设置为 False,则会覆盖多维数据集文件。

另请参阅

AMO 基本类 - 服务器对象
AdomdConnection 类 - 属性