Session.ExecuteQueryWithMetadataAsync(String, QueryParameterCollection, CancellationToken) Method

Asynchronously executes the specified SQL query and returns its result set along with the types and names of retrieved columns.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public Task<SelectedData> ExecuteQueryWithMetadataAsync(
    string sql,
    QueryParameterCollection parameters,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Function ExecuteQueryWithMetadataAsync(
    sql As String,
    parameters As QueryParameterCollection,
    cancellationToken As CancellationToken = Nothing
) As Task(Of SelectedData)

Parameters

Name	Type	Description
sql	String	Specifies an SQL statement.
parameters	QueryParameterCollection	Specifies query parameter values.

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	A CancellationToken object that delivers a cancellation notice to the running operation.

Returns

Type	Description
Task<SelectedData>	A Task<TResult> that returns a result set compatible with XPDataView.

Remarks

Use the ExecuteQueryWithMetadataAsync method to query data stores for resulting sets. You can visualize resulting sets using the XPDataView. Refer to this article for additional information: How to: Access Data in SQL Query Results.

Use QueryParameterCollection to pass strongly-typed parameters. See examples here: Always Encrypted (SQL Server only).

The connection provider automatically generates sequential parameter names (p0, p1, p2 …). To specify custom parameter names, use the overloaded ExecuteQueryWithMetadataAsync(String, String[], QueryParameterCollection, CancellationToken) method.

To learn more about executing SQL statements in XPO, refer to Direct SQL Queries.

Note

The ExecuteQueryWithMetadataAsync method sends statements directly, so the correct statement syntax and parameter names format depends on a particular database server.