IDbConnection Interface

Overview

Represents a generic connection to a database. This interface is implemented by classes that provide database connectivity for ADO.NET.

The IDbConnection interface is the base interface for all ADO.NET connection objects. It defines the core properties and methods required to establish and manage a connection to a database. Implementations of this interface provide specific connection logic for different database systems (e.g., SQL Server, Oracle, MySQL).

Key functionalities include:

• Establishing a connection to a data source.
• Managing the connection state (open, closed).
• Creating command objects.
• Opening and closing the connection.
• Handling connection strings and other parameters.

Related Interfaces

• IDbCommand
• IDbTransaction
• IDataReader

Syntax

public interface IDbConnection : IDisposable

public interface IDbConnection : IDisposable
{
    // Properties
    string ConnectionString { get; set; }
    int ConnectionTimeout { get; }
    string Database { get; }
    ConnectionState State { get; }

    // Methods
    IDbTransaction BeginTransaction();
    IDbTransaction BeginTransaction(IsolationLevel isolationLevel);
    void ChangeDatabase(string databaseName);
    void Close();
    IDbCommand CreateCommand();
    void Open();
}
                

Members

Properties

• ConnectionString string ConnectionString { get; set; }

  Gets or sets the connection string used to open the connection.

• ConnectionTimeout int ConnectionTimeout { get; }

  Gets the time in seconds to wait while trying to establish a connection before the attempt times out.

• Database string Database { get; }

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

• State ConnectionState State { get; }

  Gets a value indicating the status of the connection.

Methods

• BeginTransaction IDbTransaction BeginTransaction()

  Starts a database transaction.

• BeginTransaction(IsolationLevel isolationLevel) IDbTransaction BeginTransaction(IsolationLevel isolationLevel)

  Starts a database transaction with the specified isolation level.

• ChangeDatabase(string databaseName) void ChangeDatabase(string databaseName)

  Changes the current database for the connection with the specified name.

• Close() void Close()

  Closes the connection to the data source.

• CreateCommand() IDbCommand CreateCommand()

  Creates and returns an IDbCommand object associated with the connection.

• Open() void Open()

  Opens a database connection with the properties and password specified by the ConnectionString property of the connected data source.

Implemented Members

This interface inherits members from the System.IDisposable interface.

• Dispose() void Dispose()

  Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Requirements