RelationalDatabaseFacadeExtensions.ExecuteSqlAsync メソッド

定義

名前空間:

Microsoft.EntityFrameworkCore

アセンブリ:

Microsoft.EntityFrameworkCore.Relational.dll

パッケージ:

Microsoft.EntityFrameworkCore.Relational v8.0.0

データベースに対して指定された SQL を実行し、影響を受けた行数を返します。

public static System.Threading.Tasks.Task<int> ExecuteSqlAsync (this Microsoft.EntityFrameworkCore.Infrastructure.DatabaseFacade databaseFacade, FormattableString sql, System.Threading.CancellationToken cancellationToken = default);

static member ExecuteSqlAsync : Microsoft.EntityFrameworkCore.Infrastructure.DatabaseFacade * FormattableString * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

<Extension()>
Public Function ExecuteSqlAsync (databaseFacade As DatabaseFacade, sql As FormattableString, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Integer)

パラメーター

databaseFacade

DatabaseFacade

DatabaseFacadeコンテキストの 。

sql

FormattableString

パラメーターを含む SQL クエリを表す補間文字列。

cancellationToken

CancellationToken

CancellationTokenタスクの完了を待機している間に観察する 。

戻り値

Task<Int32>

非同期操作を表すタスク。 タスクの結果は、影響を受ける行の数です。

例外

OperationCanceledException

CancellationToken が取り消されている場合。

注釈

このメソッドはトランザクションを開始しないことに注意してください。 トランザクションでこのメソッドを使用するには、最初に または を呼び出 BeginTransaction(DatabaseFacade, IsolationLevel) します UseTransaction。

SQL はべき等ではない可能性があり、トランザクションでは実行されないため、現在 ExecutionStrategy の は、このメソッドでは使用されないことに注意してください。 を ExecutionStrategy 明示的に使用できるため、SQL がべき等でない場合もトランザクションを使用してください。

SQL を受け入れる API と同様に、SQL インジェクション攻撃から保護するために、ユーザー入力をパラメーター化することが重要です。 SQL クエリ文字列にパラメーター プレース ホルダーを含め、追加の引数としてパラメーター値を指定できます。 指定したパラメーター値は、自動的に DbParameter に変換されます。

詳細と例については、「 EF Core を使用した生 SQL コマンドの実行 」を参照してください。