EntityCommand Class

Definition

Namespace:

System.Data.EntityClient

Assembly:

System.Data.Entity.dll

Represents a command for the conceptual layer.

public ref class EntityCommand sealed : System::Data::Common::DbCommand

public sealed class EntityCommand : System.Data.Common.DbCommand

type EntityCommand = class
    inherit DbCommand

Public NotInheritable Class EntityCommand
Inherits DbCommand

Inheritance

Object

MarshalByRefObject

Component

DbCommand

EntityCommand

Constructors

EntityCommand()	Initializes a new instance of the EntityCommand class using the specified values.
EntityCommand(String, EntityConnection, EntityTransaction)	Initializes a new instance of the EntityCommand class with the specified statement, connection and transaction.
EntityCommand(String, EntityConnection)	Initializes a new instance of the EntityCommand class with the specified statement and connection.
EntityCommand(String)	Initializes a new instance of the EntityCommand class with the specified statement.

Properties

CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
CommandText	Gets or sets an Entity SQL statement that specifies a command or stored procedure to execute.
CommandTimeout	Gets or sets the amount of time to wait before timing out.
CommandTree	Gets or sets the command tree to execute; only one of the command tree or the command text can be set, not both.
CommandType	Gets or sets a value that indicates how the CommandText property is to be interpreted.
Connection	Gets or sets the EntityConnection used by the EntityCommand.
Container	Gets the IContainer that contains the Component. (Inherited from Component)
DbConnection	Gets or sets the DbConnection used by this DbCommand. (Inherited from DbCommand)
DbParameterCollection	Gets the collection of DbParameter objects. (Inherited from DbCommand)
DbTransaction	Gets or sets the DbTransaction within which this DbCommand object executes. (Inherited from DbCommand)
DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
DesignTimeVisible	Gets or sets a value that indicates whether the command object should be visible in a Windows Form Designer control.
EnablePlanCaching	Gets or sets a value that indicates whether the query plan caching is enabled.
Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
Parameters	Gets the parameters of the Entity SQL statement or stored procedure.
Site	Gets or sets the ISite of the Component. (Inherited from Component)
Transaction	Gets or sets the transaction within which the SqlCommand executes.
UpdatedRowSource	Gets or sets how command results are applied to rows being updated.

Methods

Cancel()	Cancels the execution of an EntityCommand.
CreateDbParameter()	Creates a new instance of a DbParameter object. (Inherited from DbCommand)
CreateObjRef(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)
CreateParameter()	Creates a new instance of an EntityParameter object.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DbCommand)
Dispose(Boolean)	Releases the unmanaged resources used by the DbCommand and optionally releases the managed resources. (Inherited from DbCommand)
DisposeAsync()	Asynchronously disposes the command object. (Inherited from DbCommand)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
ExecuteDbDataReader(CommandBehavior)	Executes the command against its connection, returning a DbDataReader which can be used to access the results. (Inherited from DbCommand)
ExecuteDbDataReaderAsync(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. (Inherited from DbCommand)
ExecuteNonQuery()	Executes the current command.
ExecuteNonQueryAsync()	An asynchronous version of ExecuteNonQuery(), which executes the command against its connection object, returning the number of rows affected. Invokes ExecuteNonQueryAsync(CancellationToken) with CancellationToken.None. (Inherited from DbCommand)
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. (Inherited from DbCommand)
ExecuteReader()	Executes the command and returns a data reader.
ExecuteReader(CommandBehavior)	Compiles the CommandText into a command tree and passes it to the underlying store provider for execution, then builds an EntityDataReader out of the produced result set using the specified CommandBehavior.
ExecuteReaderAsync()	An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader which can be used to access the results. Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) with CancellationToken.None. (Inherited from DbCommand)
ExecuteReaderAsync(CancellationToken)	An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader which can be used to access the results. Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken). (Inherited from DbCommand)
ExecuteReaderAsync(CommandBehavior, CancellationToken)	Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken). (Inherited from DbCommand)
ExecuteReaderAsync(CommandBehavior)	An asynchronous version of ExecuteReader, which executes the command against its connection, returning a DbDataReader which can be used to access the results. Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken). (Inherited from DbCommand)
ExecuteScalar()	Executes the command, and returns the first column of the first row in the result set. Additional columns or rows are ignored.
ExecuteScalarAsync()	An asynchronous version of ExecuteScalar(), which executes the command and returns the first column of the first row in the first returned result set. All other columns, rows and result sets are ignored. Invokes ExecuteScalarAsync(CancellationToken) with CancellationToken.None. (Inherited from DbCommand)
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. (Inherited from DbCommand)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetService(Type)	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()	Compiles the entity-level command and creates a prepared version of the command.
PrepareAsync(CancellationToken)	Asynchronously creates a prepared (or compiled) version of the command on the data source. (Inherited from DbCommand)
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)
ToTraceString()	Compiles the entity-level command and returns the store command text.

Events

Disposed

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

Explicit Interface Implementations

IDbCommand.Connection	Gets or sets the IDbConnection used by this instance of the IDbCommand. (Inherited from DbCommand)
IDbCommand.CreateParameter()	Creates a new instance of an IDbDataParameter object. (Inherited from DbCommand)
IDbCommand.ExecuteReader()	Executes the CommandText against the Connection and builds an IDataReader. (Inherited from DbCommand)
IDbCommand.ExecuteReader(CommandBehavior)	Executes the CommandText against the Connection, and builds an IDataReader using one of the CommandBehavior values. (Inherited from DbCommand)
IDbCommand.Parameters	Gets the IDataParameterCollection. (Inherited from DbCommand)
IDbCommand.Transaction	Gets or sets the DbTransaction within which this DbCommand object executes. (Inherited from DbCommand)