EntityConnectionStringBuilder EntityConnectionStringBuilder EntityConnectionStringBuilder EntityConnectionStringBuilder Class

定義

EntityClient で使用される接続文字列の内容を簡単に作成および管理するための手段を提供します。Provides a simple way to create and manage the contents of connection strings used by the EntityClient.

public ref class EntityConnectionStringBuilder sealed : System::Data::Common::DbConnectionStringBuilder
public sealed class EntityConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder
type EntityConnectionStringBuilder = class
    inherit DbConnectionStringBuilder
Public NotInheritable Class EntityConnectionStringBuilder
Inherits DbConnectionStringBuilder
継承
EntityConnectionStringBuilderEntityConnectionStringBuilderEntityConnectionStringBuilderEntityConnectionStringBuilder

次の例では、EntityConnectionStringBuilderSqlConnectionStringBuilder を組み合わせて使用しています。The following example demonstrates how to use the EntityConnectionStringBuilder in conjunction with a SqlConnectionStringBuilder.


// Specify the provider name, server and database.
string providerName = "System.Data.SqlClient";
string serverName = ".";
string databaseName = "AdventureWorks";

// Initialize the connection string builder for the
// underlying provider.
SqlConnectionStringBuilder sqlBuilder =
    new SqlConnectionStringBuilder();

// Set the properties for the data source.
sqlBuilder.DataSource = serverName;
sqlBuilder.InitialCatalog = databaseName;
sqlBuilder.IntegratedSecurity = true;

// Build the SqlConnection connection string.
string providerString = sqlBuilder.ToString();

// Initialize the EntityConnectionStringBuilder.
EntityConnectionStringBuilder entityBuilder =
    new EntityConnectionStringBuilder();

//Set the provider name.
entityBuilder.Provider = providerName;

// Set the provider-specific connection string.
entityBuilder.ProviderConnectionString = providerString;

// Set the Metadata location.
entityBuilder.Metadata = @"res://*/AdventureWorksModel.csdl|
                            res://*/AdventureWorksModel.ssdl|
                            res://*/AdventureWorksModel.msl";
Console.WriteLine(entityBuilder.ToString());

using (EntityConnection conn =
    new EntityConnection(entityBuilder.ToString()))
{
    conn.Open();
    Console.WriteLine("Just testing the connection.");
    conn.Close();
}
' Specify the provider name, server and database.
Dim providerName As String = "System.Data.SqlClient"
Dim serverName As String = "."
Dim databaseName As String = "AdventureWorks"

' Initialize the connection string builder for the
' underlying provider.
Dim sqlBuilder As New SqlConnectionStringBuilder

' Set the properties for the data source.
sqlBuilder.DataSource = serverName
sqlBuilder.InitialCatalog = databaseName
sqlBuilder.IntegratedSecurity = True

' Build the SqlConnection connection string.
Dim providerString As String = sqlBuilder.ToString

' Initialize the EntityConnectionStringBuilder.
Dim entityBuilder As New EntityConnectionStringBuilder

'Set the provider name.
entityBuilder.Provider = providerName
' Set the provider-specific connection string.
entityBuilder.ProviderConnectionString = providerString
' Set the Metadata location to the current directory.
entityBuilder.Metadata = "res://*/AdventureWorksModel.csdl|" & _
                            "res://*/AdventureWorksModel.ssdl|" & _
                            "res://*/AdventureWorksModel.msl"

Console.WriteLine(entityBuilder.ToString)

Using conn As EntityConnection = New EntityConnection(entityBuilder.ToString)
    conn.Open()
    Console.WriteLine("Just testing the connection.")
    conn.Close()
End Using

注釈

接続文字列ビルダーを使用すると、開発者はこのクラスのプロパティおよびメソッドを使用することによって、正しい構文の接続文字列をプログラムで作成し、既存の接続文字列の解析や再作成を行うことができます。The connection string builder lets developers programmatically create syntactically correct connection strings, and parse and rebuild existing connection strings, by using properties and methods of the class. 接続文字列ビルダーは、既知のキーワード/値ペアに対応する厳密に型指定されたプロパティを提供します。The connection string builder provides strongly typed properties corresponding to the known keyword/value pairs. アプリケーションの一部として接続文字列を作成する必要がある開発者は、EntityConnectionStringBuilder クラスを使用して接続文字列を作成および変更できます。Developers who must create connection strings as part of applications can use the EntityConnectionStringBuilder class to build and modify connection strings.

EntityConnectionStringBuilder は、EntityConnectionStringBuilder プロパティ値として公開されている、有効なキーワード/値ペアをチェックします。The EntityConnectionStringBuilder performs checks for valid keyword/value pairs, each of which is exposed as a EntityConnectionStringBuilder property value.

