ADO.NET 中的连接字符串实体框架

  • 项目

连接字符串包含作为参数从数据提供程序传递到数据源的初始化信息。 其语法取决于数据提供程序，并且会在试图打开连接的过程中对连接字符串进行分析。 实体框架使用的连接字符串包含用于连接到支持实体框架的基础 ADO.NET 数据提供程序的信息。 它们还包含有关所需的模型和映射文件的信息。

在访问模型，映射元数据以及连接到数据源时，EntityClient 提供程序将使用该连接字符串。 连接字符串可通过 ConnectionString 的 EntityConnection 属性访问或设置。 EntityConnectionStringBuilder 类可用于以编程方式构造或访问连接字符串中的参数。 有关详细信息，请参阅如何：生成 EntityConnection 连接字符串。

实体数据模型工具可生成一个连接字符串，该字符串存储在应用程序的配置文件中。 在创建对象查询时，ObjectContext 将自动检索此连接信息。 可通过 EntityConnection 属性访问 ObjectContext 实例所使用的 Connection。 有关详细信息，请参阅 管理连接和事务。

连接字符串语法

若要了解连接字符串的一般语法，请参阅连接字符串语法 |ADO.NET 中的连接字符串。

连接字符串参数

下表列出了 ConnectionString 中的关键字值的有效名称。

关键字 说明
Provider 此关键字在未指定 Name 关键字时是必需的。 提供程序名称，用于检索基础提供程序的 DbProviderFactory 对象。 该值为常量。

如果实体连接字符串中未包含 Name 关键字，则需要一个非空 Provider 关键字值。 此关键字与 Name 关键字互斥。
Provider Connection String 可选。 指定要传递给基础数据源的提供程序特定的连接字符串。 此连接字符串包含数据提供程序的有效关键字/值对。 如果 Provider Connection String 无效，则当数据源计算此字符串时，将导致运行时错误。

此关键字与 Name 关键字互斥。

请确保根据ADO.NET 连接字符串的一般语法来转义值。 例如，下面的连接字符串：Server=serverName; User ID = userID。 必须对它进行转义，因为其中包含分号。 由于其中不包含双引号，因此它们可以用于转义：

Provider Connection String ="Server=serverName; User ID = userID";
Metadata 此关键字在未指定 Name 关键字时是必需的。 一个由竖线分隔的目录、文件和资源位置的列表，供查找元数据和映射信息使用。 以下是一个示例：

Metadata=

c:\model | c:\model\sql\mapping.msl;

竖线分隔符两侧的空格将被忽略。

此关键字与 Name 关键字互斥。
Name 应用程序可以选择在应用程序配置文件中指定连接名称，以用于提供所需的关键字/值连接字符串值。 在此情况下，无法在连接字符串中直接提供这些值。 配置文件中不允许出现 Name 关键字。

如果连接字符串中未包含 Name 关键字，则需要一个非空的 Provider 关键字值。

此关键字与所有其他连接字符串关键字互斥。

下面是 AdventureWorks 销售模型的一个示例连接字符串，该字符串存储在应用程序配置文件中：

模型和映射文件位置

Metadata 参数包含一个位置列表，EntityClient 提供程序可使用该列表来搜索模型和映射文件。 模型和映射文件通常与应用程序可执行文件部署在同一目录中。 这些文件也可以部署在特定位置或作为嵌入资源包含于应用程序中。

嵌入资源按如下方式指定：

Metadata=res://<assemblyFullName>/<resourceName>

下列选项用于定义嵌入资源的位置：

选项 说明
assemblyFullName 包含嵌入资源的程序集的完整名称。 该名称包含简单名称、版本名称、支持的区域性以及公钥，如下所示：

ResourceLib, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null

资源可嵌入到应用程序能够访问的任何程序集中。

如果为 assemblyFullName 指定通配符 (*)，则实体框架运行库将按如下顺序在以下位置搜索资源：

1. 调用程序集。
2. 引用的程序集。
3. 应用程序的 bin 目录中的程序集。

