Session.ExecuteNonQueryAsync(String, QueryParameterCollection, 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,
    QueryParameterCollection parameters,
    CancellationToken cancellationToken = default(CancellationToken)
)

VB.NET

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

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<Int32>	A Task<TResult> that returns a number of affected rows.

Remarks

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

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 ExecuteNonQueryAsync(CancellationToken, String, String[], QueryParameterCollection) method.

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 and parameter names format depends on a particular database server.