DbConnectionStringBuilder Classe

Definizione

public ref class DbConnectionStringBuilder : System::Collections::IDictionary

public ref class DbConnectionStringBuilder : System::Collections::IDictionary, System::ComponentModel::ICustomTypeDescriptor

public class DbConnectionStringBuilder : System.Collections.IDictionary

public class DbConnectionStringBuilder : System.Collections.IDictionary, System.ComponentModel.ICustomTypeDescriptor

type DbConnectionStringBuilder = class
    interface ICollection
    interface IEnumerable
    interface IDictionary

type DbConnectionStringBuilder = class
    interface IDictionary
    interface ICollection
    interface IEnumerable
    interface ICustomTypeDescriptor

type DbConnectionStringBuilder = class
    interface ICollection
    interface IEnumerable
    interface IDictionary
    interface ICustomTypeDescriptor

Public Class DbConnectionStringBuilder
Implements IDictionary

Public Class DbConnectionStringBuilder
Implements ICustomTypeDescriptor, IDictionary

Ereditarietà

Object

DbConnectionStringBuilder

Derivato

System.Data.EntityClient.EntityConnectionStringBuilder

System.Data.Odbc.OdbcConnectionStringBuilder

System.Data.OleDb.OleDbConnectionStringBuilder

System.Data.OracleClient.OracleConnectionStringBuilder

System.Data.SqlClient.SqlConnectionStringBuilder

Implementazioni

ICollection IDictionary IEnumerable ICustomTypeDescriptor

Esempio

L'applicazione console seguente compila due stringhe di connessione, una per un database Microsoft Jet e una per un database di SQL Server. In ogni caso, il codice usa una classe DbConnectionStringBuilder generica per creare la stringa di connessione e quindi passa la proprietà ConnectionString dell'istanza di DbConnectionStringBuilder al costruttore della classe di connessione fortemente tipizzata. Questo non è obbligatorio; Il codice potrebbe anche aver creato singole istanze del generatore di stringhe di connessione fortemente tipizzato. L'esempio analizza anche una stringa di connessione esistente e illustra vari modi per modificare il contenuto della stringa di connessione.

DbConnectionStringBuilder builder =
    new DbConnectionStringBuilder();
builder.ConnectionString = @"Data Source=c:\MyData\MyDb.mdb";
builder.Add("Provider", "Microsoft.Jet.Oledb.4.0");
// Set up row-level locking.
builder.Add("Jet OLEDB:Database Locking Mode", 1);

// The DbConnectionStringBuilder class
// is database agnostic, so it's possible to
// build any type of connection string using
// this class.

// The ConnectionString property might have been
// formatted by the DbConnectionStringBuilder class.
OleDbConnection oledbConnect = new
    OleDbConnection(builder.ConnectionString);
Console.WriteLine(oledbConnect.ConnectionString);

// Use the same DbConnectionStringBuilder to create
// a SqlConnection object.
builder.Clear();
builder.Add("integrated security", true);
builder.Add("Initial Catalog", "AdventureWorks");
builder.Add("Data Source", "(local)");

SqlConnection sqlConnect = new
    SqlConnection(builder.ConnectionString);
Console.WriteLine(sqlConnect.ConnectionString);

// Pass the DbConnectionStringBuilder an existing
// connection string, and you can retrieve and
// modify any of the elements.
builder.ConnectionString = "server=(local);initial catalog=AdventureWorks";
builder["Server"] = ".";

// Setting the indexer adds the value, if necessary.
builder["Integrated Security"] = true;
Console.WriteLine(builder.ConnectionString);

Sub Main()
    Dim builder As New DbConnectionStringBuilder()
    builder.ConnectionString = "Data Source=c:\MyData\MyDb.mdb"
    builder.Add("Provider", "Microsoft.Jet.Oledb.4.0")

    ' Set up row-level locking.
    builder.Add("Jet OLEDB:Database Locking Mode", 1)

    ' Note that the DbConnectionStringBuilder class
    ' is database agnostic, and it's possible to
    ' build any type of connection string using
    ' this class.
    ' Notice that the ConnectionString property may have been
    ' formatted by the DbConnectionStringBuilder class.

    Dim oledbConnect As New _
        OleDbConnection(builder.ConnectionString)
    Console.WriteLine(oledbConnect.ConnectionString)

    ' Use the same DbConnectionStringBuilder to create
    ' a SqlConnection object.
    builder.Clear()
    builder.Add("integrated security", True)
    builder.Add("Initial Catalog", "AdventureWorks")
    builder.Add("Data Source", "(local)")

    Dim sqlConnect As New SqlConnection(builder.ConnectionString)
    Console.WriteLine(sqlConnect.ConnectionString)

    ' Pass the DbConnectionStringBuilder an existing
    ' connection string, and you can retrieve and
    ' modify any of the elements.
    builder.ConnectionString = "server=(local);initial catalog=AdventureWorks"
    builder.Item("Server") = "."

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

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

