System.Data.OleDB

The System.Data.OleDb namespace is the.NET Framework Data Provider for OLE DB.

OleDbConnectionStringBuilder Class

Definition

Namespace:

System.Data.OleDb

Assemblies:

System.Data.dll, System.Data.OleDb.dll

Provides a simple way to create and manage the contents of connection strings used by the OleDbConnection class.

In this article

1. Definition
2. Examples
3. Remarks
4. Constructors
5. Properties
6. Methods
7. Explicit Interface Implementations
8. Extension Methods
9. Applies to
10. See also

[System.ComponentModel.TypeConverter(typeof(System.Data.OleDb.OleDbConnectionStringBuilder/OleDbConnectionStringBuilderConverter))]
public sealed class OleDbConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

Inheritance

Object DbConnectionStringBuilder OleDbConnectionStringBuilder

Attributes

TypeConverterAttribute

Examples

The following console application builds connection strings for several OLE DB databases. First, the example creates a connection string for a Microsoft Access database, and then creates a connection string for an IBM DB2 database. The example also parses an existing connection string, and demonstrates various ways of manipulating the connection string's contents.

Note

This example includes a password to demonstrate how OleDbConnectionStringBuilder works with connection strings. In your applications, we recommend that you use Windows Authentication. If you must use a password, do not include a hard-coded password in your application.

using System.Data.OleDb;

class Program
{
    static void Main(string[] args)
    {
        OleDbConnectionStringBuilder builder = new OleDbConnectionStringBuilder();
        builder.ConnectionString = @"Data Source=C:\Sample.mdb";

        // Call the Add method to explicitly add key/value
        // pairs to the internal collection.
        builder.Add("Provider", "Microsoft.Jet.Oledb.4.0");
        builder.Add("Jet OLEDB:Database Password", "MyPassword!");
        builder.Add("Jet OLEDB:System Database", @"C:\Workgroup.mdb");

        // Set up row-level locking.
        builder.Add("Jet OLEDB:Database Locking Mode", 1);

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

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

        // Pass the OleDbConnectionStringBuilder an existing 
        // connection string, and you can retrieve and
        // modify any of the elements.
        builder.ConnectionString =
            "Provider=DB2OLEDB;Network Transport Library=TCPIP;" +
            "Network Address=192.168.0.12;Initial Catalog=DbAdventures;" +
            "Package Collection=SamplePackage;Default Schema=SampleSchema;";

        Console.WriteLine("Network Address = " + builder["Network Address"].ToString());
        Console.WriteLine();

        // Modify existing items.
        builder["Package Collection"] = "NewPackage";
        builder["Default Schema"] = "NewSchema";

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

        // 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 value, if 
        // necessary.
        builder["User ID"] = "SampleUser";
        builder["Password"] = "SamplePassword";
        Console.WriteLine(builder.ConnectionString);

        Console.WriteLine("Press Enter to finish.");
        Console.ReadLine();
    }
}

Remarks

The connection string builder lets developers programmatically create syntactically correct connection strings, and parse and rebuild existing connection strings, using properties and methods of the class. The connection string builder provides strongly typed properties corresponding to the known key/value pairs allowed by OLE DB connections, and developers can add arbitrary key/value pairs for any other connection string values. The OleDbConnectionStringBuilder class implements the ICustomTypeDescriptor interface. This means that the class works with Visual Studio .NET designers at design time. When developers use the designer to build strongly typed DataSets and strongly typed connections within Visual Studio .NET, the strongly typed connection string builder class will display the properties associated with its type and will also have converters that can map common values for known keys.

Developers needing to create connection strings as part of applications can use the OleDbConnectionStringBuilder class to build and modify connection strings. The class also makes it easy to manage connection strings stored in an application configuration file. The OleDbConnectionStringBuilder performs checks only for the limited set of known key/value pairs. Therefore, this class can be used to create invalid connection strings. The following table lists the known keys and their corresponding properties within the OleDbConnectionStringBuilder class, and their default values. Besides these specific values, developers can add any key/value pairs to the collection that is contained within the OleDbConnectionStringBuilder instance:

