OdbcConnectionStringBuilder Kelas

Definisi

Ruang nama:

System.Data.Odbc

Rakitan:

System.Data.Odbc.dll

Paket:

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

Sumber:

OdbcConnectionStringbuilder.cs

Menyediakan cara sederhana untuk membuat dan mengelola konten string koneksi yang digunakan oleh OdbcConnection kelas.

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

Warisan

Object

DbConnectionStringBuilder

OdbcConnectionStringBuilder

Contoh

Aplikasi konsol berikut membangun string koneksi untuk beberapa database ODBC. Pertama, contoh membuat string koneksi untuk database Microsoft Access. Kemudian membuat string koneksi untuk database IBM DB2. Contoh ini juga mengurai string koneksi yang ada, dan menunjukkan berbagai cara untuk memanipulasi konten string koneksi.

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

Keterangan

Penyusun string koneksi memungkinkan pengembang secara terprogram membuat string koneksi yang benar secara sinonis, dan mengurai dan membangun kembali string koneksi yang ada, menggunakan properti dan metode kelas. Penyusun string koneksi menyediakan properti yang sangat ditik yang sesuai dengan pasangan kunci/nilai yang diketahui yang diizinkan oleh koneksi ODBC, dan pengembang dapat menambahkan pasangan kunci/nilai arbitrer untuk nilai string koneksi lainnya.

Pengembang perlu membuat string koneksi sebagai bagian dari aplikasi dapat menggunakan OdbcConnectionStringBuilder kelas untuk membangun dan memodifikasi string koneksi. Kelas ini juga memudahkan untuk mengelola string koneksi yang disimpan dalam file konfigurasi aplikasi. OdbcConnectionStringBuilder melakukan pemeriksaan hanya untuk sekumpulan terbatas pasangan kunci/nilai yang diketahui. Oleh karena itu, kelas ini dapat digunakan untuk membuat string koneksi yang tidak valid. Tabel berikut mencantumkan kunci tertentu yang diketahui bersama dengan properti terkait dalam OdbcConnectionStringBuilder kelas, dan nilai defaultnya. Selain nilai spesifik ini, pengembang dapat menambahkan pasangan kunci/nilai apa pun ke koleksi yang terkandung dalam OdbcConnectionStringBuilder instans.

Kunci	Harta benda	Comment	Nilai standar
Driver	Driver	Pengembang tidak boleh menyertakan kurung kurawal yang mengelilingi nama driver saat mereka mengatur Driver properti. OdbcConnectionStringBuilder Instans menambahkan kurung kurawal sesuai kebutuhan.	String kosong
DSN	Dsn		String kosong

Jika ada nilai (selain Driver nilai) dalam string koneksi berisi titik koma (;), nilai OdbcConnectionStringBuilder dikelilingi dengan tanda kutip dalam string koneksi. Untuk menghindari masalah ini dengan Driver nilai yang sering berisi titik koma, OdbcConnectionStringBuilder kelas selalu mengelilingi nilai ini dengan kurung kurawal. Spesifikasi ODBC menunjukkan bahwa nilai driver yang berisi titik koma harus dikelilingi dengan kurung kurawal, dan kelas ini menanganinya untuk Anda.

Properti Item[] menangani upaya untuk menyisipkan kode berbahaya. Misalnya, kode berikut, menggunakan properti default Item[] (pengindeks, di C#) dengan benar lolos dari pasangan kunci/nilai berlapis.

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

Hasilnya adalah string koneksi berikut yang menangani nilai yang tidak valid dengan cara yang aman:

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

Konstruktor

Nama	Deskripsi
OdbcConnectionStringBuilder()	Menginisialisasi instans baru dari kelas OdbcConnectionStringBuilder.
OdbcConnectionStringBuilder(String)	Menginisialisasi instans baru dari kelas OdbcConnectionStringBuilder. String koneksi yang disediakan menyediakan data untuk informasi koneksi internal instans.

Properti

Nama	Deskripsi
Driver	Mendapatkan atau mengatur nama driver ODBC yang terkait dengan koneksi.
Dsn	Mendapatkan atau mengatur nama nama sumber data (DSN) yang terkait dengan koneksi.
Item[String]	Mendapatkan atau mengatur nilai yang terkait dengan kunci yang ditentukan. Di C#, properti ini adalah pengindeks.
Keys	Mendapatkan yang ICollection berisi kunci di OdbcConnectionStringBuilder.

Metode

Nama	Deskripsi
Clear()	Menghapus konten instans OdbcConnectionStringBuilder .
ContainsKey(String)	Menentukan apakah OdbcConnectionStringBuilder berisi kunci tertentu.
Remove(String)	Menghapus entri dengan kunci yang ditentukan dari OdbcConnectionStringBuilder instans.
TryGetValue(String, Object)	Mengambil nilai yang sesuai dengan kunci yang disediakan dari ini OdbcConnectionStringBuilder.

Lihat juga

• Pembuat String Koneksi
• String Koneksi dalam ADO.NET