This documentation is archived and is not being maintained.

EntityCommand Class

Represents a command to be executed against an Entity Data Model (EDM).

Namespace:  System.Data.EntityClient
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

public sealed class EntityCommand : DbCommand

The EntityCommand type exposes the following members.

Public methodEntityCommand()Initializes a new instance of the EntityCommand class.
Public methodEntityCommand(String)Initializes a new instance of the EntityCommand class with the text of the command.
Public methodEntityCommand(String, EntityConnection)Initializes a new instance of the EntityCommand class with the text of the command and an EntityConnection.
Public methodEntityCommand(String, EntityConnection, EntityTransaction)Initializes a new instance of the EntityCommand class with the text of the command, an EntityConnection and an EntityTransaction.

Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event. (Inherited from Component.)
Public propertyCommandTextGets or sets an Entity SQL statement that specifies a command or stored procedure to execute. (Overrides DbCommand.CommandText.)
Public propertyCommandTimeoutGets or sets the amount of time to wait before timing out. (Overrides DbCommand.CommandTimeout.)
Public propertyCommandTypeGets or sets a value that indicates how the CommandText property is to be interpreted. (Overrides DbCommand.CommandType.)
Public propertyConnectionGets or sets the EntityConnection used by this EntityCommand.
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Protected propertyDbConnectionGets or sets the DbConnection used by this DbCommand. (Inherited from DbCommand.)
Protected propertyDbParameterCollectionGets the collection of DbParameter objects. (Inherited from DbCommand.)
Protected propertyDbTransactionGets or sets the DbTransaction within which this DbCommand object executes. (Inherited from DbCommand.)
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Public propertyDesignTimeVisibleGets or sets a value that indicates whether the command object should be visible in a Windows Form Designer control. (Overrides DbCommand.DesignTimeVisible.)
Public propertyEnablePlanCachingGets or sets Boolean value that enables or disables query plan caching for this EntityCommand.
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyParametersGets the EntityParameterCollection.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertyTransactionGets or sets the EntityTransaction within which the SqlCommand executes.
Public propertyUpdatedRowSourceGets or sets how command results are applied to rows. (Overrides DbCommand.UpdatedRowSource.)

Public methodCancelTries to cancel the execution of a EntityCommand by calling the Cancel method of the underlying data provider. (Overrides DbCommand.Cancel().)
Protected methodCreateDbParameterCreates a new instance of a DbParameter object. (Inherited from DbCommand.)
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 a EntityParameter object.
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodExecuteDbDataReaderExecutes the command text against the connection. (Inherited from DbCommand.)
Public methodExecuteNonQueryExecutes the current command. (Overrides DbCommand.ExecuteNonQuery().)
Public methodExecuteReader()Executes the command and returns a EntityDataReader.
Public methodExecuteReader(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.
Public methodExecuteScalarExecutes the command, and returns the first column of the first row in the result set. Additional columns or rows are ignored. (Overrides DbCommand.ExecuteScalar().)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
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.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodPrepareCompiles 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().)
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Public methodToTraceStringCompiles the entity-level command and returns the store command text.

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

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.ExecuteReader()Executes 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.)


The EntityCommand is not associated with an EntityConnection property that was changed while a transaction was in progress.


The associated EntityConnection does not have store metadata.


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:

  1. Building a command tree from the specified Entity SQL command text if it has not already been built.

  2. 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.

  3. Setting the command tree, parameters, and other settings on the CommonDbCommandDefinition object.

  4. 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.

.NET Framework

Supported in: 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

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.

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