DbConnection DbConnection DbConnection DbConnection Class


Represents a connection to a database.

public ref class DbConnection abstract : System::ComponentModel::Component, IDisposable, System::Data::IDbConnection
public abstract class DbConnection : System.ComponentModel.Component, IDisposable, System.Data.IDbConnection
type DbConnection = class
    inherit Component
    interface IDbConnection
    interface IDisposable
Public MustInherit Class DbConnection
Inherits Component
Implements IDbConnection, IDisposable

Notes to Inheritors

When you inherit from DbConnection, you must override the following members: Close(), BeginDbTransaction(IsolationLevel), ChangeDatabase(String), CreateDbCommand(), Open(), and StateChange. You must also provide the following properties: ConnectionString, Database, DataSource, ServerVersion, and State.


DbConnection() DbConnection() DbConnection() DbConnection()

Initializes a new instance of the DbConnection class.


CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

Gets a value indicating whether the component can raise an event.

(Inherited from Component)
ConnectionString ConnectionString ConnectionString ConnectionString

Gets or sets the string used to open the connection.

ConnectionTimeout ConnectionTimeout ConnectionTimeout ConnectionTimeout

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

Container Container Container Container

Gets the IContainer that contains the Component.

(Inherited from Component)
Database Database Database Database

Gets the name of the current database after a connection is opened, or the database name specified in the connection string before the connection is opened.

DataSource DataSource DataSource DataSource

Gets the name of the database server to which to connect.

DbProviderFactory DbProviderFactory DbProviderFactory DbProviderFactory

Gets the DbProviderFactory for this DbConnection.

DesignMode DesignMode DesignMode DesignMode

Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
Events Events Events Events

Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
ServerVersion ServerVersion ServerVersion ServerVersion

Gets a string that represents the version of the server to which the object is connected.

Site Site Site Site

Gets or sets the ISite of the Component.

(Inherited from Component)
State State State State

Gets a string that describes the state of the connection.


BeginDbTransaction(IsolationLevel) BeginDbTransaction(IsolationLevel) BeginDbTransaction(IsolationLevel) BeginDbTransaction(IsolationLevel)

Starts a database transaction.

BeginTransaction() BeginTransaction() BeginTransaction() BeginTransaction()

Starts a database transaction.

BeginTransaction(IsolationLevel) BeginTransaction(IsolationLevel) BeginTransaction(IsolationLevel) BeginTransaction(IsolationLevel)

Starts a database transaction with the specified isolation level.

ChangeDatabase(String) ChangeDatabase(String) ChangeDatabase(String) ChangeDatabase(String)

Changes the current database for an open connection.

Close() Close() Close() Close()

Closes the connection to the database. This is the preferred method of closing any open connection.

CreateCommand() CreateCommand() CreateCommand() CreateCommand()

Creates and returns a DbCommand object associated with the current connection.

CreateDbCommand() CreateDbCommand() CreateDbCommand() CreateDbCommand()

Creates and returns a DbCommand object associated with the current connection.

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Dispose() Dispose() Dispose() Dispose()
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)
EnlistTransaction(Transaction) EnlistTransaction(Transaction) EnlistTransaction(Transaction) EnlistTransaction(Transaction)

Enlists in the specified transaction.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetSchema() GetSchema() GetSchema() GetSchema()

Returns schema information for the data source of this DbConnection.

GetSchema(String) GetSchema(String) GetSchema(String) GetSchema(String)

Returns schema information for the data source of this DbConnection using the specified string for the schema name.

GetSchema(String, String[]) GetSchema(String, String[]) GetSchema(String, String[]) GetSchema(String, String[])

Returns schema information for the data source of this DbConnection using the specified string for the schema name and the specified string array for the restriction values.

GetService(Type) GetService(Type) GetService(Type) GetService(Type)

Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
OnStateChange(StateChangeEventArgs) OnStateChange(StateChangeEventArgs) OnStateChange(StateChangeEventArgs) OnStateChange(StateChangeEventArgs)

Raises the StateChange event.

Open() Open() Open() Open()

Opens a database connection with the settings specified by the ConnectionString.

OpenAsync() OpenAsync() OpenAsync() OpenAsync()

An asynchronous version of Open(), which opens a database connection with the settings specified by the ConnectionString. This method invokes the virtual method OpenAsync(CancellationToken) with CancellationToken.None.

OpenAsync(CancellationToken) OpenAsync(CancellationToken) OpenAsync(CancellationToken) OpenAsync(CancellationToken)

This is the asynchronous version of Open(). Providers should override with an appropriate implementation. The cancellation token can optionally be honored.

The default implementation invokes the synchronous Open() call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by Open will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbConnection object until the returned Task is complete.

ToString() ToString() ToString() ToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.

(Inherited from Component)


Disposed Disposed Disposed Disposed

Occurs when the component is disposed by a call to the Dispose() method.

(Inherited from Component)
StateChange StateChange StateChange StateChange

Occurs when the state of the event changes.

Explicit Interface Implementations

IDbConnection.BeginTransaction() IDbConnection.BeginTransaction() IDbConnection.BeginTransaction() IDbConnection.BeginTransaction()

Begins a database transaction.

IDbConnection.BeginTransaction(IsolationLevel) IDbConnection.BeginTransaction(IsolationLevel) IDbConnection.BeginTransaction(IsolationLevel) IDbConnection.BeginTransaction(IsolationLevel)

Begins a database transaction with the specified IsolationLevel value.

IDbConnection.CreateCommand() IDbConnection.CreateCommand() IDbConnection.CreateCommand() IDbConnection.CreateCommand()

Creates and returns a DbCommand object that is associated with the current connection.

Applies to

See also