OracleConnectionStringBuilder クラス

定義

警告

この API は現在使われていません。

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

public ref class OracleConnectionStringBuilder sealed : System::Data::Common::DbConnectionStringBuilder
[System.ComponentModel.TypeConverter(typeof(System.Data.OracleClient.OracleConnectionStringBuilder/OracleConnectionStringBuilderConverter))]
public sealed class OracleConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder
[System.ComponentModel.TypeConverter(typeof(System.Data.OracleClient.OracleConnectionStringBuilder/OracleConnectionStringBuilderConverter))]
[System.Obsolete("OracleConnectionStringBuilder has been deprecated. http://go.microsoft.com/fwlink/?LinkID=144260", false)]
public sealed class OracleConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder
type OracleConnectionStringBuilder = class
    inherit DbConnectionStringBuilder
Public NotInheritable Class OracleConnectionStringBuilder
Inherits DbConnectionStringBuilder
継承
OracleConnectionStringBuilder
属性

次のコンソールアプリケーションでは、Oracle データベースの接続文字列を作成します。The following console application builds connection strings for an Oracle database. このコードでは、OracleConnectionStringBuilder クラスを使用して接続文字列を作成し、OracleConnectionStringBuilder インスタンスの ConnectionString プロパティを接続クラスのコンストラクターに渡します。The code uses an OracleConnectionStringBuilder class to create the connection string, and then passes the ConnectionString property of the OracleConnectionStringBuilder instance to the constructor of the connection class. また、この例では、既存の接続文字列を解析し、接続文字列の内容を操作するさまざまな方法を示します。The example also parses an existing connection string, and demonstrates various ways of manipulating the connection string's contents.

注意

この例には、OracleConnectionStringBuilder による接続文字列の操作方法を示すために、パスワードが含まれています。This example includes a password to demonstrate how OracleConnectionStringBuilder works with connection strings. 実際のアプリケーションでは、Windows 認証を使用することをお勧めします。In your applications, we recommend that you use Windows Authentication. パスワードを使用する必要がある場合も、ハードコードされたパスワードをアプリケーションに含めないでください。If you must use a password, do not include a hard-coded password in your application.

// You may need to set a reference to the System.Data.OracleClient
// assembly before you can run this sample.
using System.Data.OracleClient;

class Program
{
    static void Main()
    {
        // Create a new OracleConnectionStringBuilder and
        // initialize it with a few name/value pairs.
        OracleConnectionStringBuilder builder =
            new OracleConnectionStringBuilder(GetConnectionString());

        // Note that the input connection string used the
        // Server key, but the new connection string uses
        // the well-known Data Source key instead.
        Console.WriteLine(builder.ConnectionString);

        // Pass the OracleConnectionStringBuilder an existing
        // connection string, and you can retrieve and
        // modify any of the elements.
        builder.ConnectionString = "server=OracleDemo;user id=maryc;" +
            "password=pass@word1";

        // Now that the connection string has been parsed,
        // you can work with individual items.
        Console.WriteLine(builder.Password);
        builder.Password = "newPassword";
        builder.PersistSecurityInfo = true;

        // You can refer to connection keys using strings,
        // as well. When you use this technique (the default
        // Item property in Visual Basic, or the indexer in C#),
        // you can specify any synonym for the connection string key
        // name.
        builder["Server"] = ".";
        builder["Load Balance Timeout"] = 1000;
        builder["Integrated Security"] = true;
        Console.WriteLine(builder.ConnectionString);

        Console.WriteLine("Press Enter to finish.");
        Console.ReadLine();
    }

    private static string GetConnectionString()
    {
        // To avoid storing the connection string in your code,
        // you can retrieve it from a configuration file.
        return "Server=OracleDemo;Integrated Security=true";
    }
}
' You may need to set a reference to the System.Data.OracleClient
' assembly before running this example.
Imports System.Data.OracleClient