如果文件不在这些位置，则引发异常。 注意：如果使用通配符 (*)，则实体框架将在所有程序集中查找具有正确名称的资源。 若要提高性能，请指定程序集名称而不使用通配符。
resourceName 包含的资源的名称，如 AdvendtureWorksModel.csdl。 元数据服务仅查找具有以下任一扩展名的文件或资源：.csdl、.ssdl、或 .msl。 如果未指定 resourceName，则将加载所有元数据资源。 资源应在程序集中具有唯一的名称。 如果在程序集中的不同目录中为多个文件定义了相同的名称，则 resourceName 必须在资源名称前面包含文件夹结构，例如 FolderName.FileName.csdl。

如果为 resourceName 指定通配符 (*)，则无需指定 assemblyFullName。

备注

若要提高性能，请在调用程序集中嵌入资源，调用程序集中未引用基础映射和元数据文件的非 Web 方案除外。

下面的示例加载应用程序 bin 目录中的调用程序集、引用程序集、以及其他程序集中的所有模型和映射文件。

Metadata=res://*/

下面的示例从 AdventureWorks 程序集加载 model.csdl 文件，并从正在运行的应用程序的默认目录加载 model.ssdl 和 model.msl 文件。

Metadata=res://AdventureWorks, 1.0.0.0, neutral, a14f3033def15840/model.csdl|model.ssdl|model.msl

下面的示例从特定程序集加载三个指定的资源。

Metadata=res://AdventureWorks, 1.0.0.0, neutral, a14f3033def15840/model.csdl|
res://AdventureWorks, 1.0.0.0, neutral, a14f3033def15840/model.ssdl|
res://AdventureWorks, 1.0.0.0, neutral, a14f3033def15840/model.msl

下面的示例从程序集中加载所有扩展名为 .csdl、.msl 和 .ssdl 的嵌入资源。

Metadata=res://AdventureWorks, 1.0.0.0, neutral, a14f3033def15840/

下面的示例从已加载程序集的位置加载相对文件路径加上“datadir\metadata\”中的所有资源。

Metadata=datadir\metadata\

下面的示例从已加载程序集的位置加载相对文件路径中的所有资源。

Metadata=.\

对 |DataDirectory| 替代字符串和 Web 应用程序根目录运算符 (~) 的支持

DataDirectory 和 ~ 运算符作为 Metadata 和 Provider Connection String 关键字的一部分用于 ConnectionString 中。 EntityConnection 将 DataDirectory 和 ~ 运算符分别转发给 MetadataWorkspace 和存储提供程序。

术语 说明
&#124;DataDirectory&#124; 解析为映射和元数据文件的相对路径。 这是通过 AppDomain.SetData("DataDirectory", objValue) 方法设置的值。 DataDirectory 替代字符串必须由竖线字符括起来，并且在其名称与竖线字符之间不能存在任何空格。 DataDirectory 名称不区分大小写。

如果名为“DataDirectory”的物理目录必须作为元数据路径列表的成员传递，则应在该名称的一边或两边添加空格。 例如：Metadata="DataDirectory1 &#124; DataDirectory &#124; DataDirectory2"。 ASP.NET 应用程序将 |DataDirectory| 解析为“<application root>/app_data”文件夹。
~ 解析为 Web 应用程序根目录。 位于开头的 ~ 字符总是被解释为 Web 应用程序根目录运算符 (~)，不过它也可以表示有效的本地子目录。 若要引用这样的本地子目录，用户应显示传递 ./~。

DataDirectory 和 ~ 运算符仅应指定在路径的开头，放在任何其他位置将得不到解析。 实体框架将尝试解析 ~/data，但会将 /data/~ 视为物理路径。

以 DataDirectory 或 ~ 运算符开头的路径不能解析为 DataDirectory 和 ~ 运算符分支之外的物理路径。 例如，下面的路径将获得解析：~、~/data、~/bin/Model/SqlServer。 下面的路径无法解析：~/..、~/../other。

DataDirectory 和 ~ 运算符可扩展为包含子目录，如下所示：|DataDirectory|\Model、~/bin/Model

对 DataDirectory 替代字符串和 ~ 运算符的解析不是递归进行的。 例如，如果 DataDirectory 包含 ~ 字符，则引发异常。 这样可以避免无穷递归。

请参阅