1 out of 2 rated this helpful - Rate this topic

OdbcConnection Class

Represents an open connection to a data source.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Data.Common.DbConnection
        System.Data.Odbc.OdbcConnection

Namespace:  System.Data.Odbc
Assembly:  System.Data (in System.Data.dll)
public sealed class OdbcConnection : DbConnection, 
	ICloneable

The OdbcConnection type exposes the following members.

  Name Description
Public method OdbcConnection() Initializes a new instance of the OdbcConnection class.
Public method OdbcConnection(String) Initializes a new instance of the OdbcConnection 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 data source. (Overrides DbConnection.ConnectionString.)
Public property ConnectionTimeout Gets or sets the time to wait while trying to establish a connection before terminating the attempt and generating an error.
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.)
Public property Driver Gets the name of the ODBC driver specified for the current connection.
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
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 transaction at the data source.
Public method BeginTransaction(IsolationLevel) Starts a transaction at the data source with the specified IsolationLevel value.
Public method ChangeDatabase Changes the current database associated with an open OdbcConnection. (Overrides DbConnection.ChangeDatabase(String).)
Public method Close Closes the connection to the data source. (Overrides DbConnection.Close().)
Public method CreateCommand Creates and returns an OdbcCommand object associated with the OdbcConnection.
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 GetSchema() Returns schema information for the data source of this OdbcConnection. (Overrides DbConnection.GetSchema().)
Public method GetSchema(String) Returns schema information for the data source of this OdbcConnection using the specified name for the schema name. (Overrides DbConnection.GetSchema(String).)
Public method 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. (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 connection to a data source with the property settings specified by the ConnectionString. (Overrides DbConnection.Open().)
Public method Static member ReleaseObjectPool Indicates that the ODBC Driver Manager environment handle can be released when the last underlying connection is released.
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 ODBC driver 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 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 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 (ADO.NET).

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.
			}
		}


.NET Framework

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

.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