Module Module1
  Sub Main()
    ' Create a new OracleConnectionStringBuilder and
    ' initialize it with a few name/value pairs.
    Dim builder As New OracleConnectionStringBuilder(GetConnectionString())

    ' Note that the input connection string used the 
    ' Server key, but the new connection string uses
    ' the well-known Data Source key instead.
    Console.WriteLine(builder.ConnectionString)

    ' Pass the OracleConnectionStringBuilder an existing 
    ' connection string, and you can retrieve and
    ' modify any of the elements.
    builder.ConnectionString = _
        "server=OracleDemo;user id=Mary;" & _
        "password=*****"
    ' Now that the connection string has been parsed,
    ' you can work with individual items.
    Console.WriteLine(builder.Password)
    builder.Password = "newPassword"
    builder.PersistSecurityInfo = True

    ' You can refer to connection keys using strings, 
    ' as well. When you use this technique (the default
    ' Item property in Visual Basic, or the indexer in C#),
    ' you can specify any synonym for the connection string key
    ' name.
    builder("Server") = "NewDemo"
    builder("Load Balance Timeout") = 1000

    ' The Item property is the default for the class, 
    ' and setting the Item property adds the value to the 
    ' dictionary, if necessary. 
    builder.Item("Integrated Security") = True
    Console.WriteLine(builder.ConnectionString)

    Console.WriteLine("Press Enter to finish.")
    Console.ReadLine()
  End Sub

  Private Function GetConnectionString() As String
    ' To avoid storing the connection string in your code,
    ' you can retrieve it from a configuration file. 
    Return "Server=OracleDemo;Integrated Security=True;" & _
      "Unicode=True"
  End Function

End Module

注釈

この型は非推奨です。今後のバージョンの .NET Framework では削除されます。This type is deprecated and will be removed in a future version of the .NET Framework. 詳細については、「 Oracle と ADO.NET」を参照してください。For more information, see Oracle and ADO.NET.

接続文字列ビルダーを使用すると、開発者はクラスのプロパティとメソッドを使用して、構文的に正しい接続文字列をプログラムによって作成し、既存の接続文字列を解析および再構築することができます。The connection string builders allow developers to programmatically create syntactically correct connection strings, and to parse and rebuild existing connection strings, using properties and methods of the class. 接続文字列ビルダーは、Oracle で許可されている既知のキーと値のペアに対応する、厳密に型指定されたプロパティを提供します。The connection string builder provides strongly typed properties corresponding to the known key/value pairs allowed by Oracle. OracleConnectionStringBuilder クラスによって、ICustomTypeDescriptor インターフェイスが実装されます。The OracleConnectionStringBuilder class implements the ICustomTypeDescriptor interface. これは、クラスがデザイン時に Visual Studio .NET デザイナーで動作することを意味します。This means that the class works with Visual Studio .NET designers at design time. 開発者がデザイナーを使用して、厳密に型指定されたデータセットと、Visual Studio .net 内の厳密に型指定された接続を構築する場合、厳密に型指定された接続文字列ビルダークラスはその型に関連付けられたプロパティを表示し、既知のキーの共通値をマップできるコンバーターもあります。When developers use the designer to build strongly typed DataSets and strongly typed connections within Visual Studio .NET, the strongly typed connection string builder class will display the properties associated with its type and will also have converters that can map common values for known keys.

アプリケーションの一部として接続文字列を作成する必要がある開発者は、OracleConnectionStringBuilder クラスを使用して接続文字列を作成および変更できます。Developers needing to create connection strings as part of applications can use the OracleConnectionStringBuilder class to build and modify connection strings. OracleConnectionStringBuilder クラスを使用すると、アプリケーション構成ファイルに格納されている接続文字列を簡単に管理できます。The OracleConnectionStringBuilder class also makes it easy to manage connection strings stored in an application configuration file.

