OdbcConnectionStringBuilder Třída

Definice

Obor názvů:

System.Data.Odbc

Sestavení:

System.Data.Odbc.dll

Balíček:

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

Zdroj:

OdbcConnectionStringbuilder.cs

Poskytuje jednoduchý způsob, jak vytvořit a spravovat obsah připojovacích řetězců používaných OdbcConnection třídou.

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

Dědičnost

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

Příklady

Následující konzolová aplikace sestaví připojovací řetězce pro několik databází ODBC. Nejprve příklad vytvoří připojovací řetězec pro databázi Microsoft Accessu. Potom vytvoří připojovací řetězec pro databázi IBM DB2. Příklad také analyzuje existující připojovací řetězec a ukazuje různé způsoby manipulace s obsahem připojovacího řetězce.

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

Poznámky

Tvůrci připojovacích řetězců umožňují vývojářům programově vytvářet syntakticky správné připojovací řetězce a parsovat a znovu sestavovat existující připojovací řetězce pomocí vlastností a metod třídy. Tvůrce připojovacích řetězců poskytuje vlastnosti silného typu odpovídající známým párům klíč/hodnota povolených připojeními ODBC a vývojáři mohou přidat libovolné páry klíč/hodnota pro všechny ostatní hodnoty připojovacího řetězce.

Vývojáři, kteří potřebují vytvářet připojovací řetězce v rámci aplikací, můžou pomocí OdbcConnectionStringBuilder třídy vytvářet a upravovat připojovací řetězce. Třída také usnadňuje správu připojovacích řetězců uložených v konfiguračním souboru aplikace. OdbcConnectionStringBuilder provádí kontroly pouze pro omezenou sadu známých párů klíč/hodnota. Proto lze tuto třídu použít k vytvoření neplatných připojovacích řetězců. Následující tabulka uvádí konkrétní známé klíče společně s odpovídajícími vlastnostmi v rámci OdbcConnectionStringBuilder třídy a jejich výchozí hodnoty. Kromě těchto konkrétních hodnot můžou vývojáři do kolekce obsažené v OdbcConnectionStringBuilder instanci přidat libovolné páry klíč/hodnota.

Klíč	Vlastnictví	Komentář	Výchozí hodnota
Driver	Driver	Vývojáři by při nastavování Driver vlastnosti neměli obsahovat složené závorky kolem názvu ovladače. Instance OdbcConnectionStringBuilder podle potřeby přidá složené závorky.	Prázdný řetězec
DSN	Dsn		Prázdný řetězec

Pokud některá hodnota (kromě Driver hodnoty) v připojovacím řetězci obsahuje středník (;), OdbcConnectionStringBuilder ohraničí hodnotu uvozovkami v připojovacím řetězci. Aby se zabránilo tomuto problému s Driver hodnotou, která často obsahuje středník, OdbcConnectionStringBuilder třída tuto hodnotu vždy obklopuje složenými závorkami. Specifikace ODBC označuje, že hodnoty ovladačů, které obsahují středníky, musí být obklopeny složenými závorkami a tato třída to za vás zpracovává.

Vlastnost Item[] zpracovává pokusy o vložení škodlivého kódu. Například následující kód pomocí výchozí Item[] vlastnosti (indexer v jazyce C#) správně unikne dvojici vnořených klíč/hodnota.

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

Výsledkem je následující připojovací řetězec, který bezpečně zpracovává neplatnou hodnotu:

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

Konstruktory

Name	Description
OdbcConnectionStringBuilder()	Inicializuje novou instanci OdbcConnectionStringBuilder třídy.
OdbcConnectionStringBuilder(String)	Inicializuje novou instanci OdbcConnectionStringBuilder třídy. Zadaný připojovací řetězec poskytuje data pro interní informace o připojení instance.

Vlastnosti

Name	Description
Driver	Získá nebo nastaví název ovladače ODBC přidruženého k připojení.
Dsn	Získá nebo nastaví název názvu zdroje dat (DSN) přidruženého k připojení.
Item[String]	Získá nebo nastaví hodnotu přidruženou k zadanému klíči. V jazyce C# je tato vlastnost indexerem.
Keys	ICollection Získá, který obsahuje klíče v objektu OdbcConnectionStringBuilder.

Metody

Name	Description
Clear()	Vymaže obsah OdbcConnectionStringBuilder instance.
ContainsKey(String)	Určuje, zda OdbcConnectionStringBuilder obsahuje konkrétní klíč.
Remove(String)	Odebere položku se zadaným klíčem z OdbcConnectionStringBuilder instance.
TryGetValue(String, Object)	Načte z tohoto OdbcConnectionStringBuilderklíče hodnotu odpovídající zadanému klíči .

Viz také

• Sestavovače připojovacích řetězců
• Připojovací řetězce v ADO.NET