注意

基になるデータ ソースの接続文字列は、ProviderConnectionString プロパティによって提供されます。The connection string for the underlying data source is supplied by the ProviderConnectionString property. 提供されたプロバイダー接続文字列に対しては、有効なキーワード/値ペアのチェックは行われません。The supplied provider connection string is not checked for valid keyword/value pairs.

コンストラクター

EntityConnectionStringBuilder() EntityConnectionStringBuilder() EntityConnectionStringBuilder() EntityConnectionStringBuilder()

EntityConnectionStringBuilder クラスの新しいインスタンスを初期化します。Initializes a new instance of the EntityConnectionStringBuilder class.

EntityConnectionStringBuilder(String) EntityConnectionStringBuilder(String) EntityConnectionStringBuilder(String) EntityConnectionStringBuilder(String)

提供された接続文字列を使用して、EntityConnectionStringBuilder クラスの新しいインスタンスを初期化します。Initializes a new instance of the EntityConnectionStringBuilder class using the supplied connection string.

プロパティ

BrowsableConnectionString BrowsableConnectionString BrowsableConnectionString BrowsableConnectionString

ConnectionString プロパティを Visual Studio デザイナーに表示するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the ConnectionString property is visible in Visual Studio designers.

(Inherited from DbConnectionStringBuilder)
ConnectionString ConnectionString ConnectionString ConnectionString

DbConnectionStringBuilder に関連付けられた接続文字列を取得または設定します。Gets or sets the connection string associated with the DbConnectionStringBuilder.

(Inherited from DbConnectionStringBuilder)
Count Count Count Count

ConnectionString プロパティ内に含まれる現在のキー数を取得します。Gets the current number of keys that are contained within the ConnectionString property.

(Inherited from DbConnectionStringBuilder)
ICollection.IsSynchronized ICollection.IsSynchronized ICollection.IsSynchronized ICollection.IsSynchronized

ICollection へのアクセスが同期されている (スレッド セーフである) かどうかを示す値を取得します。Gets a value indicating whether access to the ICollection is synchronized (thread safe).

(Inherited from DbConnectionStringBuilder)
ICollection.SyncRoot ICollection.SyncRoot ICollection.SyncRoot ICollection.SyncRoot

ICollection へのアクセスを同期するために使用できるオブジェクトを取得します。Gets an object that can be used to synchronize access to the ICollection.

(Inherited from DbConnectionStringBuilder)
IDictionary.IsFixedSize IDictionary.IsFixedSize IDictionary.IsFixedSize IDictionary.IsFixedSize Inherited from DbConnectionStringBuilder
IDictionary.IsReadOnly IDictionary.IsReadOnly IDictionary.IsReadOnly IDictionary.IsReadOnly Inherited from DbConnectionStringBuilder
IDictionary.Item[Object] IDictionary.Item[Object] IDictionary.Item[Object] IDictionary.Item[Object]

指定したキーを持つ要素を取得または設定します。Gets or sets the element with the specified key.

(Inherited from DbConnectionStringBuilder)
IsFixedSize IsFixedSize IsFixedSize IsFixedSize

EntityConnectionStringBuilder が固定サイズかどうかを示す値を取得します。Gets a value that indicates whether the EntityConnectionStringBuilder has a fixed size.

IsReadOnly IsReadOnly IsReadOnly IsReadOnly

DbConnectionStringBuilder が読み取り専用かどうかを示す値を取得します。Gets a value that indicates whether the DbConnectionStringBuilder is read-only.

(Inherited from DbConnectionStringBuilder)
Item[String] Item[String] Item[String] Item[String]

指定されたキーに関連付けられている値を取得または設定します。Gets or sets the value associated with the specified key. C# の場合、このプロパティはインデクサーです。In C#, this property is the indexer.

Keys Keys Keys Keys

ICollection 内のキーが格納されている EntityConnectionStringBuilder を取得します。Gets an ICollection that contains the keys in the EntityConnectionStringBuilder.

Metadata Metadata Metadata Metadata

接続文字列内のメタデータの位置を取得または設定します。Gets or sets the metadata locations in the connection string.

Name Name Name Name

構成ファイルに定義されるセクションの名前を取得または設定します。Gets or sets the name of a section as defined in a configuration file.

Provider Provider Provider Provider

接続文字列内の基になる .NET Framework.NET Framework データ プロバイダーの名前を取得または設定します。Gets or sets the name of the underlying .NET Framework.NET Framework data provider in the connection string.

ProviderConnectionString ProviderConnectionString ProviderConnectionString ProviderConnectionString

内部のプロバイダー固有の接続文字列を取得または設定します。Gets or sets the inner, provider-specific connection string.

Values Values Values Values

ICollection 内の値を格納している DbConnectionStringBuilder を取得します。Gets an ICollection that contains the values in the DbConnectionStringBuilder.

(Inherited from DbConnectionStringBuilder)

メソッド

Add(String, Object) Add(String, Object) Add(String, Object) Add(String, Object)

指定したキーおよび値を持つエントリを DbConnectionStringBuilder に追加します。Adds an entry with the specified key and value into the DbConnectionStringBuilder.

(Inherited from DbConnectionStringBuilder)
Clear() Clear() Clear() Clear()

EntityConnectionStringBuilder インスタンスの内容を消去します。Clears the contents of the EntityConnectionStringBuilder instance.

ClearPropertyDescriptors() ClearPropertyDescriptors() ClearPropertyDescriptors() ClearPropertyDescriptors()

関連する DbConnectionStringBuilder 上の PropertyDescriptor オブジェクトのコレクションをクリアします。Clears the collection of PropertyDescriptor objects on the associated DbConnectionStringBuilder.

(Inherited from DbConnectionStringBuilder)
ContainsKey(String) ContainsKey(String) ContainsKey(String) ContainsKey(String)

EntityConnectionStringBuilder に特定のキーが格納されているかどうかを判断します。Determines whether the EntityConnectionStringBuilder contains a specific key.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

指定したオブジェクトが、現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(Inherited from Object)
EquivalentTo(DbConnectionStringBuilder) EquivalentTo(DbConnectionStringBuilder) EquivalentTo(DbConnectionStringBuilder) EquivalentTo(DbConnectionStringBuilder)

この DbConnectionStringBuilder オブジェクトの接続情報を、提供されたオブジェクトの接続情報を比較します。Compares the connection information in this DbConnectionStringBuilder object with the connection information in the supplied object.

(Inherited from DbConnectionStringBuilder)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(Inherited from Object)
GetProperties(Hashtable) GetProperties(Hashtable) GetProperties(Hashtable) GetProperties(Hashtable)

指定された Hashtable に、この DbConnectionStringBuilder のすべてのプロパティに関する情報を格納します。Fills a supplied Hashtable with information about all the properties of this DbConnectionStringBuilder.

(Inherited from DbConnectionStringBuilder)
GetType() GetType() GetType() GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(Inherited from Object)
Remove(String) Remove(String) Remove(String) Remove(String)

指定されたキーを持つエントリを EntityConnectionStringBuilder インスタンスから削除します。Removes the entry with the specified key from the EntityConnectionStringBuilder instance.

ShouldSerialize(String) ShouldSerialize(String) ShouldSerialize(String) ShouldSerialize(String)

指定されたキーが、この DbConnectionStringBuilder インスタンスに存在するかどうかを示します。Indicates whether the specified key exists in this DbConnectionStringBuilder instance.

(Inherited from DbConnectionStringBuilder)
ToString() ToString() ToString() ToString()

DbConnectionStringBuilder に関連付けられた接続文字列を返します。Returns the connection string associated with this DbConnectionStringBuilder.

(Inherited from DbConnectionStringBuilder)
TryGetValue(String, Object) TryGetValue(String, Object) TryGetValue(String, Object) TryGetValue(String, Object)

提供されたキーに対応する値をこの EntityConnectionStringBuilder から取得します。Retrieves a value corresponding to the supplied key from this EntityConnectionStringBuilder.

明示的なインターフェイスの実装

ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32)

ICollection の要素を Array にコピーします。Array の特定のインデックスからコピーが開始されます。Copies the elements of the ICollection to an Array, starting at a particular Array index.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetAttributes() ICustomTypeDescriptor.GetAttributes() ICustomTypeDescriptor.GetAttributes() ICustomTypeDescriptor.GetAttributes()

コンポーネントのこのインスタンスのカスタム属性のコレクションを返します。Returns a collection of custom attributes for this instance of a component.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetClassName() ICustomTypeDescriptor.GetClassName() ICustomTypeDescriptor.GetClassName() ICustomTypeDescriptor.GetClassName()

コンポーネントのこのインスタンスのクラス名を返します。Returns the class name of this instance of a component.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetComponentName() ICustomTypeDescriptor.GetComponentName() ICustomTypeDescriptor.GetComponentName() ICustomTypeDescriptor.GetComponentName()