Commenti

La classe DbConnectionStringBuilder fornisce la classe base da cui derivano i generatori di stringhe di connessione fortemente tipizzato (SqlConnectionStringBuilder, OleDbConnectionStringBuildere così via). I generatori di stringhe di connessione consentono agli sviluppatori di creare a livello di codice stringhe di connessione sintatticamente corrette e analizzare e ricompilare le stringhe di connessione esistenti.

Il DbConnectionStringBuilder è stato definito in modo indipendente dal database. A causa dell'aggiunta dello spazio dei nomi System.Data.Common, gli sviluppatori richiedono una classe base in cui possono programmare per creare stringhe di connessione che possono funzionare su un database arbitrario. Pertanto, la classe DbConnectionStringBuilder consente agli utenti di assegnare coppie chiave/valore arbitrarie e di passare la stringa di connessione risultante a un provider fortemente tipizzato. Tutti i provider di dati inclusi come parte di .NET offrono una classe fortemente tipizzata che eredita da DbConnectionStringBuilder: SqlConnectionStringBuilder, OracleConnectionStringBuilder, OdbcConnectionStringBuildere OleDbConnectionStringBuilder.

È possibile compilare, assegnare e modificare le stringhe di connessione per qualsiasi provider arbitrario. Per i provider che supportano coppie chiave/valore specifiche, il generatore di stringhe di connessione fornisce proprietà fortemente tipizzate corrispondenti alle coppie note. Per i provider che richiedono la possibilità di supportare valori sconosciuti, è anche possibile fornire coppie chiave/valore arbitrarie.

La classe DbConnectionStringBuilder implementa l'interfaccia ICustomTypeDescriptor. Ciò significa che la classe funziona con le finestre di progettazione di Visual Studio in fase di progettazione. Quando gli sviluppatori usano la finestra di progettazione per compilare set di dati fortemente tipizzati e connessioni fortemente tipizzate all'interno di Visual Studio, la classe generatore di stringhe di connessione fortemente tipizzata visualizza le proprietà associate al relativo tipo e include convertitori che possono eseguire il mapping dei valori comuni per le chiavi note.

Se è necessario creare stringhe di connessione come parte delle applicazioni, usare la classe DbConnectionStringBuilder o una delle relative derivate fortemente tipate per compilare e modificare le stringhe di connessione. La classe DbConnectionStringBuilder semplifica anche la gestione delle stringhe di connessione archiviate in un file di configurazione dell'applicazione.

È possibile creare stringhe di connessione usando una classe di generatore di stringhe di connessione fortemente tipizzata o la classe DbConnectionStringBuilder. Il DbConnectionStringBuilder non esegue alcun controllo per le coppie chiave/valore valide. Pertanto, è possibile creare stringhe di connessione non valide quando si usa questa classe. Il SqlConnectionStringBuilder supporta solo coppie chiave/valore supportate da SQL Server; il tentativo di aggiungere coppie non valide genererà un'eccezione.

Sia il metodo Add che Item[] i casi di gestione delle proprietà in cui un attore malintenzionato tenta di inserire voci dannose. Ad esempio, il codice seguente esegue correttamente l'escape della coppia chiave/valore annidata:

Dim builder As New System.Data.Common.DbConnectionStringBuilder
builder("Data Source") = "(local)"
builder("integrated sSecurity") = True
builder("Initial Catalog") = "AdventureWorks;NewValue=Bad"

System.Data.Common.DbConnectionStringBuilder builder = new System.Data.Common.DbConnectionStringBuilder();
builder["Data Source"] = "(local)";
builder["integrated Security"] = true;
builder["Initial Catalog"] = "AdventureWorks;NewValue=Bad";

Il risultato è la stringa di connessione seguente che gestisce il valore non valido in modo sicuro:

data source=(local);integrated security=True;
initial catalog="AdventureWorks;NewValue=Bad"

Vedi anche

• Stringhe di connessione in ADO.NET
• Panoramica di ADO.NET