Session.ExecuteNonQueryAsync(String, CancellationToken) Method

SECURITY-RELATED CONSIDERATIONS

This method executes a raw SQL query string. Always validate, sanitize, or parameterize externally supplied SQL query strings to prevent unauthorized access to sensitive information.

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

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v26.1.dll

Declaration

C#

public Task<int> ExecuteNonQueryAsync(
    string sql,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

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

Parameters

Name	Type	Description
sql	String	Specifies an SQL statement.

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] = 0.15";
    int rowsAffected = await session.ExecuteNonQueryAsync(queryString, cancellationToken);
}

VB.NET

Imports System.Threading
Imports DevExpress.Xpo
' ...
Private cts As New CancellationTokenSource()
Await UpdateOrderDetailsAsync(cts.Token)
' ...
Public Async Function UpdateOrderDetailsAsync(ByVal cancellationToken As CancellationToken) As Task
    Const queryString As String = "UPDATE [Northwind].[dbo].[Order Details] SET [Discount] = 0.15"
    Dim rowsAffected As Integer = Await session.ExecuteNonQueryAsync(queryString, cancellationToken)
End Sub

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

Note

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