コンポーネントのこのインスタンスの名前を返します。Returns the name of this instance of a component.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetConverter() ICustomTypeDescriptor.GetConverter() ICustomTypeDescriptor.GetConverter() ICustomTypeDescriptor.GetConverter()

コンポーネントのこのインスタンスの型コンバーターを返します。Returns a type converter for this instance of a component.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultEvent() ICustomTypeDescriptor.GetDefaultEvent() ICustomTypeDescriptor.GetDefaultEvent() ICustomTypeDescriptor.GetDefaultEvent()

コンポーネントのこのインスタンスの既定のイベントを返します。Returns the default event for this instance of a component.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultProperty() ICustomTypeDescriptor.GetDefaultProperty() ICustomTypeDescriptor.GetDefaultProperty() ICustomTypeDescriptor.GetDefaultProperty()

コンポーネントのこのインスタンスの既定のプロパティを返します。Returns the default property for this instance of a component.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEditor(Type) ICustomTypeDescriptor.GetEditor(Type) ICustomTypeDescriptor.GetEditor(Type) ICustomTypeDescriptor.GetEditor(Type)

コンポーネントのこのインスタンスに対して指定されている型のエディターを返します。Returns an editor of the specified type for this instance of a component.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents() ICustomTypeDescriptor.GetEvents() ICustomTypeDescriptor.GetEvents() ICustomTypeDescriptor.GetEvents()

コンポーネントのこのインスタンスのイベントを返します。Returns the events for this instance of a component.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents(Attribute[]) ICustomTypeDescriptor.GetEvents(Attribute[]) ICustomTypeDescriptor.GetEvents(Attribute[]) ICustomTypeDescriptor.GetEvents(Attribute[])

フィルターとして指定された属性配列を使用して、コンポーネントのこのインスタンスのイベントを返します。Returns the events for this instance of a component using the specified attribute array as a filter.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties() ICustomTypeDescriptor.GetProperties() ICustomTypeDescriptor.GetProperties() ICustomTypeDescriptor.GetProperties()

コンポーネントのこのインスタンスのプロパティを返します。Returns the properties for this instance of a component.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties(Attribute[]) ICustomTypeDescriptor.GetProperties(Attribute[]) ICustomTypeDescriptor.GetProperties(Attribute[]) ICustomTypeDescriptor.GetProperties(Attribute[])

属性配列をフィルターとして使用して、コンポーネントのこのインスタンスのプロパティを返します。Returns the properties for this instance of a component using the attribute array as a filter.

(Inherited from DbConnectionStringBuilder)
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor) ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor) ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor) ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)

指定したプロパティ記述子によって記述されたプロパティを含むオブジェクトを返します。Returns an object that contains the property described by the specified property descriptor.

(Inherited from DbConnectionStringBuilder)
IDictionary.Add(Object, Object) IDictionary.Add(Object, Object) IDictionary.Add(Object, Object) IDictionary.Add(Object, Object)

指定したキーおよび値を持つ要素を IDictionary オブジェクトに追加します。Adds an element with the provided key and value to the IDictionary object.

(Inherited from DbConnectionStringBuilder)
IDictionary.Contains(Object) IDictionary.Contains(Object) IDictionary.Contains(Object) IDictionary.Contains(Object)

指定したキーを持つ要素が IDictionary オブジェクトに格納されているかどうかを確認します。Determines whether the IDictionary object contains an element with the specified key.

(Inherited from DbConnectionStringBuilder)
IDictionary.GetEnumerator() IDictionary.GetEnumerator() IDictionary.GetEnumerator() IDictionary.GetEnumerator()

IDictionary オブジェクトの IDictionaryEnumerator オブジェクトを返します。Returns an IDictionaryEnumerator object for the IDictionary object.

(Inherited from DbConnectionStringBuilder)
IDictionary.Remove(Object) IDictionary.Remove(Object) IDictionary.Remove(Object) IDictionary.Remove(Object)

指定したキーを持つ要素を IDictionary オブジェクトから削除します。Removes the element with the specified key from the IDictionary object.

(Inherited from DbConnectionStringBuilder)
IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator() IEnumerable.GetEnumerator()

コレクションを反復処理する列挙子を返します。Returns an enumerator that iterates through a collection.

(Inherited from DbConnectionStringBuilder)

拡張メソッド

Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable)

IEnumerable の要素を、指定した型にキャストします。Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable)

指定された型に基づいて IEnumerable の要素をフィルター処理します。Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable)

クエリの並列化を有効にします。Enables parallelization of a query.

AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable)

IEnumerableIQueryable に変換します。Converts an IEnumerable to an IQueryable.

適用対象

こちらもご覧ください