The Item[String] property handles attempts to insert malicious entries. For example, the following code, using the default Item[String] property (the indexer, in C#) correctly escapes the nested key/value pair:

System.Data.OleDb.OleDbConnectionStringBuilder builder =   
    new System.Data.OleDb.OleDbConnectionStringBuilder();  
builder["Provider"] = "Microsoft.Jet.OLEDB.4.0";  
builder["Data Source"] = "C:\\Sample.mdb";  
builder["User Id"] = "Admin;NewValue=Bad";  

The result is the following connection string that handles the invalid value in a safe manner:

Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Sample.mdb;User ID="Admin;NewValue=Bad"  

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to

.NET Core

.NET Framework

.NET Platform Extensions

Xamarin.Mac

See also

• Building Connection Strings
• Working with Connection Strings

Examples

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
       <title>Sample Page</title>
       <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
       <script runat="server" >
           Sub Page_Load()
               Dim xstr As String
               Dim xconn As System.Data.OleDb.OleDbConnection = new System.Data.OleDb.OleDbConnection()
               Dim xconnstrb As System.Data.OleDb.OleDbConnectionStringBuilder = new System.Data.OleDb.OleDbConnectionStringBuilder()
               xstr = xstr + "Declare OleDbConnectionStringBuilder: xconnstrb<br />"
               xconnstrb.ConnectionString = "Data Source=T:\test.mdb"
               xstr = xstr + "->Assign xconnstrb.connectionstring: " + xconnstrb.ConnectionString + "<br />"
               xconnstrb.Provider = "Microsoft.ACE.OLEDB.12.0"
               xstr = xstr + "->Assign xconnstrb.provider: " + xconnstrb.ConnectionString + "<br />"
               xconnstrb.Add("User Id", "admin")
               xstr = xstr + "->Add xconnstrb.Add(user id): " + xconnstrb.ConnectionString + "<br />"
               xconnstrb.Add("Password", "admin")
               xstr = xstr + "->Add xconnstrb.Add(password): " + xconnstrb.ConnectionString + "<br />"
               xconnstrb.Remove("Password")
               xstr = xstr + "->xconnstrb.Remove Password: " + xconnstrb.ConnectionString + "<br />"
               xconnstrb.Item("Password")=""
               xstr = xstr + "->xconnstrb.item(Password): " + xconnstrb.ConnectionString + "<br />"
               
               xconn.ConnectionString = xconnstrb.ConnectionString
               xstr = xstr + "Assign xconnstrb.ConnectionString to xconn.ConnectionString  <br />"
               xconnstrb.clear()
               xstr = xstr + "xconnstrb is cleared<br />"
               xstr = xstr + "OleDbConnectionStringBuilder: " + xconnstrb.ConnectionString + "<br />"
               xconn.Open()
               xstr = xstr + "Database test.mdb connection is opened successfully.<br />"
               xconn.Close()
               xstr = xstr + "Database test.mdb connection is closed successfully.<br />"
               xconn.Dispose()
               xstr = xstr + "Database test.mdb connection is disposed successfully."
               lbl01.Text = xstr
           End Sub
       </script>
    </head>
    <body>
<%Response.Write("<p>Results on "& Request.ServerVariables("SERVER_SOFTWARE") & " .net: " & System.Environment.Version.ToString & " " & ScriptEngine & " Version " & ScriptEngineMajorVersion & "." & ScriptEngineMinorVersion & "</p>")%>
       <% Response.Write ("<h1>This is a Sample Page of OleDbConnectionStringBuilder Class</h1>") %>
       <p>
           <%-- Set on Page_Load --%>
           <asp:Label id="lbl01" runat="server" />
       </p>
    </body>
</html>

Source/Reference

• https://docs.microsoft.com/en-us/dotnet/api/system.data.oledb.oledbconnectionstringbuilder?view=netframework-4.8