3 out of 6 rated this helpful - Rate this topic

OleDbConnection Class

Represents an open connection to a data source.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Data.Common.DbConnection
        System.Data.OleDb.OleDbConnection

Namespace:  System.Data.OleDb
Assembly:  System.Data (in System.Data.dll)
public sealed class OleDbConnection : DbConnection, 
	ICloneable, IDbConnection, IDisposable

The OleDbConnection type exposes the following members.

  Name Description
Public method OleDbConnection() Initializes a new instance of the OleDbConnection class.
Public method OleDbConnection(String) Initializes a new instance of the OleDbConnection class with the specified connection string.
Top
  Name Description
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property ConnectionString Gets or sets the string used to open a database. (Overrides DbConnection.ConnectionString.)
Public property ConnectionTimeout Gets the time to wait while trying to establish a connection before terminating the attempt and generating an error. (Overrides DbConnection.ConnectionTimeout.)
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Public property Database Gets the name of the current database or the database to be used after a connection is opened. (Overrides DbConnection.Database.)
Public property DataSource Gets the server name or file name of the data source. (Overrides DbConnection.DataSource.)
Protected property DbProviderFactory Gets the DbProviderFactory for this DbConnection. (Inherited from DbConnection.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property Provider Gets the name of the OLE DB provider specified in the "Provider= " clause of the connection string.
Public property ServerVersion Gets a string that contains the version of the server to which the client is connected. (Overrides DbConnection.ServerVersion.)
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property State Gets the current state of the connection. (Overrides DbConnection.State.)
Top
  Name Description
Protected method BeginDbTransaction Starts a database transaction. (Inherited from DbConnection.)
Public method BeginTransaction() Starts a database transaction with the current IsolationLevel value.
Public method BeginTransaction(IsolationLevel) Starts a database transaction with the specified isolation level.
Public method ChangeDatabase Changes the current database for an open OleDbConnection. (Overrides DbConnection.ChangeDatabase(String).)
Public method Close Closes the connection to the data source. (Overrides DbConnection.Close().)
Public method CreateCommand Creates and returns an OleDbCommand object associated with the OleDbConnection.
Protected method CreateDbCommand Creates and returns a DbCommand object associated with the current connection. (Inherited from DbConnection.)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public method EnlistDistributedTransaction Enlists in the specified transaction as a distributed transaction.
Public method EnlistTransaction Enlists in the specified transaction as a distributed transaction. (Overrides DbConnection.EnlistTransaction(Transaction).)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetOleDbSchemaTable Returns schema information from a data source as indicated by a GUID, and after it applies the specified restrictions.
Public method GetSchema() Returns schema information for the data source of this OleDbConnection. (Overrides DbConnection.GetSchema().)
Public method GetSchema(String) Returns schema information for the data source of this OleDbConnection using the specified string for the schema name. (Overrides DbConnection.GetSchema(String).)
Public method GetSchema(String, String[]) Returns schema information for the data source of this OleDbConnection using the specified string for the schema name and the specified string array for the restriction values. (Overrides DbConnection.GetSchema(String, String[]).)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method OnStateChange Raises the StateChange event. (Inherited from DbConnection.)
Public method Open Opens a database connection with the property settings specified by the ConnectionString. (Overrides DbConnection.Open().)
Public method Static member ReleaseObjectPool Indicates that the OleDbConnection object pool can be released when the last underlying connection is released.
Public method ResetState Updates the State property of the OleDbConnection object.
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Top
  Name Description
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public event InfoMessage Occurs when the provider sends a warning or an informational message.
Public event StateChange Occurs when the state of the event changes. (Inherited from DbConnection.)
Top
  Name Description
Explicit interface implemetation Private method ICloneable.Clone For a description of this member, see ICloneable.Clone.
Explicit interface implemetation Private method IDbConnection.BeginTransaction() Begins a database transaction. (Inherited from DbConnection.)
Explicit interface implemetation Private method IDbConnection.BeginTransaction(IsolationLevel) Begins a database transaction with the specified IsolationLevel value. (Inherited from DbConnection.)
Explicit interface implemetation Private method IDbConnection.CreateCommand Creates and returns a DbCommand object that is associated with the current connection. (Inherited from DbConnection.)
Top

An OleDbConnection object represents a unique connection to a data source. With a client/server database system, it is equivalent to a network connection to the server. Depending on the functionality supported by the native OLE DB provider, some methods or properties of an OleDbConnection object may not be available.

When you create an instance of OleDbConnection, all properties are set to their initial values. For a list of these values, see the OleDbConnection constructor.

You can open more than one DataReader on a single OleDbConnection. If the OLE DB provider you use does not support more than one DataReader on a single connection, the provider implicitly opens an additional connection for each.

If the OleDbConnection goes out of scope, it is not closed. Therefore, you must explicitly close the connection by calling Close or Dispose, or by using the OleDbConnection object within a Using statement.

Note Note

To deploy high-performance applications, you must use connection pooling. When you use the .NET Framework Data Provider for OLE DB, you do not have to enable connection pooling because the provider manages this automatically. For more information about how to use connection pooling with the .NET Framework Data Provider for OLE DB, see OLE DB, ODBC, and Oracle Connection Pooling (ADO.NET).

If a fatal OleDbException (for example, a SQL Server severity level of 20 or greater) is generated by the method executing an OleDbCommand, the OleDbConnection might be closed. However, the user can reopen the connection and continue.

An application that creates an instance of the OleDbConnection object can require all direct and indirect callers to have sufficient permission to the code by setting declarative or imperative security demands. OleDbConnection makes security demands using the OleDbPermission object. Users can verify that their code has sufficient permissions by using the OleDbPermissionAttribute object. Users and administrators can also use the Caspol.exe (Code Access Security Policy Tool) to modify security policy at the computer, user, and enterprise levels. For more information, see Code Access Security and ADO.NET.

For more information about handling warning and informational messages from the data server, see Connection Events (ADO.NET).

Note Note

The OleDbConnection object does not support setting or retrieving dynamic properties specific to an OLE DB provider. Only properties that can be passed in the connection string for the OLE DB provider are supported.

The following example creates an OleDbCommand and an OleDbConnection. The OleDbConnection is opened and set as the Connection for the OleDbCommand. The example then calls ExecuteNonQuery and closes the connection. To accomplish this, ExecuteNonQuery is passed a connection string and a query string that is an SQL INSERT statement.


public void InsertRow(string connectionString, string insertSQL)
{
    using (OleDbConnection connection = new OleDbConnection(connectionString))
    {
        // The insertSQL string contains a SQL statement that
        // inserts a new row in the source table.
        OleDbCommand command = new OleDbCommand(insertSQL);

        // Set the Connection to the new OleDbConnection.
        command.Connection = connection;

        // Open the connection and execute the insert command.
        try
        {
            connection.Open();
            command.ExecuteNonQuery();
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
        // The connection is automatically closed when the
        // code exits the using block.
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