Map inserts, updates, and deletes (CUD operations) to stored procedures

Note: Some of the features tracked in this issue could help with using EF Core with database views. However, the feature is not limited to database views and its completion would not mean that every aspect of database view support has been implemented. See #827 for an overview of the areas where EF Core interacts with database views.

---

Feature description

(added by @divega on Sep 4, 2014)

This is a general meta-issue for enabling better support for working with stored procedures in EF Core, with an emphasis on mapping stored procedures to parts of the EF Core model as opposed to using them in an ad hoc manner, which is covered in other issues. There are different aspects of stored procedures support than should be consider separately, e.g.:

• Invoking stored procedures in an ad hoc manner to return entity types (already possible with FromSql)
• Invoking stored procedures in an ad hoc manner to return arbitrary types (covered by #1862)
• Wrap Migrations calls to create stored procedures on SQL Server with EXEC (see #19740)
• Mapping of CUD operations to stored procedures
  • https://github.com/dotnet/efcore/issues/28435

Backlog

• #20339
• #15105
• https://github.com/dotnet/efcore/issues/27975
• https://github.com/dotnet/efcore/issues/28433
• https://github.com/dotnet/efcore/issues/28434
• https://github.com/dotnet/efcore/issues/28511
• https://github.com/dotnet/efcore/issues/28436
• https://github.com/dotnet/efcore/issues/28437
• https://github.com/dotnet/efcore/issues/28438
• https://github.com/dotnet/efcore/issues/28439
• https://github.com/dotnet/efcore/issues/28571

Note that for data retrieval stored procedures aren’t generally considered composable on the store i.e. it wouldn’t normally be possible to reference them in LINQ queries without causing all the further processing to switch to the client (#621 and #622 cover composable functions) but with our compensating LINQ provider it could be possible some day to enable mapping specific LINQ patterns to stored procedures calls, e.g.:

var customerOrders = db.Orders.Where(o => o.Customer == customerId);

Could cause a stored procedure OrdersByCustomerId(int @customerId) to be invoked.

---

API proposal

(added by @AndriySvyryd on May 6, 2022)

modelBuilder.Entity<Customer>()
    .UpdateUsingStoredProcedure(u => u.HasName("modify_cust")
        .HasParameter(b => b.Id, pb => pb.HasName("customer_id"))
        .HasParameter(b => b.Name, pb => pb.IsOutput())
        .HasParameter(b => b.AlternateKey)
        .HasRowsAffectedParameter(pb => pb.HasName("rows_affected")))
    .DeleteUsingStoredProcedure(d => d.HasName("delete_cust")
        .HasParameter(b => b.Id, pb => pb.HasName("customer_id")))
    .InsertUsingStoredProcedure(i => i.HasName("insert_cust")
        .HasParameter(b => b.Id, pb => pb.HasName("customer_id"))
        .HasParameter(b => b.Name)
        .HasParameter(b => b.AlternateKey)
        .HasResultColumn(b => b.Id, rb => rb.HasName("customer_out_id"))
        .HasResultColumn(b => b.Name)
        .HasRowsAffectedParameter(pb => pb.HasName("rows_affected"))
        .SuppressTransactions());

[mathewsun]

6 years have passed! How many time we should wait this functionality?!!! It main functionality for rapid development.

[IlyaTsilikov]

IMHO one of the most useful features of EF 6 is wrapping stored procedure into DbContext-based class methods. So it would be better to include such feature in EF 7 and if it’s possible make two improvemtnts: 1). make available EF to generate methods with out-parameters for OUTPUT SQL keyword (and also ref); 2). make EF available to generate async/await verson of such methods.