DbConnectionStringBuilder Classe

Definição

Namespace:

System.Data.Common

Assembly:

System.Data.Common.dll

Origem:

DbConnectionStringBuilder.cs

Fornece uma classe base para construtores de cadeias de conexão fortemente tipado.

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

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

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

Public Class DbConnectionStringBuilder
Implements ICustomTypeDescriptor, IDictionary

Herança

Object

DbConnectionStringBuilder

Derivado

System.Data.EntityClient.EntityConnectionStringBuilder

System.Data.Odbc.OdbcConnectionStringBuilder

System.Data.OleDb.OleDbConnectionStringBuilder

System.Data.OracleClient.OracleConnectionStringBuilder

System.Data.SqlClient.SqlConnectionStringBuilder

Implementações

ICollection IDictionary IEnumerable ICustomTypeDescriptor

Exemplos

O aplicativo de console a seguir cria duas cadeias de conexão, uma para um banco de dados do Microsoft Jet e outra para um banco de dados do SQL Server. Em cada caso, o código usa uma classe DbConnectionStringBuilder genérica para criar a cadeia de conexão e, em seguida, passa a propriedade ConnectionString da instância DbConnectionStringBuilder para o construtor da classe de conexão fortemente tipada. Isso não é necessário; o código também poderia ter criado instâncias individuais do construtor de cadeias de conexão fortemente tipada. O exemplo também analisa uma cadeia de conexão existente e demonstra várias maneiras de manipular o conteúdo da cadeia de conexão.

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

Comentários

A classe DbConnectionStringBuilder fornece a classe base da qual os construtores de cadeia de conexão fortemente tipado (SqlConnectionStringBuilder, OleDbConnectionStringBuildere assim por diante) derivam. Os construtores de cadeia de conexão permitem que os desenvolvedores criem programaticamente cadeias de conexão sintaticamente corretas e analisem e recompilem cadeias de conexão existentes.

O DbConnectionStringBuilder foi definido de maneira independente do banco de dados. Devido à adição do namespace System.Data.Common, os desenvolvedores exigem uma classe base na qual podem programar para criar cadeias de conexão que possam funcionar em um banco de dados arbitrário. Portanto, a classe DbConnectionStringBuilder permite que os usuários atribuam pares de chave/valor arbitrários e passem a cadeia de conexão resultante para um provedor fortemente tipado. Todos os provedores de dados incluídos como parte do .NET oferecem uma classe fortemente tipada que herda de DbConnectionStringBuilder: SqlConnectionStringBuilder, OracleConnectionStringBuilder, OdbcConnectionStringBuildere OleDbConnectionStringBuilder.

Você pode criar, atribuir e editar cadeias de conexão para qualquer provedor arbitrário. Para provedores que dão suporte a pares chave/valor específicos, o construtor de cadeias de conexão fornece propriedades fortemente tipadas correspondentes aos pares conhecidos. Para provedores que exigem a capacidade de dar suporte a valores desconhecidos, você também pode fornecer pares de chave/valor arbitrários.

A classe DbConnectionStringBuilder implementa a interface ICustomTypeDescriptor. Isso significa que a classe funciona com designers do Visual Studio em tempo de design. Quando os desenvolvedores usam o designer para criar Conjuntos de Dados fortemente tipados e conexões fortemente tipadas no Visual Studio, a classe construtor de cadeias de conexão fortemente tipada exibe as propriedades associadas ao seu tipo e também tem conversores que podem mapear valores comuns para chaves conhecidas.

Se você precisar criar cadeias de conexão como parte de aplicativos, use a classe DbConnectionStringBuilder ou um de seus derivados fortemente tipados para criar e modificar cadeias de conexão. A classe DbConnectionStringBuilder também facilita o gerenciamento de cadeias de conexão armazenadas em um arquivo de configuração de aplicativo.

Você pode criar cadeias de conexão usando uma classe de construtor de cadeia de conexão fortemente tipada ou a classe DbConnectionStringBuilder. O DbConnectionStringBuilder não executa verificações de pares chave/valor válidos. Portanto, é possível criar cadeias de conexão inválidas ao usar essa classe. O SqlConnectionStringBuilder dá suporte apenas a pares chave/valor compatíveis com o SQL Server; tentar adicionar pares inválidos gerará uma exceção.

O método Add e a propriedade Item[] manipulam casos em que um ator incorreto tenta inserir entradas mal-intencionadas. Por exemplo, o código a seguir escapa corretamente do par de chave/valor aninhado:

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";

O resultado é a seguinte cadeia de conexão que manipula o valor inválido de maneira segura:

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

Construtores

DbConnectionStringBuilder()	Inicializa uma nova instância da classe DbConnectionStringBuilder.
DbConnectionStringBuilder(Boolean)	Inicializa uma nova instância da classe DbConnectionStringBuilder, opcionalmente usando regras ODBC para aspas.

Propriedades

