OdbcConnectionStringBuilder Classe

Définition

Espace de noms:

System.Data.Odbc

Assembly:

System.Data.Odbc.dll

Paquet:

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

Source:

OdbcConnectionStringbuilder.cs

Fournit un moyen simple de créer et de gérer le contenu des chaînes de connexion utilisées par la OdbcConnection classe.

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

Héritage

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

Exemples

L’application console suivante génère des chaînes de connexion pour plusieurs bases de données ODBC. Tout d’abord, l’exemple crée une chaîne de connexion pour une base de données Microsoft Access. Il crée ensuite une chaîne de connexion pour une base de données IBM DB2. L’exemple analyse également une chaîne de connexion existante et montre différentes façons de manipuler le contenu de la chaîne de connexion.

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

Remarques

Les générateurs de chaînes de connexion permettent aux développeurs de créer par programmation des chaînes de connexion correctes par programmation, d’analyser et de reconstruire des chaînes de connexion existantes, à l’aide de propriétés et de méthodes de la classe. Le générateur de chaînes de connexion fournit des propriétés fortement typées correspondant aux paires clé/valeur connues autorisées par les connexions ODBC, et les développeurs peuvent ajouter des paires clé/valeur arbitraires pour toutes les autres valeurs de chaîne de connexion.

Les développeurs qui ont besoin de créer des chaînes de connexion dans le cadre d’applications peuvent utiliser la OdbcConnectionStringBuilder classe pour générer et modifier des chaînes de connexion. La classe facilite également la gestion des chaînes de connexion stockées dans un fichier de configuration d’application. OdbcConnectionStringBuilder effectue des vérifications uniquement pour l’ensemble limité de paires clé/valeur connues. Par conséquent, cette classe peut être utilisée pour créer des chaînes de connexion non valides. Le tableau suivant répertorie les clés connues spécifiques ainsi que leurs propriétés correspondantes dans la OdbcConnectionStringBuilder classe et leurs valeurs par défaut. Outre ces valeurs spécifiques, les développeurs peuvent ajouter toutes les paires clé/valeur à la collection contenue dans l’instance OdbcConnectionStringBuilder .

Clé	Propriété	Commentaire	Valeur par défaut
Chauffeur	Driver	Les développeurs ne doivent pas inclure les accolades entourant le nom du pilote lorsqu’ils définissent la Driver propriété. L’instance OdbcConnectionStringBuilder ajoute des accolades si nécessaire.	Chaîne vide
DSN	Dsn		Chaîne vide

Si une valeur (autre que la Driver valeur) dans la chaîne de connexion contient un point-virgule (;), la OdbcConnectionStringBuilder valeur entoure la valeur avec des guillemets dans la chaîne de connexion. Pour éviter ce problème avec la Driver valeur qui contient fréquemment un point-virgule, la OdbcConnectionStringBuilder classe entoure toujours cette valeur avec des accolades. La spécification ODBC indique que les valeurs de pilote qui contiennent des points-virgules doivent être entourées d’accolades et que cette classe gère cela pour vous.

La Item[] propriété gère les tentatives d’insertion de code malveillant. Par exemple, le code suivant, à l’aide de la propriété par défaut Item[] (l’indexeur, en C#) échappe correctement la paire clé/valeur imbriquée.

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

Le résultat est la chaîne de connexion suivante qui gère la valeur non valide de manière sécurisée :

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

Constructeurs

Nom	Description
OdbcConnectionStringBuilder()	Initialise une nouvelle instance de la classe OdbcConnectionStringBuilder.
OdbcConnectionStringBuilder(String)	Initialise une nouvelle instance de la classe OdbcConnectionStringBuilder. La chaîne de connexion fournie fournit les données des informations de connexion internes de l’instance.

Propriétés

Nom	Description
Driver	Obtient ou définit le nom du pilote ODBC associé à la connexion.
Dsn	Obtient ou définit le nom du nom de la source de données (DSN) associé à la connexion.
Item[String]	Obtient ou définit la valeur associée à la clé spécifiée. En C#, cette propriété est l’indexeur.
Keys	Obtient un ICollection qui contient les clés dans le OdbcConnectionStringBuilder.

Méthodes

Nom	Description
Clear()	Efface le contenu de l’instance OdbcConnectionStringBuilder .
ContainsKey(String)	Détermine si le OdbcConnectionStringBuilder conteneur contient une clé spécifique.
Remove(String)	Supprime l’entrée avec la clé spécifiée de l’instance OdbcConnectionStringBuilder .
TryGetValue(String, Object)	Récupère une valeur correspondant à la clé fournie à partir de ce OdbcConnectionStringBuilder.

Voir aussi

• Générateurs de chaînes de connexion
• Chaînes de connexion dans ADO.NET