Come passare i parametri al metodo DbContext.Database.ExecuteSqlCommand?

Supponiamo che io abbia una valida necessità di eseguire direttamente un comando sql in Entity Framework. Ho problemi a capire come usare i parametri nella mia istruzione sql. Il seguente esempio (non il mio esempio reale) non funziona.

var firstName = "John";
var id = 12;
var sql = @"Update [User] SET FirstName = @FirstName WHERE Id = @Id";
ctx.Database.ExecuteSqlCommand(sql, firstName, id);

Il metodo ExecuteSqlCommand non consente di passare parametri denominati come in ADO.Net e la documentazione per questo metodo non fornisce alcun esempio su come eseguire una query con parametri.

Come posso specificare correttamente i parametri?

Prova questo:

var sql = @"Update [User] SET FirstName = @FirstName WHERE Id = @Id";

ctx.Database.ExecuteSqlCommand(
    sql,
    new SqlParameter("@FirstName", firstname),
    new SqlParameter("@Id", id));

Si scopre che funziona.

var firstName = "John";
var id = 12;
var sql = "Update [User] SET FirstName = {0} WHERE Id = {1}";
ctx.Database.ExecuteSqlCommand(sql, firstName, id);

Puoi:

1) Passa argomenti non elaborati e utilizza la sintassi {0}. Per esempio:

DbContext.Database.SqlQuery("StoredProcedureName {0}", paramName);

2) Passa gli argomenti della sottoclasse DbParameter e usa la sintassi @ParamName.

DbContext.Database.SqlQuery("StoredProcedureName @ParamName", 
                                   new SqlParameter("@ParamName", paramValue);

Se si utilizza la prima sintassi, EF avvolgerà effettivamente i propri argomenti con le classi DbParamater, assegnando loro i nomi e sostituendo {0} con il nome del parametro generato.

La prima sintassi, se preferita, perché non è necessario utilizzare una factory o sapere quale tipo di DbParamaters creare (SqlParameter, OracleParamter, ecc.).

Le altre risposte non funzionano quando si utilizza Oracle. È necessario utilizzare :invece di @.

var sql = "Update [User] SET FirstName = :FirstName WHERE Id = :Id";

context.Database.ExecuteSqlCommand(
   sql,
   new OracleParameter(":FirstName", firstName), 
   new OracleParameter(":Id", id));

Prova questo (modificato):

ctx.Database.ExecuteSqlCommand(sql, new SqlParameter("FirstName", firstName), 
                                    new SqlParameter("Id", id));

L'idea precedente era sbagliata.

Per Entity Framework Core 2.0 o versione successiva, il modo corretto per farlo è:

var firstName = "John";
var id = 12;
ctx.Database.ExecuteSqlCommand($"Update [User] SET FirstName = {firstName} WHERE Id = {id}";

Si noti che Entity Framework produrrà i due parametri per te, quindi sei protetto da Sql Injection.

Si noti inoltre che NON è:

var firstName = "John";
var id = 12;
var sql = $"Update [User] SET FirstName = {firstName} WHERE Id = {id}";
ctx.Database.ExecuteSqlCommand(sql);

perché questo NON ti protegge dall'iniezione SQL e non vengono prodotti parametri.

Vedi questo per di più.

Versione semplificata per Oracle. Se non vuoi creare OracleParameter

var sql = "Update [User] SET FirstName = :p0 WHERE Id = :p1";
context.Database.ExecuteSqlCommand(sql, firstName, id);

var firstName = "John";
var id = 12;

ctx.Database.ExecuteSqlCommand(@"Update [User] SET FirstName = {0} WHERE Id = {1}"
, new object[]{ firstName, id });

Questo è così semplice !!!

Immagine per conoscere il riferimento ai parametri

Per il metodo asincrono ("ExecuteSqlCommandAsync") puoi usarlo in questo modo:

var sql = @"Update [User] SET FirstName = @FirstName WHERE Id = @Id";

await ctx.Database.ExecuteSqlCommandAsync(
    sql,
    parameters: new[]{
        new SqlParameter("@FirstName", firstname),
        new SqlParameter("@Id", id)
    });

Se i tipi di dati del database sottostante sono varchar, è necessario attenersi all'approccio seguente. Altrimenti la query avrebbe un enorme impatto sulle prestazioni.

var firstName = new SqlParameter("@firstName", System.Data.SqlDbType.VarChar, 20)
                            {
                                Value = "whatever"
                            };

var id = new SqlParameter("@id", System.Data.SqlDbType.Int)
                            {
                                Value = 1
                            };
ctx.Database.ExecuteSqlCommand(@"Update [User] SET FirstName = @firstName WHERE Id = @id"
                               , firstName, id);

Puoi controllare il profiler SQL per vedere la differenza.

public static class DbEx {
    public static IEnumerable<T> SqlQueryPrm<T>(this System.Data.Entity.Database database, string sql, object parameters) {
        using (var tmp_cmd = database.Connection.CreateCommand()) {
            var dict = ToDictionary(parameters);
            int i = 0;
            var arr = new object[dict.Count];
            foreach (var one_kvp in dict) {
                var param = tmp_cmd.CreateParameter();
                param.ParameterName = one_kvp.Key;
                if (one_kvp.Value == null) {
                    param.Value = DBNull.Value;
                } else {
                    param.Value = one_kvp.Value;
                }
                arr[i] = param;
                i++;
            }
            return database.SqlQuery<T>(sql, arr);
        }
    }
    private static IDictionary<string, object> ToDictionary(object data) {
        var attr = System.Reflection.BindingFlags.Public | System.Reflection.BindingFlags.Instance;
        var dict = new Dictionary<string, object>();
        foreach (var property in data.GetType().GetProperties(attr)) {
            if (property.CanRead) {
                dict.Add(property.Name, property.GetValue(data, null));
            }
        }
        return dict;
    }
}

Uso:

var names = db.Database.SqlQueryPrm<string>("select name from position_category where id_key=@id_key", new { id_key = "mgr" }).ToList();

Più parametri in una stored procedure con più parametri in vb:

Dim result= db.Database.ExecuteSqlCommand("StoredProcedureName @a,@b,@c,@d,@e", a, b, c, d, e)

Le procedure memorizzate possono essere eseguite come di seguito

 string cmd = Constants.StoredProcs.usp_AddRoles.ToString() + " @userId, @roleIdList";
                        int result = db.Database
                                       .ExecuteSqlCommand
                                       (
                                          cmd,
                                           new SqlParameter("@userId", userId),
                                           new SqlParameter("@roleIdList", roleId)
                                       );

Per .NET Core 2.2, è possibile utilizzare FormattableStringper SQL dinamico.

//Assuming this is your dynamic value and this not coming from user input
var tableName = "LogTable"; 
// let's say target date is coming from user input
var targetDate = DateTime.Now.Date.AddDays(-30);
var param = new SqlParameter("@targetDate", targetDate);  
var sql = string.Format("Delete From {0} Where CreatedDate < @targetDate", tableName);
var froamttedSql = FormattableStringFactory.Create(sql, param);
_db.Database.ExecuteSqlCommand(froamttedSql);