Export (0) Print
Expand All

OdbcCommand Class

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

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

'Declaration
Public NotInheritable Class OdbcCommand _
	Inherits DbCommand _
	Implements ICloneable

The OdbcCommand type exposes the following members.

  NameDescription
Public methodOdbcCommandInitializes a new instance of the OdbcCommand class.
Public methodOdbcCommand(String)Initializes a new instance of the OdbcCommand class with the text of the query.
Public methodOdbcCommand(String, OdbcConnection)Initializes a new instance of the OdbcCommand class with the text of the query and an OdbcConnection object.
Public methodOdbcCommand(String, OdbcConnection, OdbcTransaction)Initializes a new instance of the OdbcCommand class with the text of the query, an OdbcConnection object, and the Transaction.
Top

  NameDescription
Public propertyCommandTextGets or sets the SQL statement or stored procedure to execute against the data source. (Overrides DbCommand.CommandText.)
Public propertyCommandTimeoutGets or sets the wait time before terminating an attempt to execute a command and generating an error. (Overrides DbCommand.CommandTimeout.)
Public propertyCommandTypeGets or sets a value that indicates how the CommandText property is interpreted. (Overrides DbCommand.CommandType.)
Public propertyConnectionGets or sets the OdbcConnection used by this instance of the OdbcCommand.
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyDesignTimeVisibleGets or sets a value that indicates whether the command object should be visible in a customized interface control. (Overrides DbCommand.DesignTimeVisible.)
Public propertyParametersGets the OdbcParameterCollection.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertyTransactionGets or sets the OdbcTransaction within which the OdbcCommand executes.
Public propertyUpdatedRowSourceGets or sets a value that specifies how the Update method should apply command results to the DataRow. (Overrides DbCommand.UpdatedRowSource.)
Top

  NameDescription
Public methodCancelTries to cancel the execution of an OdbcCommand. (Overrides DbCommand.Cancel.)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodCreateParameterCreates a new instance of an OdbcParameter object.
Public methodDisposeReleases all resources used by the Component. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExecuteNonQueryExecutes an SQL statement against the Connection and returns the number of rows affected. (Overrides DbCommand.ExecuteNonQuery.)
Public methodExecuteNonQueryAsyncAn asynchronous version of ExecuteNonQuery, which executes a SQL statement against a connection object.Invokes ExecuteNonQueryAsync with CancellationToken.None. (Inherited from DbCommand.)
Public methodExecuteNonQueryAsync(CancellationToken)This is the asynchronous version of ExecuteNonQuery. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.The default implementation invokes the synchronous ExecuteNonQuery method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteNonQuery will be communicated via the returned Task Exception property.Do not invoke other methods and properties of the DbCommand object until the returned Task is complete. (Inherited from DbCommand.)
Public methodExecuteReaderSends the CommandText to the Connection and builds an OdbcDataReader.
Public methodExecuteReader(CommandBehavior)Sends the CommandText to the Connection, and builds an OdbcDataReader using one of the CommandBehavior values.
Public methodExecuteReaderAsyncAn asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.Invokes ExecuteDbDataReaderAsync with CancellationToken.None. (Inherited from DbCommand.)
Public methodExecuteReaderAsync(CancellationToken)An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader. This method propagates a notification that operations should be canceled.Invokes ExecuteDbDataReaderAsync. (Inherited from DbCommand.)
Public methodExecuteReaderAsync(CommandBehavior)An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.Invokes ExecuteDbDataReaderAsync. (Inherited from DbCommand.)
Public methodExecuteReaderAsync(CommandBehavior, CancellationToken)Invokes ExecuteDbDataReaderAsync. (Inherited from DbCommand.)
Public methodExecuteScalarExecutes 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.)
Public methodExecuteScalarAsyncAn asynchronous version of ExecuteScalar, which executes the query and returns the first column of the first row in the result set returned by the query. All other columns and rows are ignored.Invokes ExecuteScalarAsync with CancellationToken.None. (Inherited from DbCommand.)
Public methodExecuteScalarAsync(CancellationToken)This is the asynchronous version of ExecuteScalar. Providers should override with an appropriate implementation. The cancellation token may optionally be ignored.The default implementation invokes the synchronous ExecuteScalar method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellation token. Exceptions thrown by ExecuteScalar will be communicated via the returned Task Exception property.Do not invoke other methods and properties of the DbCommand object until the returned Task is complete. (Inherited from DbCommand.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodPrepareCreates a prepared or compiled version of the command at the data source. (Overrides DbCommand.Prepare.)
Public methodResetCommandTimeoutResets the CommandTimeout property to the default value.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Top

  NameDescription
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICloneable.CloneFor a description of this member, see ICloneable.Clone.
Explicit interface implemetationPrivate propertyIDbCommand.ConnectionGets or sets the IDbConnection used by this instance of the IDbCommand. (Inherited from DbCommand.)
Explicit interface implemetationPrivate methodIDbCommand.CreateParameterCreates a new instance of an IDbDataParameter object. (Inherited from DbCommand.)
Explicit interface implemetationPrivate methodIDbCommand.ExecuteReaderExecutes the CommandText against the Connection and builds an IDataReader. (Inherited from DbCommand.)
Explicit interface implemetationPrivate methodIDbCommand.ExecuteReader(CommandBehavior)Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehavior values. (Inherited from DbCommand.)
Explicit interface implemetationPrivate propertyIDbCommand.ParametersGets the IDataParameterCollection. (Inherited from DbCommand.)
Explicit interface implemetationPrivate propertyIDbCommand.TransactionGets 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 ExecuteNonQuery.

Public Sub InsertRow(ByVal connectionString As String, _
    ByVal insertSQL As String)

    Using connection As New OdbcConnection(connectionString)
        ' The insertSQL string contains a SQL statement that 
        ' inserts a new row in the source table. 
        Dim command As New OdbcCommand(insertSQL, connection)

        ' Open the connection and execute the insert command. 
        Try
            connection.Open()
            command.ExecuteNonQuery()
        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try 
        ' The connection is automatically closed when the 
        ' code exits the Using block. 
    End Using 
End Sub

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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