EntityCommand Class
Represents a command to be executed against an Entity Data Model (EDM).
System::MarshalByRefObject
System.ComponentModel::Component
System.Data.Common::DbCommand
System.Data.EntityClient::EntityCommand
Assembly: System.Data.Entity (in System.Data.Entity.dll)
The EntityCommand type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | EntityCommand() | Initializes a new instance of the EntityCommand class. |
![]() | EntityCommand(String) | Initializes a new instance of the EntityCommand class with the text of the command. |
![]() | EntityCommand(String, EntityConnection) | Initializes a new instance of the EntityCommand class with the text of the command and an EntityConnection. |
![]() | EntityCommand(String, EntityConnection, EntityTransaction) | Initializes a new instance of the EntityCommand class with the text of the command, an EntityConnection and an EntityTransaction. |
| Name | Description | |
|---|---|---|
![]() | 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. (Overrides DbCommand::CommandText.) |
![]() | CommandTimeout | Gets or sets the amount of time to wait before timing out. (Overrides DbCommand::CommandTimeout.) |
![]() | CommandType | Gets or sets a value that indicates how the CommandText property is to be interpreted. (Overrides DbCommand::CommandType.) |
![]() | Connection | Gets or sets the EntityConnection used by this 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. (Overrides DbCommand::DesignTimeVisible.) |
![]() | EnablePlanCaching | Gets or sets Boolean value that enables or disables query plan caching for this EntityCommand. |
![]() | Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
![]() | Parameters | Gets the EntityParameterCollection. |
![]() | Site | Gets or sets the ISite of the Component. (Inherited from Component.) |
![]() | Transaction | Gets or sets the EntityTransaction within which the SqlCommand executes. |
![]() | UpdatedRowSource | Gets or sets how command results are applied to rows. (Overrides DbCommand::UpdatedRowSource.) |
| Name | Description | |
|---|---|---|
![]() | Cancel | Tries to cancel the execution of a EntityCommand by calling the Cancel method of the underlying data provider. (Overrides DbCommand::Cancel().) |
![]() | CreateDbParameter | Creates a new instance of a DbParameter object. (Inherited from DbCommand.) |
![]() | 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 EntityParameter 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. (Inherited from DbCommand.) |
![]() | ExecuteNonQuery | Executes the current command. (Overrides DbCommand::ExecuteNonQuery().) |
![]() | ExecuteReader() | Executes the command and returns a EntityDataReader. |
![]() | 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. |
![]() | ExecuteScalar | Executes the command, and returns the first column of the first row in the result set. Additional columns or rows are ignored. (Overrides DbCommand::ExecuteScalar().) |
![]() | 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 | Compiles the entity-level command and creates a prepared version of the command by calling the Prepare method of the underlying data provider's Command object. (Overrides DbCommand::Prepare().) |
![]() | 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. |
| Name | Description | |
|---|---|---|
![]() ![]() | 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.) |
| Exception | Condition |
|---|---|
| InvalidOperationException | The EntityCommand is not associated with an EntityConnection property that was changed while a transaction was in progress. -or- The associated EntityConnection does not have store metadata. -or- The associated EntityConnection is in the Broken state. The DbDataReader associated with this EntityCommand is open. |
Client-side command compilation consists of the following steps:
Building a command tree from the specified Entity SQL command text if it has not already been built.
Getting the provider factory from the EntityConnection object and using it to create a DbCommandDefinition object. However, if EntityCommand is already associated with a DbCommandDefinition, this step is skipped.
Setting the command tree, parameters, and other settings on the CommonDbCommandDefinition object.
Adding the compiled query plan to the cache, if query plan caching is enabled.
For more information about using EntityCommand, see ADO.NET Entity Framework.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.

