DbCommand Class

DbCommand Class

 

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)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Data.Common.DbCommand
        System.Data.EntityClient.EntityCommand
        System.Data.Odbc.OdbcCommand
        System.Data.OleDb.OleDbCommand
        System.Data.OracleClient.OracleCommand
        System.Data.SqlClient.SqlCommand

public abstract class DbCommand : Component, IDbCommand, IDisposable

NameDescription
System_CAPS_protmethodDbCommand()

Constructs an instance of the DbCommand object.

NameDescription
System_CAPS_protpropertyCanRaiseEvents

Gets a value indicating whether the component can raise an event.(Inherited from Component.)

System_CAPS_pubpropertyCommandText

Gets or sets the text command to run against the data source.

System_CAPS_pubpropertyCommandTimeout

Gets or sets the wait time before terminating the attempt to execute a command and generating an error.

System_CAPS_pubpropertyCommandType

Indicates or specifies how the CommandText property is interpreted.

System_CAPS_pubpropertyConnection

Gets or sets the DbConnection used by this DbCommand.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_protpropertyDbConnection

Gets or sets the DbConnection used by this DbCommand.

System_CAPS_protpropertyDbParameterCollection

Gets the collection of DbParameter objects.

System_CAPS_protpropertyDbTransaction

Gets or sets the DbTransaction within which this DbCommand object executes.

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)

System_CAPS_pubpropertyDesignTimeVisible

Gets or sets a value indicating whether the command object should be visible in a customized interface control.

System_CAPS_protpropertyEvents

Gets the list of event handlers that are attached to this Component.(Inherited from Component.)

System_CAPS_pubpropertyParameters

Gets the collection of DbParameter objects. For more information on parameters, see Configuring Parameters and Parameter Data Types.

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertyTransaction

Gets or sets the DbTransaction within which this DbCommand object executes.

System_CAPS_pubpropertyUpdatedRowSource

Gets or sets how command results are applied to the DataRow when used by the Update method of a DbDataAdapter.

NameDescription
System_CAPS_pubmethodCancel()

Attempts to cancels the execution of a DbCommand.

System_CAPS_protmethodCreateDbParameter()

Creates a new instance of a DbParameter object.

System_CAPS_pubmethodCreateObjRef(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.)

System_CAPS_pubmethodCreateParameter()

Creates a new instance of a DbParameter object.

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the Component and optionally releases the managed resources.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodExecuteDbDataReader(CommandBehavior)

Executes the command text against the connection.

System_CAPS_protmethodExecuteDbDataReaderAsync(CommandBehavior, CancellationToken)

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.

System_CAPS_pubmethodExecuteNonQuery()

Executes a SQL statement against a connection object.

System_CAPS_pubmethodExecuteNonQueryAsync()

An asynchronous version of ExecuteNonQuery, which executes a SQL statement against a connection object.

Invokes ExecuteNonQueryAsync with CancellationToken.None.

System_CAPS_pubmethodExecuteNonQueryAsync(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.

System_CAPS_pubmethodExecuteReader()

Executes the CommandText against the Connection, and returns an DbDataReader.

System_CAPS_pubmethodExecuteReader(CommandBehavior)

Executes the CommandText against the Connection, and returns an DbDataReader using one of the CommandBehavior values.

System_CAPS_pubmethodExecuteReaderAsync()

An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.

Invokes ExecuteDbDataReaderAsync with CancellationToken.None.

System_CAPS_pubmethodExecuteReaderAsync(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.

System_CAPS_pubmethodExecuteReaderAsync(CommandBehavior)

An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.

Invokes ExecuteDbDataReaderAsync.

System_CAPS_pubmethodExecuteReaderAsync(CommandBehavior, CancellationToken)
System_CAPS_pubmethodExecuteScalar()

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.

System_CAPS_pubmethodExecuteScalarAsync()

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.

System_CAPS_pubmethodExecuteScalarAsync(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.

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodGetService(Type)

Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodPrepare()

Creates a prepared (or compiled) version of the command on the data source.

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDbCommand.CreateParameter()

Creates a new instance of an IDbDataParameter object.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDbCommand.ExecuteReader()

Executes the CommandText against the Connection and builds an IDataReader.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDbCommand.ExecuteReader(CommandBehavior)

Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehavior values.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbCommand.Connection

Gets or sets the IDbConnection used by this instance of the IDbCommand.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbCommand.Parameters
System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDbCommand.Transaction

Gets or sets the DbTransaction within which this DbCommand object executes.

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft