DbCommand Class
.NET Framework 4.5
Represents an SQL statement or stored procedure to execute against a data source. Provides a base class for database-specific classes that represent commands. ExecuteNonQueryAsync
Namespace: System.Data.Common
Assembly: System.Data (in System.Data.dll)
The DbCommand type exposes the following members.
| Name | Description | |
|---|---|---|
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
| CommandText | Gets or sets the text command to run against the data source. |
| CommandTimeout | Gets or sets the wait time before terminating the attempt to execute a command and generating an error. |
| CommandType | Indicates or specifies how the CommandText property is interpreted. |
| Connection | Gets or sets the DbConnection used by this DbCommand. |
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
| DbConnection | Gets or sets the DbConnection used by this DbCommand. |
| DbParameterCollection | Gets the collection of DbParameter objects. |
| DbTransaction | Gets or sets the DbTransaction within which this DbCommand object executes. |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
| DesignTimeVisible | Gets or sets a value indicating whether the command object should be visible in a customized interface control. |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
| Parameters | Gets the collection of DbParameter objects. For more information on parameters, see Configuring Parameters and Parameter Data Types (ADO.NET). |
| Site | Gets or sets the ISite of the Component. (Inherited from Component.) |
| Transaction | Gets or sets the DbTransaction within which this DbCommand object executes. |
| UpdatedRowSource | Gets or sets how command results are applied to the DataRow when used by the Update method of a DbDataAdapter. |
| Name | Description | |
|---|---|---|
| Cancel | Attempts to cancels the execution of a DbCommand. |
| CreateDbParameter | Creates a new instance of a DbParameter object. |
| 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.) |
| CreateParameter | Creates a new instance of a DbParameter object. |
| Dispose() | Releases all resources used by the Component. (Inherited from Component.) |
| Dispose(Boolean) | Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.) |
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| ExecuteDbDataReader | Executes the command text against the connection. |
| ExecuteDbDataReaderAsync | Providers should implement this method to provide a non-default implementation for ExecuteReader overloads.The default implementation invokes the synchronous ExecuteReader 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 ExecuteReader will be communicated via the returned Task Exception property.This method accepts a cancellation token that can be used to request the operation to be cancelled early. Implementations may ignore this request. |
| ExecuteNonQuery | Executes a SQL statement against a connection object. |
| ExecuteNonQueryAsync() | An asynchronous version of ExecuteNonQuery, which executes a SQL statement against a connection object.Invokes ExecuteNonQueryAsync with CancellationToken.None. |
| ExecuteNonQueryAsync(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. |
| ExecuteReader() | Executes the CommandText against the Connection, and returns an DbDataReader. |
| ExecuteReader(CommandBehavior) | Executes the CommandText against the Connection, and returns an DbDataReader using one of the CommandBehavior values. |
| ExecuteReaderAsync() | An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.Invokes ExecuteDbDataReaderAsync with CancellationToken.None. |
| ExecuteReaderAsync(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. |
| ExecuteReaderAsync(CommandBehavior) | An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.Invokes ExecuteDbDataReaderAsync. |
| ExecuteReaderAsync(CommandBehavior, CancellationToken) | Invokes ExecuteDbDataReaderAsync. |
| ExecuteScalar | 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. |
| ExecuteScalarAsync() | An 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. |
| ExecuteScalarAsync(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. |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetService | 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 | 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.) |
| Prepare | Creates a prepared (or compiled) version of the command on the data source. |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) In XNA Framework 3.0, this member is inherited from Object.ToString(). |
| Name | Description | |
|---|---|---|
 | IDbCommand.Connection | Gets or sets the IDbConnection used by this instance of the IDbCommand. |
| IDbCommand.CreateParameter | Creates a new instance of an IDbDataParameter object. |
| IDbCommand.ExecuteReader() | Executes the CommandText against the Connection and builds an IDataReader. |
| IDbCommand.ExecuteReader(CommandBehavior) | Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehavior values. |
| IDbCommand.Parameters | Gets the IDataParameterCollection. |
| IDbCommand.Transaction | Gets or sets the DbTransaction within which this DbCommand object executes. |
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
