EntityCommand EntityCommand EntityCommand EntityCommand Class

Definition

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

Remarks

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

Constructors

EntityCommand() EntityCommand() EntityCommand() EntityCommand()

Initializes a new instance of the EntityCommand class using the specified values.

EntityCommand(String) EntityCommand(String) EntityCommand(String) EntityCommand(String)

Initializes a new instance of the EntityCommand class with the specified statement.

EntityCommand(String, EntityConnection) EntityCommand(String, EntityConnection) EntityCommand(String, EntityConnection) EntityCommand(String, EntityConnection)

Initializes a new instance of the EntityCommand class with the specified statement and connection.

EntityCommand(String, EntityConnection, EntityTransaction) EntityCommand(String, EntityConnection, EntityTransaction) EntityCommand(String, EntityConnection, EntityTransaction) EntityCommand(String, EntityConnection, EntityTransaction)

Initializes a new instance of the EntityCommand class with the specified statement, connection and transaction.

Properties

CanRaiseEvents CanRaiseEvents CanRaiseEvents CanRaiseEvents

Gets a value indicating whether the component can raise an event.

(Inherited from Component)
CommandText CommandText CommandText CommandText

Gets or sets an Entity SQL statement that specifies a command or stored procedure to execute.

CommandTimeout CommandTimeout CommandTimeout CommandTimeout

Gets or sets the amount of time to wait before timing out.

CommandTree CommandTree CommandTree 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 CommandType CommandType CommandType

Gets or sets a value that indicates how the CommandText property is to be interpreted.

Connection Connection Connection Connection

Gets or sets the EntityConnection used by the EntityCommand.

Container Container Container Container

Gets the IContainer that contains the Component.

(Inherited from Component)
DbConnection DbConnection DbConnection DbConnection

Gets or sets the DbConnection used by this DbCommand.

(Inherited from DbCommand)
DbParameterCollection DbParameterCollection DbParameterCollection DbParameterCollection

Gets the collection of DbParameter objects.

(Inherited from DbCommand)
DbTransaction DbTransaction DbTransaction DbTransaction

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

(Inherited from DbCommand)
DesignMode DesignMode DesignMode DesignMode

Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
DesignTimeVisible DesignTimeVisible DesignTimeVisible DesignTimeVisible

Gets or sets a value that indicates whether the command object should be visible in a Windows Form Designer control.

EnablePlanCaching EnablePlanCaching EnablePlanCaching EnablePlanCaching

Gets or sets a value that indicates whether the query plan caching is enabled.

Events Events Events Events

Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
IDbCommand.Connection IDbCommand.Connection IDbCommand.Connection IDbCommand.Connection

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

(Inherited from DbCommand)
IDbCommand.Parameters IDbCommand.Parameters IDbCommand.Parameters IDbCommand.Parameters

Gets the IDataParameterCollection.

(Inherited from DbCommand)
IDbCommand.Transaction IDbCommand.Transaction IDbCommand.Transaction IDbCommand.Transaction

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

(Inherited from DbCommand)
Parameters Parameters Parameters Parameters

Gets the parameters of the Entity SQL statement or stored procedure.

Site Site Site Site

Gets or sets the ISite of the Component.

(Inherited from Component)
Transaction Transaction Transaction Transaction

Gets or sets the transaction within which the SqlCommand executes.

UpdatedRowSource UpdatedRowSource UpdatedRowSource UpdatedRowSource

Gets or sets how command results are applied to rows being updated.

Methods

Cancel() Cancel() Cancel() Cancel()

Cancels the execution of an EntityCommand.

CreateDbParameter() CreateDbParameter() CreateDbParameter() CreateDbParameter()

Creates a new instance of a DbParameter object.

(Inherited from DbCommand)
CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) 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() CreateParameter() CreateParameter() CreateParameter()

Creates a new instance of an EntityParameter object.

