OdbcConnectionStringBuilder Clase

Definición

Espacio de nombres:

System.Data.Odbc

Ensamblado:

System.Data.Odbc.dll

Paquete:

System.Data.Odbc v11.0.0-preview.2.26159.112

Source:

OdbcConnectionStringbuilder.cs

Proporciona una manera sencilla de crear y administrar el contenido de las cadenas de conexión usadas por la OdbcConnection clase .

public ref class OdbcConnectionStringBuilder sealed : System::Data::Common::DbConnectionStringBuilder

public sealed class OdbcConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

type OdbcConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

Public NotInheritable Class OdbcConnectionStringBuilder
Inherits DbConnectionStringBuilder

Herencia

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

Ejemplos

La siguiente aplicación de consola compila cadenas de conexión para varias bases de datos ODBC. En primer lugar, en el ejemplo se crea una cadena de conexión para una base de datos de Microsoft Access. A continuación, crea una cadena de conexión para una base de datos IBM DB2. En el ejemplo también se analiza una cadena de conexión existente y se muestran varias formas de manipular el contenido de la cadena de conexión.

using System.Data.Odbc;

class Program
{
    static void Main()
    {
        OdbcConnectionStringBuilder builder = new()
            {
                Driver = "Microsoft Access Driver (*.mdb)"
            };

        // Call the Add method to explicitly add key/value
        // pairs to the internal collection.
        builder.Add("Dbq", "C:\\info.mdb");

        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();

        // Clear current values and reset known keys to their
        // default values.
        builder.Clear();

        // Pass the OdbcConnectionStringBuilder an existing
        // connection string, and you can retrieve and
        // modify any of the elements.
        builder.ConnectionString =
            "driver={IBM DB2 ODBC DRIVER};Database=SampleDB;" +
            "hostname=SampleServerName;port=SamplePortNum;" +
            "protocol=TCPIP";

        Console.WriteLine($"protocol = {builder["protocol"].ToString()}");
        Console.WriteLine();

        // Call the Remove method to remove items from
        // the collection of key/value pairs.
        builder.Remove("port");

        // Note that calling Remove on a nonexistent item does not
        // throw an exception.
        builder.Remove("BadItem");
        Console.WriteLine(builder.ConnectionString);
        Console.WriteLine();

        // Setting the indexer adds the associated value, if
        // necessary.
        builder["NewKey"] = "newValue";
        Console.WriteLine(builder.ConnectionString);
    }
}

Imports System.Data.Odbc

Module Module1
    Sub Main()
        Dim builder As New OdbcConnectionStringBuilder With {
            .Driver = "Microsoft Access Driver (*.mdb)"
        }

        ' Call the Add method to explicitly add key/value
        ' pairs to the internal collection.
        builder.Add("Dbq", "C:\info.mdb")

        Console.WriteLine(builder.ConnectionString)
        Console.WriteLine()

        ' Clear current values and reset known keys to their
        ' default values.
        builder.Clear()

        ' Pass the OdbcConnectionStringBuilder an existing
        ' connection string, and you can retrieve and
        ' modify any of the elements.
        builder.ConnectionString =
            "driver={IBM DB2 ODBC DRIVER};Database=SampleDB;" &
            "hostname=SampleServerName;port=SamplePortNum;" &
            "protocol=TCPIP"

        Console.WriteLine("protocol = " & builder("protocol").ToString())
        Console.WriteLine()

        ' Call the Remove method to remove items from
        ' the collection of key/value pairs.
        builder.Remove("port")

        ' Note that calling Remove on a nonexistent item does not
        ' throw an exception.
        builder.Remove("BadItem")
        Console.WriteLine(builder.ConnectionString)
        Console.WriteLine()

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

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

Comentarios

Los generadores de cadenas de conexión permiten a los desarrolladores crear mediante programación cadenas de conexión correctas sintácticamente y analizar y recompilar las cadenas de conexión existentes mediante propiedades y métodos de la clase . El generador de cadenas de conexión proporciona propiedades fuertemente tipadas correspondientes a los pares clave-valor conocidos permitidos por las conexiones ODBC, y los desarrolladores pueden agregar pares clave-valor arbitrarios para cualquier otro valor de cadena de conexión.

Los desarrolladores que necesitan crear cadenas de conexión como parte de las aplicaciones pueden usar la OdbcConnectionStringBuilder clase para compilar y modificar cadenas de conexión. La clase también facilita la administración de cadenas de conexión almacenadas en un archivo de configuración de aplicación. OdbcConnectionStringBuilder realiza comprobaciones solo para el conjunto limitado de pares clave-valor conocidos. Por lo tanto, esta clase se puede usar para crear cadenas de conexión no válidas. En la tabla siguiente se enumeran las claves conocidas específicas junto con sus propiedades correspondientes dentro de la OdbcConnectionStringBuilder clase y sus valores predeterminados. Además de estos valores específicos, los desarrolladores pueden agregar cualquier par clave-valor a la colección contenida en la OdbcConnectionStringBuilder instancia.

Key	Propiedad	Comentario	Valor predeterminado
Controlador	Driver	Los desarrolladores no deben incluir las llaves que rodean el nombre del controlador cuando establecen la Driver propiedad . La OdbcConnectionStringBuilder instancia agrega llaves según sea necesario.	Cadena vacía
DSN	Dsn		Cadena vacía

Si algún valor (distinto del Driver valor) de la cadena de conexión contiene un punto y coma (;), OdbcConnectionStringBuilder rodea el valor con comillas en la cadena de conexión. Para evitar este problema con el Driver valor que contiene con frecuencia un punto y coma, la OdbcConnectionStringBuilder clase siempre rodea este valor con llaves. La especificación ODBC indica que los valores de controlador que contienen punto y coma deben estar rodeados de llaves y esta clase lo controla.

La Item[] propiedad controla los intentos de insertar código malintencionado. Por ejemplo, el código siguiente, con la propiedad predeterminada Item[] (el indizador, en C#) escapa correctamente al par clave-valor anidado.

Dim builder As _
 New System.Data.Odbc.OdbcConnectionStringBuilder
' Take advantage of the Driver property.
builder.Driver = "SQL Server"
builder("Server") = "MyServer;NewValue=Bad"
Console.WriteLine(builder.ConnectionString)

System.Data.Odbc.OdbcConnectionStringBuilder builder =
  new System.Data.Odbc.OdbcConnectionStringBuilder();
// Take advantage of the Driver property.
builder.Driver = "SQL Server";
builder["Server"] = "MyServer;NewValue=Bad";
Console.WriteLine(builder.ConnectionString);

El resultado es la siguiente cadena de conexión que controla el valor no válido de forma segura:

Driver={SQL Server};Server="MyServer;NewValue=Bad"

Constructores

Nombre	Description
OdbcConnectionStringBuilder()	Inicializa una nueva instancia de la clase OdbcConnectionStringBuilder.
OdbcConnectionStringBuilder(String)	Inicializa una nueva instancia de la clase OdbcConnectionStringBuilder. La cadena de conexión proporcionada proporciona los datos para la información de conexión interna de la instancia.

Propiedades

Nombre	Description
Driver	Obtiene o establece el nombre del controlador ODBC asociado a la conexión.
Dsn	Obtiene o establece el nombre del nombre del origen de datos (DSN) asociado a la conexión.
Item[String]	Obtiene o establece el valor asociado a la clave especificada. En C#, esta propiedad es el indexador.
Keys	Obtiene un ICollection objeto que contiene las claves de .OdbcConnectionStringBuilder

Métodos

Nombre	Description
Clear()	Borra el contenido de la OdbcConnectionStringBuilder instancia.
ContainsKey(String)	Determina si contiene OdbcConnectionStringBuilder una clave específica.
Remove(String)	Quita la entrada con la clave especificada de la OdbcConnectionStringBuilder instancia.
TryGetValue(String, Object)	Recupera un valor correspondiente a la clave proporcionada de este OdbcConnectionStringBuilder.

Consulte también

• Generadores de cadenas de conexión
• Cadenas de conexión de ADO.NET