OracleConnectionStringBuilder では、有効なキー/値ペアのチェックが行われます。The OracleConnectionStringBuilder performs checks for valid key/value pairs. したがって、このクラスを使用して無効な接続文字列を作成することはできません。Therefore, this class cannot be used to create invalid connection strings. 無効なペアを追加しようとすると、例外がスローされます。Trying to add invalid pairs will throw an exception. OracleConnectionStringBuilder クラスは、一連のシノニムを保持します。必要に応じて、シノニムから対応する既知のキー名に変換するために必要な変換を実行できます。The OracleConnectionStringBuilder class maintains a fixed collection of synonyms, and when required, can perform the required translation to convert from a synonym to the corresponding well-known key name. たとえば、Item[] プロパティを使用して値を取得する場合は、必要なキーのシノニムを含む文字列を指定できます。For example, when you use the Item[] property to retrieve a value, you can specify a string that contains any synonym for the key you need. 使用可能なシノニムの一覧については、Item[] プロパティのトピックを参照してください。See the Item[] property for a full list of acceptable synonyms.

OracleConnectionStringBuilder は、悪意のあるエントリの挿入の試行を処理します。The OracleConnectionStringBuilder handles attempts to insert malicious entries. たとえば、次のコードでは、既定の Item[] プロパティ (のC#インデクサー) を使用して、入れ子になったキーと値のペアを正しくエスケープします。For example, the following code, using the default Item[] property (the indexer, in C#) correctly escapes the nested key/value pair.

Dim builder As New System.Data. _  
    OracleClient.OracleConnectionStringBuilder  
builder("Data Source") = "OracleDemo"  
builder("Integrated Security") = True  
builder("User ID") = "Mary;NewValue=Bad"  
System.Diagnostics.Debug.WriteLine(builder.ConnectionString)  
System.Data.OracleClient.OracleConnectionStringBuilder builder =  
   new System.Data.OracleClient.OracleConnectionStringBuilder();  
builder["Data Source"] = "OracleDemo";  
builder["integrated Security"] = true;  
builder["User ID"] = "Mary;NewValue=Bad";  
System.Diagnostics.Debug.WriteLine(builder.ConnectionString);  

結果として、ユーザー ID 値を引用符で囲むことによって、無効な値を安全な方法で処理する次の接続文字列が返されます。The result is the following connection string that handles the invalid value in a safe manner by enclosing the User ID value in quotes:

Data Source=OracleDemo;Integrated Security=True;User ID="Mary;NewValue=Bad"  

コンストラクター

OracleConnectionStringBuilder()

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

OracleConnectionStringBuilder(String)

OracleConnectionStringBuilder クラスの新しいインスタンスを初期化します。Initializes a new instance of the OracleConnectionStringBuilder class. 指定された接続文字列によって、インスタンスの内部的な接続情報のデータが提供されます。The provided connection string provides the data for the instance's internal connection information.

プロパティ

BrowsableConnectionString

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

(継承元 DbConnectionStringBuilder)
ConnectionString

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

(継承元 DbConnectionStringBuilder)
Count

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

(継承元 DbConnectionStringBuilder)
DataSource

接続先の Oracle データ ソースの名前を取得または設定します。Gets or sets the name of the Oracle data source to connect to.

Enlist

プーラーが、作成スレッドの現在のトランザクション コンテキストに、接続を自動的に登録するかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether the pooler automatically enlists the connection in the creation thread's current transaction context.

IntegratedSecurity

"User ID" および "Password" を接続文字列中に指定するか (false の場合)、現在の Windows アカウントの資格情報を認証に使用するか (true の場合) を示す値を取得または設定します。Gets or sets a value that indicates whether "User ID" and "Password" are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true).

IsFixedSize

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

IsReadOnly

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

(継承元 DbConnectionStringBuilder)
Item[String]

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

Keys

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

LoadBalanceTimeout

接続プールに維持されている接続が削除されるまでの最短時間 (秒) を取得または設定します。Gets or sets the minimum time, in seconds, for the connection to live in the connection pool before it is removed.

MaxPoolSize

この特定の接続文字列について、接続プール内で許可される最大接続数を取得または設定します。Gets or sets the maximum number of connections allowed in the connection pool for this specific connection string.

MinPoolSize

