ADO.NET Entity Framework での接続文字列

  • [アーティクル]

接続文字列には、データ プロバイダーからデータ ソースにパラメーターとして渡す初期化情報が含まれています。 接続文字列は接続を開くときに解析され、その構文はデータ プロバイダーによって異なります。 Entity Framework で使用される接続文字列には、Entity Framework のサポート基盤である ADO.NET データ プロバイダーへの接続に使用される情報が含まれています。 また、必要なモデル ファイルおよびマッピング ファイルに関する情報も含まれています。

接続文字列は、モデル メタデータおよびマッピング メタデータにアクセスしてデータ ソースに接続する際に EntityClient プロバイダーによって使用されます。 接続文字列へのアクセスや接続文字列の設定は、ConnectionString の EntityConnection プロパティを使用して行います。 EntityConnectionStringBuilder クラスを使用すると、接続文字列内のパラメーターの構築やこれらへのアクセスをプログラムで行えます。 詳細については、EntityConnection の接続文字列を作成する」を参照してください。

Entity Data Model ツールでは、アプリケーションの構成ファイルに保存される接続文字列が生成されます。 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 Sales Model の接続文字列の例を次に示します。

モデル ファイルおよびマッピング ファイルの場所

Metadata パラメーターには、EntityClient プロバイダーがモデル ファイルおよびマッピング ファイルを検索するための場所のリストが格納されます。 多くの場合、モデル ファイルとマッピング ファイルは、アプリケーション実行可能ファイルと同じディレクトリに配置されます。 これらのファイルは、特定の場所に配置することも組み込みリソースとしてアプリケーションに含めることもできます。

組み込みリソースは次のように指定します。

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

組み込みリソースの場所を定義するには、次のオプションを使用できます。

オプション 説明
assemblyFullName リソースが組み込まれたアセンブリの完全な名前。 この名前には、次のように単純な名前、バージョン名、サポートされるカルチャ、および公開キーが含まれます。

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

リソースは、アプリケーションからアクセスできる任意のアセンブリに組み込むことができます。

assemblyFullName にワイルドカード (*) を指定すると、Entity Framework ランタイムでは、次の場所のリソースがこの順序で検索されます。

1. 呼び出し側のアセンブリ。
2. 参照アセンブリ
3. アプリケーションの bin ディレクトリ内のアセンブリ。

ファイルが上記のどの場所にもない場合は、例外がスローされます。 注: ワイルドカード (*) を使用すると、Entity Framework では、正しい名前のリソースを見つけるためにすべてのアセンブリを調べる必要があります。 パフォーマンスを向上させるには、ワイルドカードではなくアセンブリ名を指定してください。
resourceName AdventureWorksModel.csdl などの含まれるリソースの名前。 メタデータ サービスでは、拡張子が .csdl、.ssdl、または .msl のいずれかであるファイルまたはリソースのみが検索されます。 resourceName を指定しない場合は、すべてのメタデータ リソースが読み込まれます。 リソースには、アセンブリ内で一意の名前を付ける必要があります。 同じ名前が付けられた複数のファイルがアセンブリ内の異なるディレクトリで定義されている場合、resourceName には、リソースの名前の前にフォルダー構造を含める必要があります (FolderName.FileName.csdl など)。

resourceName にワイルドカード (*) を指定した場合、assemblyFullName は不要です。

Note

パフォーマンスを向上させるには、リソースを呼び出し側のアセンブリに組み込んでください。ただし、呼び出し側のアセンブリ内の基になるマッピング ファイルとメタデータ ファイルへの参照が存在しない Web 以外のシナリオの場合は除きます。

次の例では、呼び出し側のアセンブリ、参照アセンブリ、およびアプリケーションの bin ディレクトリ内のその他のアセンブリに存在するすべてのモデル ファイルおよびマッピング ファイルを読み込みます。

Metadata=res://*/

次の例では、model.csdl ファイルを AdventureWorks アセンブリから読み込み、model.ssdl ファイルと model.msl ファイルを実行中のアプリケーションの既定のディレクトリから読み込みます。

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

次の例では、指定した 3 つのリソースを特定のアセンブリから読み込みます。

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 と ~ 演算子は、パスの先頭にのみ指定する必要があります。その他の位置では解決されません。 Entity Framework では、~/data の解決は試行されますが、/data/~ は物理パスとして処理されます。

DataDirectory または ~ 演算子で始まるパスは、DataDirectory と ~ 演算子の分岐の外側の物理パスには解決できません。 たとえば、パス ~、~/data、~/bin/Model/SqlServer は解決されます。 パス ~/.. や ~/../other は解決できません。

DataDirectory と ~ 演算子は、|DataDirectory|\Model や ~/bin/Model など、サブディレクトリが含まれるように拡張できます。

DataDirectory 置換文字列と ~ 演算子の解決は非再帰型です。 たとえば、DataDirectory に ~ 文字が含まれる場合は、例外が発生します。 これにより、無限再帰が回避されます。

関連項目