Session.ExecuteScalarAsync(String, String[], Object[], 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.1.dll

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

NuGet Package: DevExpress.Xpo

Declaration

C#

public Task<object> ExecuteScalarAsync(
    string sql,
    string[] parameterNames,
    object[] parameterValues,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

Public Function ExecuteScalarAsync(
    sql As String,
    parameterNames As String(),
    parameterValues As Object(),
    cancellationToken As CancellationToken = Nothing
) As Task(Of Object)

Parameters

Name	Type	Description
sql	String	Specifies an SQL statement.
parameterNames	String[]	Specifies parameter names.
parameterValues	Object[]	An array of objects specifying parameters to pass to the database server along with the query.

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<Object>	A Task<TResult> that returns the first column of the first row in the query’s result set. A null reference (Nothing in Visual Basic) if the result set does not contain columns. DBNull.Value if the first column does not contain a value.

Remarks

Use ExecuteScalarAsync to asynchronously query data stores for a single or aggregate value, without having to retrieve a result set.

The following example demonstrates how to use this method. Here, session is the Session instance.

C#

using System.Threading;
using System.Threading.Tasks;
using DevExpress.Xpo;
using DevExpress.Xpo.DB;
// ...
CancellationTokenSource cts = new CancellationTokenSource();
int ordersCount = await GetEmployeeOrdersCountAsync(cts.Token, 152);
// ...
public async Task<int> GetEmployeeOrdersCountAsync(CancellationToken cancellationToken, 
int employeeId) {
    const string queryString = 
        "SELECT COUNT(*) FROM [Northwind].[dbo].[Orders] WHERE [EmployeeID] = @p1";
    object result = await session.ExecuteScalarAsync(
        queryString, 
        new string[] { "p1" }, 
        new object[] { employeeId },
        cancellationToken
    );
    return (int)result;
}

VB.NET

Imports System.Threading
Imports System.Threading.Tasks
Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB
' ...
Private cts As New CancellationTokenSource()
Private ordersCount As Integer = Await GetEmployeeOrdersCountAsync(cts.Token, 152)
' ...
Public Async Function GetEmployeeOrdersCountAsync(ByVal cancellationToken As CancellationToken, _
ByVal employeeId As Integer) As Task(Of Integer)
    Const queryString As String = _
        "SELECT COUNT(*) FROM [Northwind].[dbo].[Orders] WHERE [EmployeeID] = @p1"
    Dim result As Object = Await session.ExecuteScalarAsync( _
        queryString, _
        New String() { "p1" }, _
        New Object() { employeeId }, _
        cancellationToken)
    Return CType(result, Integer)
End Function

Note that a format of parameter names in a SQL statement depends on the ADO.NET provider and database you use.

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

Note

The ExecuteScalarAsync method sends queries directly, so the correct query syntax depends on a particular database server.