特定の接続文字列について、接続プール内で許可される最小接続数を取得または設定します。Gets or sets the minimum number of connections allowed in the connection pool for this specific connection string.

OmitOracleConnectionName

旧バージョンの Oracle (8.1.7.4.1 以前) でトランザクションのロールバックを可能にするフラグを取得または設定します。Gets or sets the flag that enables transaction rollbacks on earlier versions of Oracle (prior to 8.1.7.4.1).

Password

Oracle アカウントに使用するパスワードを取得または設定します。Gets or sets the password for the Oracle account.

PersistSecurityInfo

接続が開いているか、開いている状態になったことがある場合に、パスワードなどのセキュリティ関連情報が接続の一部として返されていないかどうかを示すブール値を取得または設定します。Gets or sets a Boolean value that indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.

Pooling

接続をプールするか、要求ごとに明示的に各接続を確立するかを示すブール値を取得または設定します。Gets or sets a Boolean value that indicates whether the connection will be pooled, or whether each connection will be explicitly opened every time that the connection is requested.

Unicode

最近の Oracle クライアントで利用できる Unicode 機能をクライアントがサポートしているか、または Unicode 非対応かを示すブール値を取得または設定します。Gets or sets a Boolean value that indicates if the client supports the Unicode functionality available in later Oracle clients, or if it is non-Unicode aware.

UserID

Oracle との接続時に使用するユーザー ID を取得または設定します。Gets or sets the user ID to be used when connecting to Oracle.

Values

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

メソッド

Add(String, Object)

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

(継承元 DbConnectionStringBuilder)
Clear()

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

ClearPropertyDescriptors()

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

(継承元 DbConnectionStringBuilder)
ContainsKey(String)

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

Equals(Object)

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

(継承元 Object)
EquivalentTo(DbConnectionStringBuilder)

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

(継承元 DbConnectionStringBuilder)
GetHashCode()

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

(継承元 Object)
GetProperties(Hashtable)

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

(継承元 DbConnectionStringBuilder)
GetType()

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

(継承元 Object)
MemberwiseClone()

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

(継承元 Object)
Remove(String)

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

ShouldSerialize(String)

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

ToString()

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

(継承元 DbConnectionStringBuilder)
TryGetValue(String, Object)

指定されたキーに対応する値を OracleConnectionStringBuilder から取得します。Retrieves a value corresponding to the supplied key from this OracleConnectionStringBuilder.

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

ICollection.CopyTo(Array, Int32)

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

(継承元 DbConnectionStringBuilder)
ICollection.IsSynchronized

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

(継承元 DbConnectionStringBuilder)
ICollection.SyncRoot

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetAttributes()

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetClassName()

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetComponentName()

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetConverter()

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultEvent()

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultProperty()

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEditor(Type)

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents()

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents(Attribute[])

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties()

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties(Attribute[])

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

(継承元 DbConnectionStringBuilder)
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)

指定されたプロパティ記述子で記述されているプロパティを格納したオブジェクトを返します。Returns an object that contains the property described by the specified property descriptor.

(継承元 DbConnectionStringBuilder)
IDictionary.Add(Object, Object)

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

(継承元 DbConnectionStringBuilder)
IDictionary.Contains(Object)

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

(継承元 DbConnectionStringBuilder)
IDictionary.GetEnumerator()

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

(継承元 DbConnectionStringBuilder)
IDictionary.IsFixedSize (継承元 DbConnectionStringBuilder)
IDictionary.IsReadOnly (継承元 DbConnectionStringBuilder)
IDictionary.Item[Object]

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

(継承元 DbConnectionStringBuilder)
IDictionary.Remove(Object)

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

(継承元 DbConnectionStringBuilder)
IEnumerable.GetEnumerator()

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

(継承元 DbConnectionStringBuilder)

拡張メソッド

Cast<TResult>(IEnumerable)

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

OfType<TResult>(IEnumerable)

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

AsParallel(IEnumerable)

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

AsQueryable(IEnumerable)

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

適用対象

こちらもご覧ください