OdbcConnection Class

Definition

Namespace:

System.Data.Odbc

Assembly:

System.Data.Odbc.dll

Package:

System.Data.Odbc v9.0.0-rc.2.24473.5

Source:

OdbcConnection.cs

Represents an open connection to a data source.

public ref class OdbcConnection sealed : System::Data::Common::DbConnection, ICloneable

public sealed class OdbcConnection : System.Data.Common.DbConnection, ICloneable

type OdbcConnection = class
    inherit DbConnection
    interface ICloneable

Public NotInheritable Class OdbcConnection
Inherits DbConnection
Implements ICloneable

Inheritance

Object

MarshalByRefObject

Component

DbConnection

OdbcConnection

Implements

ICloneable

Examples

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

Remarks

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.

Note

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.

Constructors

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

Properties

CanCreateBatch	Gets a value that indicates whether this DbConnection instance supports the DbBatch class. (Inherited from DbConnection)
CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
ConnectionString	Gets or sets the string used to open a data source.
ConnectionTimeout	Gets or sets the time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error.
Container	Gets the IContainer that contains the Component. (Inherited from Component)
Database	Gets the name of the current database or the database to be used after a connection is opened.
DataSource	Gets the server name or file name of the data source.
DbProviderFactory	Gets the DbProviderFactory for this DbConnection. (Inherited from DbConnection)
DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
Driver	Gets the name of the ODBC driver specified for the current connection.
Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
ServerVersion	Gets a string that contains the version of the server to which the client is connected.
Site	Gets or sets the ISite of the Component. (Inherited from Component)
State	Gets the current state of the connection.

Methods

BeginDbTransaction(IsolationLevel)	When overridden in a derived class, starts a database transaction. (Inherited from DbConnection)
BeginDbTransactionAsync(IsolationLevel, CancellationToken)	Asynchronously starts a database transaction. (Inherited from DbConnection)
BeginTransaction()	Starts a transaction at the data source.
BeginTransaction(IsolationLevel)	Starts a transaction at the data source with the specified IsolationLevel value.
BeginTransactionAsync(CancellationToken)	Asynchronously begins a database transaction. (Inherited from DbConnection)
BeginTransactionAsync(IsolationLevel, CancellationToken)	Asynchronously begins a database transaction. (Inherited from DbConnection)
ChangeDatabase(String)	Changes the current database associated with an open OdbcConnection.
ChangeDatabaseAsync(String, CancellationToken)	Asynchronously changes the current database for an open connection. (Inherited from DbConnection)
Close()	Closes the connection to the data source.
CloseAsync()	Asynchronously closes the connection to the database. (Inherited from DbConnection)
CreateBatch()	Returns a new instance of the provider's class that implements the DbBatch class. (Inherited from DbConnection)
CreateCommand()	Creates and returns an OdbcCommand object associated with the OdbcConnection.
CreateDbBatch()	When overridden in a derived class, returns a new instance of the provider's class that implements the DbBatch class. (Inherited from DbConnection)
CreateDbCommand()	When overridden in a derived class, creates and returns a DbCommand object associated with the current connection. (Inherited from DbConnection)
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()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DbConnection)
Dispose(Boolean)	Releases the unmanaged resources used by the DbConnection and optionally releases the managed resources. (Inherited from DbConnection)
DisposeAsync()	Asynchronously diposes the connection object. (Inherited from DbConnection)
EnlistTransaction(Transaction)	Enlists in the specified transaction. (Inherited from DbConnection)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Obsolete. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetSchema()	Returns schema information for the data source of this OdbcConnection.
GetSchema(String, String[])	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.
GetSchema(String)	Returns schema information for the data source of this OdbcConnection using the specified name for the schema name.
GetSchemaAsync(CancellationToken)	This is an asynchronous version of GetSchema(). Providers should override with an appropriate implementation. The cancellationToken can optionally be honored. The default implementation invokes the synchronous GetSchema() call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by GetSchema() will be communicated via the returned Task Exception property. (Inherited from DbConnection)
GetSchemaAsync(String, CancellationToken)	This is the asynchronous version of GetSchema(String). Providers should override with an appropriate implementation. The cancellationToken can optionally be honored. The default implementation invokes the synchronous GetSchema(String) call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by GetSchema(String) will be communicated via the returned Task Exception property. (Inherited from DbConnection)
GetSchemaAsync(String, String[], CancellationToken)	This is the asynchronous version of GetSchema(String, String[]). Providers should override with an appropriate implementation. The cancellationToken can optionally be honored. The default implementation invokes the synchronous GetSchema(String, String[]) call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by GetSchema(String, String[]) will be communicated via the returned Task Exception property. (Inherited from DbConnection)
GetService(Type)	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InitializeLifetimeService()	Obsolete. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
OnStateChange(StateChangeEventArgs)	Raises the StateChange event. (Inherited from DbConnection)
Open()	Opens a connection to a data source with the property settings specified by the ConnectionString.
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. (Inherited from DbConnection)
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. (Inherited from DbConnection)
ReleaseObjectPool()	Indicates that the ODBC Driver Manager environment handle can be released when the last underlying connection is released.
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)

Events

Disposed	Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component)
InfoMessage	Occurs when the ODBC driver sends a warning or an informational message.
StateChange	Occurs when the state of the connection changes. (Inherited from DbConnection)

Explicit Interface Implementations

ICloneable.Clone()	For a description of this member, see Clone().
IDbConnection.BeginTransaction()	Begins a database transaction. (Inherited from DbConnection)
IDbConnection.BeginTransaction(IsolationLevel)	Begins a database transaction with the specified isolation level. (Inherited from DbConnection)
IDbConnection.CreateCommand()	Creates and returns a DbCommand object that is associated with the current connection. (Inherited from DbConnection)

Extension Methods

ConfigureAwait(IAsyncDisposable, Boolean)

Configures how awaits on the tasks returned from an async disposable will be performed.

See also

• Connecting to Data Sources