0 out of 3 rated this helpful - Rate this topic

OdbcCommand Class

Represents an SQL statement or stored procedure to execute against a data source. This class cannot be inherited.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Data.Common.DbCommand
        System.Data.Odbc.OdbcCommand

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

The OdbcCommand type exposes the following members.

  Name Description
Public method OdbcCommand() Initializes a new instance of the OdbcCommand class.
Public method OdbcCommand(String) Initializes a new instance of the OdbcCommand class with the text of the query.
Public method OdbcCommand(String, OdbcConnection) Initializes a new instance of the OdbcCommand class with the text of the query and an OdbcConnection object.
Public method OdbcCommand(String, OdbcConnection, OdbcTransaction) Initializes a new instance of the OdbcCommand class with the text of the query, an OdbcConnection object, and the Transaction.
Top
  Name Description
Protected property CanRaiseEvents Gets a value indicating whether the component can raise an event. (Inherited from Component.)
Public property CommandText Gets or sets the SQL statement or stored procedure to execute against the data source. (Overrides DbCommand.CommandText.)
Public property CommandTimeout Gets or sets the wait time before terminating an attempt to execute a command and generating an error. (Overrides DbCommand.CommandTimeout.)
Public property CommandType Gets or sets a value that indicates how the CommandText property is interpreted. (Overrides DbCommand.CommandType.)
Public property Connection Gets or sets the OdbcConnection used by this instance of the OdbcCommand.
Public property Container Gets the IContainer that contains the Component. (Inherited from Component.)
Protected property DbConnection Gets or sets the DbConnection used by this DbCommand. (Inherited from DbCommand.)
Protected property DbParameterCollection Gets the collection of DbParameter objects. (Inherited from DbCommand.)
Protected property DbTransaction Gets or sets the DbTransaction within which this DbCommand object executes. (Inherited from DbCommand.)
Protected property DesignMode Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public property DesignTimeVisible Gets or sets a value that indicates whether the command object should be visible in a customized interface control. (Overrides DbCommand.DesignTimeVisible.)
Protected property Events Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public property Parameters Gets the OdbcParameterCollection.
Public property Site Gets or sets the ISite of the Component. (Inherited from Component.)
Public property Transaction Gets or sets the OdbcTransaction within which the OdbcCommand executes.
Public property UpdatedRowSource Gets or sets a value that specifies how the Update method should apply command results to the DataRow. (Overrides DbCommand.UpdatedRowSource.)
Top
  Name Description
Public method Cancel Tries to cancel the execution of an OdbcCommand. (Overrides DbCommand.Cancel().)
Protected method CreateDbParameter Creates a new instance of a DbParameter object. (Inherited from DbCommand.)
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 CreateParameter Creates a new instance of an OdbcParameter object.
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 Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method ExecuteDbDataReader Executes the command text against the connection. (Inherited from DbCommand.)
Public method ExecuteNonQuery Executes an SQL statement against the Connection and returns the number of rows affected. (Overrides DbCommand.ExecuteNonQuery().)
Public method ExecuteReader() Sends the CommandText to the Connection and builds an OdbcDataReader.
Public method ExecuteReader(CommandBehavior) Sends the CommandText to the Connection, and builds an OdbcDataReader using one of the CommandBehavior values.
Public method ExecuteScalar Executes the query, and returns the first column of the first row in the result set returned by the query. Additional columns or rows are ignored. (Overrides DbCommand.ExecuteScalar().)
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.)
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.)
Public method Prepare Creates a prepared or compiled version of the command at the data source. (Overrides DbCommand.Prepare().)
Public method ResetCommandTimeout Resets the CommandTimeout property to the default value.
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.)
Top
  Name Description
Explicit interface implemetation Private method ICloneable.Clone For a description of this member, see ICloneable.Clone.
Explicit interface implemetation Private property IDbCommand.Connection Gets or sets the IDbConnection used by this instance of the IDbCommand. (Inherited from DbCommand.)
Explicit interface implemetation Private method IDbCommand.CreateParameter Creates a new instance of an IDbDataParameter object. (Inherited from DbCommand.)
Explicit interface implemetation Private method IDbCommand.ExecuteReader() Executes the CommandText against the Connection and builds an IDataReader. (Inherited from DbCommand.)
Explicit interface implemetation Private method IDbCommand.ExecuteReader(CommandBehavior) Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehavior values. (Inherited from DbCommand.)
Explicit interface implemetation Private property IDbCommand.Parameters Gets the IDataParameterCollection. (Inherited from DbCommand.)
Explicit interface implemetation Private property IDbCommand.Transaction Gets or sets the DbTransaction within which this DbCommand object executes. (Inherited from DbCommand.)
Top

The OdbcCommand class provides the following methods for executing commands against a data source:

Item

Description

ExecuteReader

Executes commands that return rows.

ExecuteNonQuery

Executes commands such as SQL INSERT, DELETE, UPDATE, and SET statements.

ExecuteScalar

Retrieves a single value, for example, an aggregate value, from a database.

You can reset the CommandText property and reuse the OdbcCommand object. However, you must close the OdbcDataReader before you can execute a new or previous command.

If execution of the command causes a fatal OdbcException such as a SQL Server severity level of 20 or more, OdbcConnection may close. However, the user can reopen the connection and continue.

The following example uses the ExecuteReader method of the OdbcCommand class, together with the OdbcDataReader and OdbcConnection classes, to select rows from a table.


public void InsertRow(string connectionString, string insertSQL)
{
    using (OdbcConnection connection = 
               new OdbcConnection(connectionString))
    {
        // The insertSQL string contains a SQL statement that
        // inserts a new row in the source table.
        OdbcCommand command = new OdbcCommand(insertSQL, 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

.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