Session.ExecuteScalarAsync(String, QueryParameterCollection, CancellationToken) Method
Asynchronously executes the specified SQL query and returns the first column of the first row in the result set returned by the query.
Namespace: DevExpress.Xpo
Assembly: DevExpress.Xpo.v24.2.dll
NuGet Package: DevExpress.Xpo
#Declaration
public Task<object> ExecuteScalarAsync(
string sql,
QueryParameterCollection parameters,
CancellationToken cancellationToken = default(CancellationToken)
)
#Parameters
Name | Type | Description |
---|---|---|
sql | String | Specifies an SQL statement. |
parameters | Query |
Specifies query parameter values. |
#Optional Parameters
Name | Type | Default | Description |
---|---|---|---|
cancellation |
Cancellation |
null | A Cancellation |
#Returns
Type | Description |
---|---|
Task<Object> | A Task |
#Remarks
Use the ExecuteScalarAsync method to query data stores for a single or aggregate value, without having to retrieve a result set.
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 ExecuteScalarAsync(String, String[], QueryParameterCollection, CancellationToken) method.
To learn more about executing SQL statements in XPO, refer to Direct SQL Queries.
Note
The Execute