BrowsableConnectionString	Obtém ou define um valor que indica se a propriedade ConnectionString está visível em designers do Visual Studio.
ConnectionString	Obtém ou define a cadeia de conexão associada ao DbConnectionStringBuilder.
Count	Obtém o número atual de chaves contidas na propriedade ConnectionString.
IsFixedSize	Obtém um valor que indica se o DbConnectionStringBuilder tem um tamanho fixo.
IsReadOnly	Obtém um valor que indica se o DbConnectionStringBuilder é somente leitura.
Item[String]	Obtém ou define o valor associado à chave especificada.
Keys	Obtém um ICollection que contém as chaves no DbConnectionStringBuilder.
Values	Obtém um ICollection que contém os valores no DbConnectionStringBuilder.

Métodos

Add(String, Object)	Adiciona uma entrada com a chave e o valor especificados ao DbConnectionStringBuilder.
AppendKeyValuePair(StringBuilder, String, String, Boolean)	Fornece uma maneira eficiente e segura de acrescentar uma chave e um valor a um objeto StringBuilder existente.
AppendKeyValuePair(StringBuilder, String, String)	Fornece uma maneira eficiente e segura de acrescentar uma chave e um valor a um objeto StringBuilder existente.
Clear()	Limpa o conteúdo da instância de DbConnectionStringBuilder.
ClearPropertyDescriptors()	Limpa a coleção de objetos PropertyDescriptor no DbConnectionStringBuilderassociado.
ContainsKey(String)	Determina se o DbConnectionStringBuilder contém uma chave específica.
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
EquivalentTo(DbConnectionStringBuilder)	Compara as informações de conexão neste objeto DbConnectionStringBuilder com as informações de conexão no objeto fornecido.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetProperties(Hashtable)	Preenche um Hashtable fornecido com informações sobre todas as propriedades deste DbConnectionStringBuilder.
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Objectatual. (Herdado de Object)
Remove(String)	Remove a entrada com a chave especificada da instância de DbConnectionStringBuilder.
ShouldSerialize(String)	Indica se a chave especificada existe nesta instância DbConnectionStringBuilder.
ToString()	Retorna a cadeia de conexão associada a esse DbConnectionStringBuilder.
TryGetValue(String, Object)	Recupera um valor correspondente à chave fornecida deste DbConnectionStringBuilder.

Implantações explícitas de interface

ICollection.CopyTo(Array, Int32)	Copia os elementos do ICollection para um Array, começando em um índice Array específico.
ICollection.IsSynchronized	Obtém um valor que indica se o acesso ao ICollection é sincronizado (thread safe).
ICollection.SyncRoot	Obtém um objeto que pode ser usado para sincronizar o acesso ao ICollection.
ICustomTypeDescriptor.GetAttributes()	Retorna uma coleção de atributos personalizados para esta instância de um componente.
ICustomTypeDescriptor.GetClassName()	Retorna o nome da classe dessa instância de um componente.
ICustomTypeDescriptor.GetComponentName()	Retorna o nome dessa instância de um componente.
ICustomTypeDescriptor.GetConverter()	Retorna um conversor de tipo para esta instância de um componente.
ICustomTypeDescriptor.GetDefaultEvent()	Retorna o evento padrão para esta instância de um componente.
ICustomTypeDescriptor.GetDefaultProperty()	Retorna a propriedade padrão para esta instância de um componente.
ICustomTypeDescriptor.GetEditor(Type)	Retorna um editor do tipo especificado para esta instância de um componente.
ICustomTypeDescriptor.GetEvents()	Retorna os eventos para esta instância de um componente.
ICustomTypeDescriptor.GetEvents(Attribute[])	Retorna os eventos dessa instância de um componente usando a matriz de atributo especificada como um filtro.
ICustomTypeDescriptor.GetProperties()	Retorna as propriedades dessa instância de um componente.
ICustomTypeDescriptor.GetProperties(Attribute[])	Retorna as propriedades dessa instância de um componente usando a matriz de atributos como um filtro.
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)	Retorna um objeto que contém a propriedade descrita pelo descritor de propriedade especificado.
IDictionary.Add(Object, Object)	Adiciona um elemento com a chave e o valor fornecidos ao objeto IDictionary.
IDictionary.Contains(Object)	Determina se o objeto IDictionary contém um elemento com a chave especificada.
IDictionary.GetEnumerator()	Retorna um objeto IDictionaryEnumerator para o objeto IDictionary.
IDictionary.Item[Object]	Obtém ou define o elemento com a chave especificada.
IDictionary.Remove(Object)	Remove o elemento com a chave especificada do objeto IDictionary.
IEnumerable.GetEnumerator()	Retorna um enumerador que itera por meio de uma coleção.

Métodos de Extensão

Cast<TResult>(IEnumerable)	Converte os elementos de um IEnumerable para o tipo especificado.
OfType<TResult>(IEnumerable)	Filtra os elementos de um IEnumerable com base em um tipo especificado.
AsParallel(IEnumerable)	Habilita a paralelização de uma consulta.
AsQueryable(IEnumerable)	Converte um IEnumerable em um IQueryable.

Confira também

• cadeias de conexão no ADO.NET
• visão geral ADO.NET