OdbcConnection Class
 

Represents an open connection to a data source.

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

SystemObject
   SystemMarshalByRefObject
     System.ComponentModelComponent
       System.Data.CommonDbConnection
        System.Data.OdbcOdbcConnection

public sealed class OdbcConnection : DbConnection, ICloneable
public ref class OdbcConnection sealed : DbConnection, ICloneable
[<Sealed>]
type OdbcConnection = 
    class
        inherit DbConnection
        interface ICloneable
    end
Public NotInheritable Class OdbcConnection
	Inherits DbConnection
	Implements ICloneable
NameDescription
System_CAPS_pubmethod OdbcConnection

Initializes a new instance of the OdbcConnection class.

System_CAPS_pubmethod OdbcConnection

Initializes a new instance of the OdbcConnection class with the specified connection string.

NameDescription
System_CAPS_pubproperty

Gets or sets the string used to open a data source.(Overrides .)

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets the server name or file name of the data source.(Overrides .)

System_CAPS_pubproperty

Gets the name of the ODBC driver specified for the current connection.

System_CAPS_pubproperty

Gets a string that contains the version of the server to which the client is connected.(Overrides .)

System_CAPS_pubproperty

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubproperty

Gets the current state of the connection.(Overrides .)

NameDescription
System_CAPS_pubmethod BeginTransaction

Starts a transaction at the data source.

System_CAPS_pubmethod BeginTransaction

Starts a transaction at the data source with the specified IsolationLevel value.

System_CAPS_pubmethod ChangeDatabase

Changes the current database associated with an open OdbcConnection.(Overrides DbConnectionChangeDatabase.)

System_CAPS_pubmethod Close

Closes the connection to the data source. (Overrides DbConnectionClose.)

System_CAPS_pubmethod CreateCommand

Creates and returns an OdbcCommand object associated with the OdbcConnection.

System_CAPS_pubmethod 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.)

System_CAPS_pubmethod Dispose

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethod EnlistDistributedTransaction

Enlists in the specified transaction as a distributed transaction.

System_CAPS_pubmethod EnlistTransaction

Enlists in the specified transaction as a distributed transaction.(Overrides DbConnectionEnlistTransaction.)

System_CAPS_pubmethod Equals

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethod GetHashCode

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethod GetLifetimeService

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod GetSchema

Returns schema information for the data source of this OdbcConnection.(Overrides DbConnectionGetSchema.)

System_CAPS_pubmethod GetSchema

Returns schema information for the data source of this OdbcConnection using the specified name for the schema name.(Overrides DbConnectionGetSchema.)

System_CAPS_pubmethod GetSchema

Returns schema information for the data source of this OdbcConnection using the specified string for the schema name and the specified string array for the restriction values.(Overrides DbConnectionGetSchema.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethod InitializeLifetimeService

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod Open

Opens a connection to a data source with the property settings specified by the .(Overrides DbConnectionOpen.)

System_CAPS_pubmethod OpenAsync

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

System_CAPS_pubmethod OpenAsync

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.(Inherited from DbConnection.)

System_CAPS_pubmethod System_CAPS_static ReleaseObjectPool

Indicates that the ODBC Driver Manager environment handle can be released when the last underlying connection is released.

System_CAPS_pubmethod ToString

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

NameDescription
System_CAPS_pubevent Disposed

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

System_CAPS_pubevent InfoMessage

Occurs when the ODBC driver sends a warning or an informational message.

System_CAPS_pubevent StateChange

Occurs when the state of the event changes.(Inherited from DbConnection.)

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod IDbConnectionBeginTransaction

Begins a database transaction.(Inherited from DbConnection.)

System_CAPS_pubinterface System_CAPS_privmethod IDbConnectionBeginTransaction

Begins a database transaction with the specified IsolationLevel value.(Inherited from DbConnection.)

System_CAPS_pubinterface System_CAPS_privmethod IDbConnectionCreateCommand

Creates and returns a DbCommand object that is associated with the current connection.(Inherited from DbConnection.)

System_CAPS_pubinterface System_CAPS_privmethod ICloneableClone

For a description of this member, see ICloneableClone.

An OdbcConnection object represents a unique connection to a data source created by using a connection string or ODBC data source name (DSN). With a client/server database system, it is equivalent to a network connection to the server. Depending on the functionality supported by the native ODBC driver, some methods or properties of an OdbcConnection object may not be available.

The OdbcConnection object uses native resources such as ODBC environment and connection handles. You should always explicitly close any open OdbcConnection objects by calling Close or Dispose before the OdbcConnection object goes out of scope, or by placing the connection within a Using statement. Not doing this leaves the freeing of these native resources to garbage collection. It might not free them immediately. This, in turn, can eventually cause the underlying driver to run out of resources or reach a maximum limit. This has resulted in intermittent failures. For example, you might experience Maximum Connections -related errors while many connections are waiting to be deleted by the garbage collector. Explicitly closing the connections allows for a more efficient use of native resources, enhancing scalability and improving overall application performance.

System_CAPS_noteNote

To deploy high-performance applications, you frequently must use connection pooling. However, when you use the .NET Framework Data Provider for ODBC, you do not have to enable connection pooling because the provider manages this automatically.

If one of the Execute methods of the OdbcCommand class causes a fatal OdbcException (for example, a SQL Server severity level of 20 or greater), the OdbcConnection may close. However, the user can reopen the connection and continue.

An application that creates an instance of the OdbcConnection object can require all direct and indirect callers to have sufficient permission to the code by setting declarative or imperative security demands. OdbcConnection creates security demands by using the OdbcPermission object. Users can verify that their code has sufficient permissions by using the OdbcPermissionAttribute object. Users and administrators can also use the Code Access Security Policy Tool (Caspol.exe) 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 source, see Connection Events.

The following example creates an OdbcCommand and an OdbcConnection. The OdbcConnection is opened and set as the property. 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 an SQL INSERT statement.

static private void InsertRow(string connectionString)
{
	string queryString = 
              "INSERT INTO Customers (CustomerID, CompanyName) Values('NWIND', 'Northwind Traders')";
	OdbcCommand command = new OdbcCommand(queryString);

	using (OdbcConnection connection = new OdbcConnection(connectionString))
	{
		command.Connection = connection;
		connection.Open();
		command.ExecuteNonQuery();

              // The connection is automatically closed at 
              // the end of the Using block.
	}
}
Private Sub InsertRow(ByVal connectionString As String)

    Dim queryString As String = _
        "INSERT INTO Customers (CustomerID, CompanyName) Values('NWIND', 'Northwind Traders')"
    Dim command As New OdbcCommand(queryString)

    Using connection As New OdbcConnection(connectionString)
        command.Connection = connection
        connection.Open()
        command.ExecuteNonQuery()

        ' The connection is automatically closed at 
        ' the end of the Using block.
    End Using
End Sub
.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top