Export (0) Print
Expand All

EntityCommand Class

Represents a command for the conceptual layer.

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.

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

  NameDescription
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 propertyCommandTreeGets or sets the command tree to execute; only one of the command tree or the command text can be set, not both.
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 the EntityCommand.
Public propertyContainerGets the IContainer that contains the Component. (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 a value that indicates whether the query plan caching is enabled.
Public propertyParametersGets the parameters of the Entity SQL statement or stored procedure.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertyTransactionGets or sets the transaction within which the SqlCommand executes.
Public propertyUpdatedRowSourceGets or sets how command results are applied to rows being updated. (Overrides DbCommand.UpdatedRowSource.)
Top

  NameDescription
Public methodCancelCancels the execution of an EntityCommand. (Overrides DbCommand.Cancel().)
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 an EntityParameter object.
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExecuteNonQueryExecutes the current command. (Overrides DbCommand.ExecuteNonQuery().)
Public methodExecuteNonQueryAsync()An asynchronous version of ExecuteNonQuery, which executes a SQL statement against a connection object.Invokes ExecuteNonQueryAsync with CancellationToken.None. (Inherited from DbCommand.)
Public methodExecuteNonQueryAsync(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.)
Public methodExecuteReader()Executes the command and returns a data reader.
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 methodExecuteReaderAsync()An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.Invokes ExecuteDbDataReaderAsync with CancellationToken.None. (Inherited from DbCommand.)
Public methodExecuteReaderAsync(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. (Inherited from DbCommand.)
Public methodExecuteReaderAsync(CommandBehavior)An asynchronous version of ExecuteReader, which executes the CommandText against the Connection and returns a DbDataReader.Invokes ExecuteDbDataReaderAsync. (Inherited from DbCommand.)
Public methodExecuteReaderAsync(CommandBehavior, CancellationToken)Invokes ExecuteDbDataReaderAsync. (Inherited from DbCommand.)
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().)
Public methodExecuteScalarAsync()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. (Inherited from DbCommand.)
Public methodExecuteScalarAsync(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.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
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.)
Public methodPrepareCompiles the entity-level command and creates a prepared version of the command. (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.
Top

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

  NameDescription
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.)
Top

No content here will be updated; please do not add material here.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, 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.

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