IDbConnection Interface

 

Represents an open connection to a data source, and is implemented by .NET Framework data providers that access relational databases.

Namespace:   System.Data
Assembly:  System.Data (in System.Data.dll)

type IDbConnection = 
    interface
        interface IDisposable
    end

NameDescription
System_CAPS_pubpropertyConnectionString

Gets or sets the string used to open a database.

System_CAPS_pubpropertyConnectionTimeout

Gets the time to wait while trying to establish a connection before terminating the attempt and generating an error.

System_CAPS_pubpropertyDatabase

Gets the name of the current database or the database to be used after a connection is opened.

System_CAPS_pubpropertyState

Gets the current state of the connection.

NameDescription
System_CAPS_pubmethodBeginTransaction()

Begins a database transaction.

System_CAPS_pubmethodBeginTransaction(IsolationLevel)

Begins a database transaction with the specified IsolationLevel value.

System_CAPS_pubmethodChangeDatabase(String)

Changes the current database for an open Connection object.

System_CAPS_pubmethodClose()

Closes the connection to the database.

System_CAPS_pubmethodCreateCommand()

Creates and returns a Command object associated with the connection.

System_CAPS_pubmethodDispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.(Inherited from IDisposable.)

System_CAPS_pubmethodOpen()

Opens a database connection with the settings specified by the ConnectionString property of the provider-specific Connection object.

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 a Data Source in ADO.NET.

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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show: