This documentation is archived and is not being maintained.

ObjectContext.ExecuteStoreQuery(Of TEntity) Method (String, String, MergeOption, Object())

Executes a query directly against the data source and returns a sequence of typed results. Specify the entity set and the merge option so that query results can be tracked as entities.

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

Public Function ExecuteStoreQuery(Of TEntity) ( _
	commandText As String, _
	entitySetName As String, _
	mergeOption As MergeOption, _
	ParamArray parameters As Object() _
) As ObjectResult(Of TEntity)

Type Parameters



Type: System.String
The command to execute, in the native language of the data source.
Type: System.String
The entity set of the TResult type. If an entity set name is not provided, the results are not going to be tracked.
Type: System.Data.Objects.MergeOption
The MergeOption to use when executing the query. The default is AppendOnly.
Type: System.Object()
An array of parameters to pass to the command.

Return Value

Type: System.Data.Objects.ObjectResult(Of TEntity)
An enumeration of objects of type TResult.

The ExecuteStoreQuery method uses the existing connection to execute an arbitrary command directly against the data source. The store command is executed in the context of the current transaction, if such a transaction exists.

Calling the ExecuteStoreQuery method is equivalent to calling the ExecuteReader method of the DbCommand class, only ExecuteStoreQuery returns entities and the ExecuteReader returns property values in the DbDataReader.

Specify the entity set name, if you want for the results to be tracked as entities.

Call Translate method to translate a DbDataReader into entity objects when the reader contains data rows that map to the specified entity type.

Using parameterized commands helps guard against SQL injection attacks, in which an attacker "injects" a command into a SQL statement that compromises security on the server. Parameterized commands guard against a SQL injection attack by guaranteeing that values received from an external source are passed as values only, and not part of the SQL statement. As a result, SQL commands inserted into a value are not executed at the data source. Rather, they are evaluated only as a parameter value. In addition to the security benefits, parameterized commands provide a convenient method for organizing values passed with a SQL statement or to a stored procedure.

The parameters value can be an array of DbParameter objects or an array of parameter values. If only values are supplied, an array of DbParameter objects are created based on the order of the values in the array.

For more information, see:

Executing Store Commands and

How to: Directly Execute Arbitrary Command Against the Store

.NET Framework

Supported in: 4

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