Session.ExecuteNonQueryAsync(String, Object[], CancellationToken) Method

Asynchronously executes the specified SQL statement and returns the number of rows affected.

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<int> ExecuteNonQueryAsync(
    string sql,
    object[] parameterValues,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

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

Parameters

Name	Type	Description
sql	String	Specifies an SQL statement.
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<Int32>	A Task<TResult> that returns a number of affected rows.

Remarks

Use ExecuteNonQueryAsync to asynchronously execute SQL statements that do not produce result sets, such as UPDATE, INSERT, and DELETE statements.

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

C#

using System.Threading;
using DevExpress.Xpo;
// ...
CancellationTokenSource cts = new CancellationTokenSource();
await UpdateOrderDetailsAsync(cts.Token);
// ...
public async Task UpdateOrderDetailsAsync(CancellationToken cancellationToken) {
    const string queryString = 
        "UPDATE [Northwind].[dbo].[Order Details] SET [Discount] = @p1 WHERE [UnitPrice] > @p2";
    int rowsAffected = await session.ExecuteNonQueryAsync(
        queryString,
        new object[] { 0.15, 100 },
        cancellationToken
    );
}

VB.NET

Imports System.Threading
Imports DevExpress.Xpo
' ...
Private cts As New CancellationTokenSource()
Await UpdateOrderDetailsAsync(cts.Token)
' ...
Public Async Sub UpdateOrderDetailsAsync(ByVal cancellationToken As CancellationToken) As Task
    Const queryString As String = _
      "UPDATE [Northwind].[dbo].[Order Details] SET [Discount] = @p1 WHERE [UnitPrice] > @p2"
    Dim rowsAffected As Integer = Await session.ExecuteNonQueryAsync(queryString, _
      New Object() { 0.15, 100 }, cancellationToken)
End Sub

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 statements in XPO, refer to Direct SQL Queries.

Note

The ExecuteNonQueryAsync method sends statements directly, so the correct statement syntax depends on a particular database server.