IDbConnection Interface
Assembly: System.Data (in system.data.dll)
The IDbConnection interface enables an inheriting class to implement a Connection class, which represents a unique session with a data source (for example, a network connection to a server). For more information about Connection classes, see Connecting to Data Sources. For more information about implementing .NET Framework data providers, see Implementing a .NET Framework Data Provider.
An application does not create an instance of the IDbConnection interface directly, but creates an instance of a class that inherits IDbConnection.
Classes that inherit IDbConnection must implement all inherited members, and typically define additional members to add provider-specific functionality. For example, the IDbConnection interface defines the ConnectionTimeout property. In turn, the SqlConnection class inherits this property, and also defines the PacketSize property.
Notes to Implementers To promote consistency among .NET Framework data providers, name the inheriting class in the form PrvClassname where Prv is the uniform prefix given to all classes in a specific .NET Framework data provider namespace. For example, Sql is the prefix of the SqlConnection class in the System.Data.SqlClient namespace. When you inherit from the IDbConnection interface, you should implement the following constructors:| Item | Description |
|---|---|
| PrvConnection() | Initializes a new instance of the PrvConnection class. |
| PrvConnection(string connectionString) | Initializes a new instance of the PrvConnection class when given a string containing the connection string. |
The following example creates instances of the derived classes, SqlCommand and SqlConnection. The SqlConnection is opened and set as the Connection for the SqlCommand. The example then calls ExecuteNonQuery, and closes the connection. To accomplish this, the ExecuteNonQuery is passed a connection string and a query string that is a Transact-SQL INSERT statement.
Private Sub OpenSqlConnection() Dim connectionString As String = GetConnectionString() Using connection As New SqlConnection(connectionString) connection.Open() Console.WriteLine("ServerVersion: {0", connection.ServerVersion) Console.WriteLine("State: {0", connection.State) End Using End Sub Private Function GetConnectionString() As String ' To avoid storing the connection string in your code, ' you can retrieve it from a configuration file, using the ' System.Configuration.ConfigurationSettings.AppSettings property Return "Data Source=(local);Database=AdventureWorks;" _ & "Integrated Security=SSPI;" End Function
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.