Dispose() Dispose() Dispose() Dispose() Inherited from DbCommand
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Inherited from DbCommand
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
ExecuteDbDataReader(CommandBehavior) ExecuteDbDataReader(CommandBehavior) ExecuteDbDataReader(CommandBehavior) ExecuteDbDataReader(CommandBehavior)

Executes the command text against the connection.

(Inherited from DbCommand)
ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) 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() ExecuteNonQuery() ExecuteNonQuery() ExecuteNonQuery()

Executes the current command.

ExecuteNonQueryAsync() ExecuteNonQueryAsync() ExecuteNonQueryAsync() ExecuteNonQueryAsync()

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

Invokes ExecuteNonQueryAsync(CancellationToken) with CancellationToken.None.

(Inherited from DbCommand)
ExecuteNonQueryAsync(CancellationToken) ExecuteNonQueryAsync(CancellationToken) ExecuteNonQueryAsync(CancellationToken) 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() ExecuteReader() ExecuteReader() ExecuteReader()

Executes the command and returns a data reader.

ExecuteReader(CommandBehavior) ExecuteReader(CommandBehavior) ExecuteReader(CommandBehavior) 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() ExecuteReaderAsync() ExecuteReaderAsync() ExecuteReaderAsync()

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

Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken) with CancellationToken.None.

(Inherited from DbCommand)
ExecuteReaderAsync(CancellationToken) ExecuteReaderAsync(CancellationToken) ExecuteReaderAsync(CancellationToken) ExecuteReaderAsync(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(CommandBehavior, CancellationToken).

(Inherited from DbCommand)
ExecuteReaderAsync(CommandBehavior) ExecuteReaderAsync(CommandBehavior) ExecuteReaderAsync(CommandBehavior) ExecuteReaderAsync(CommandBehavior)

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

Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken).

(Inherited from DbCommand)
ExecuteReaderAsync(CommandBehavior, CancellationToken) ExecuteReaderAsync(CommandBehavior, CancellationToken) ExecuteReaderAsync(CommandBehavior, CancellationToken) ExecuteReaderAsync(CommandBehavior, CancellationToken)

Invokes ExecuteDbDataReaderAsync(CommandBehavior, CancellationToken).

(Inherited from DbCommand)
ExecuteScalar() ExecuteScalar() ExecuteScalar() ExecuteScalar()

Executes the command, and returns the first column of the first row in the result set. Additional columns or rows are ignored.

ExecuteScalarAsync() ExecuteScalarAsync() ExecuteScalarAsync() ExecuteScalarAsync()

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(CancellationToken) with CancellationToken.None.

(Inherited from DbCommand)
ExecuteScalarAsync(CancellationToken) ExecuteScalarAsync(CancellationToken) ExecuteScalarAsync(CancellationToken) 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() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetService(Type) GetService(Type) GetService(Type) GetService(Type)

Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
Prepare() Prepare() Prepare() Prepare()

Compiles the entity-level command and creates a prepared version of the command.

ToString() ToString() ToString() ToString()

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

(Inherited from Component)
ToTraceString() ToTraceString() ToTraceString() ToTraceString()

Compiles the entity-level command and returns the store command text.

Events

Disposed Disposed Disposed Disposed

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

(Inherited from Component)

Explicit Interface Implementations

IDbCommand.CreateParameter() IDbCommand.CreateParameter() IDbCommand.CreateParameter() IDbCommand.CreateParameter()

Creates a new instance of an IDbDataParameter object.

(Inherited from DbCommand)
IDbCommand.ExecuteReader() IDbCommand.ExecuteReader() IDbCommand.ExecuteReader() IDbCommand.ExecuteReader()

Executes the CommandText against the Connection and builds an IDataReader.

(Inherited from DbCommand)
IDbCommand.ExecuteReader(CommandBehavior) IDbCommand.ExecuteReader(CommandBehavior) IDbCommand.ExecuteReader(CommandBehavior) IDbCommand.ExecuteReader(CommandBehavior)

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

(Inherited from DbCommand)

Applies to