Truy vấn SQL thô không có DbSet - Entity Framework Core

Với việc loại bỏ Entity Framework Core, dbData.Database.SqlQuery<SomeModel>tôi không thể tìm thấy giải pháp để xây dựng một Truy vấn SQL thô cho truy vấn tìm kiếm toàn văn của tôi, truy vấn này sẽ trả về dữ liệu bảng và cả xếp hạng.

Phương pháp duy nhất tôi đã thấy để xây dựng một truy vấn SQL thô trong Entity Framework Core là thông qua phương pháp dbData.Product.FromSql("SQL SCRIPT");này không hữu ích vì tôi không có DbSet nào sẽ ánh xạ thứ hạng mà tôi trả về trong truy vấn.

Bất kỳ ý tưởng ???

Tùy thuộc vào việc bạn đang sử dụng EF Core 2.1 hay EF Core 3 và các phiên bản cao hơn .

Nếu bạn đang sử dụng EF Core 2.1

Nếu bạn đang sử dụng EF Core 2.1 Release Candidate 1 có sẵn kể từ ngày 7 tháng 5 năm 2018, bạn có thể tận dụng tính năng mới được đề xuất là Loại truy vấn.

Loại truy vấn là gì?

Ngoài các loại thực thể, một mô hình EF Core có thể chứa các loại truy vấn, có thể được sử dụng để thực hiện các truy vấn cơ sở dữ liệu đối với dữ liệu không được ánh xạ tới các loại thực thể.

Khi nào sử dụng loại truy vấn?

Phục vụ như kiểu trả về cho các truy vấn FromSql () đặc biệt.

Ánh xạ tới các dạng xem cơ sở dữ liệu.

Ánh xạ tới các bảng không có khóa chính được xác định.

Ánh xạ tới các truy vấn được xác định trong mô hình.

Vì vậy, bạn không còn cần phải thực hiện tất cả các thủ thuật hoặc cách giải quyết được đề xuất như câu trả lời cho câu hỏi của mình. Chỉ cần làm theo các bước sau:

Trước tiên, bạn đã xác định một thuộc tính mới của kiểu DbQuery<T>, trong đó Tlà kiểu của lớp sẽ mang các giá trị cột của truy vấn SQL của bạn. Vì vậy, DbContextbạn sẽ có cái này:

public DbQuery<SomeModel> SomeModels { get; set; }

Thứ hai, sử dụng FromSqlphương pháp như bạn làm với DbSet<T>:

var result = context.SomeModels.FromSql("SQL_SCRIPT").ToList();
var result = await context.SomeModels.FromSql("SQL_SCRIPT").ToListAsync();

Cũng lưu ý rằng DdContexts là các lớp một phần , vì vậy bạn có thể tạo một hoặc nhiều tệp riêng biệt để sắp xếp các định nghĩa 'DbQuery SQL thô' của bạn sao cho phù hợp nhất với bạn.

Nếu bạn đang sử dụng EF Core 3.0 và các phiên bản cao hơn

Loại truy vấn hiện được gọi là loại thực thể không khóa . Như đã nói ở trên, các kiểu truy vấn đã được giới thiệu trong EF Core 2.1. Nếu bạn đang sử dụng phiên bản EF Core 3.0 hoặc cao hơn, bây giờ bạn nên điều chỉnh bằng cách sử dụng các loại tntity không khóa vì các loại truy vấn hiện được đánh dấu là lỗi thời.

Tính năng này đã được thêm vào EF Core 2.1 dưới tên của các loại truy vấn. Trong EF Core 3.0, khái niệm được đổi tên thành các loại thực thể không khóa. Chú thích dữ liệu [Keyless] đã có trong EFCore 5.0.

Chúng tôi vẫn có các tình huống tương tự như đối với các loại truy vấn về thời điểm sử dụng loại thực thể không khóa.

Vì vậy, để sử dụng nó, trước tiên bạn cần đánh dấu lớp của mình SomeModelbằng [Keyless]chú thích dữ liệu hoặc thông qua cấu hình thông thạo với .HasNoKey()cuộc gọi phương thức như dưới đây:

public DbSet<SomeModel> SomeModels { get; set; }

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<SomeModel>().HasNoKey();
}

Sau cấu hình đó, bạn có thể sử dụng một trong các phương pháp được giải thích ở đây để thực thi truy vấn SQL của mình. Ví dụ, bạn có thể sử dụng cái này:

var result = context.SomeModels.FromSqlRaw("SQL SCRIPT").ToList();

Dựa trên các câu trả lời khác mà tôi đã viết trình trợ giúp này hoàn thành nhiệm vụ, bao gồm cả cách sử dụng ví dụ:

public static class Helper
{
    public static List<T> RawSqlQuery<T>(string query, Func<DbDataReader, T> map)
    {
        using (var context = new DbContext())
        {
            using (var command = context.Database.GetDbConnection().CreateCommand())
            {
                command.CommandText = query;
                command.CommandType = CommandType.Text;

                context.Database.OpenConnection();

                using (var result = command.ExecuteReader())
                {
                    var entities = new List<T>();

                    while (result.Read())
                    {
                        entities.Add(map(result));
                    }

                    return entities;
                }
            }
        }
    }

Sử dụng:

public class TopUser
{
    public string Name { get; set; }

    public int Count { get; set; }
}

var result = Helper.RawSqlQuery(
    "SELECT TOP 10 Name, COUNT(*) FROM Users U"
    + " INNER JOIN Signups S ON U.UserId = S.UserId"
    + " GROUP BY U.Name ORDER BY COUNT(*) DESC",
    x => new TopUser { Name = (string)x[0], Count = (int)x[1] });

result.ForEach(x => Console.WriteLine($"{x.Name,-25}{x.Count}"));

Tôi dự định loại bỏ nó ngay khi hỗ trợ tích hợp được thêm vào. Theo một tuyên bố của Arthur Vickers từ nhóm EF Core, ưu tiên cao cho hậu 2.0. Vấn đề đang được theo dõi ở đây .

Trong EF Core, bạn không thể thực thi sql thô "miễn phí" nữa. Bạn được yêu cầu xác định một lớp POCO và một DbSetcho lớp đó. Trong trường hợp của bạn, bạn sẽ cần xác định Xếp hạng :

var ranks = DbContext.Ranks
   .FromSql("SQL_SCRIPT OR STORED_PROCEDURE @p0,@p1,...etc", parameters)
   .AsNoTracking().ToList();

Vì nó chắc chắn sẽ chỉ đọc nên sẽ hữu ích khi bao gồm .AsNoTracking()cuộc gọi.

EDIT - Thay đổi đột phá trong EF Core 3.0:

DbQuery () hiện đã lỗi thời, thay vào đó DbSet () nên được sử dụng (một lần nữa). Nếu bạn có một thực thể không có khóa, tức là nó không yêu cầu khóa chính, bạn có thể sử dụng phương thức HasNoKey () :

ModelBuilder.Entity<SomeModel>().HasNoKey()

Thông tin thêm có thể được tìm thấy tại đây

Bạn có thể thực thi sql thô trong EF Core - Thêm lớp này vào dự án của bạn. Điều này sẽ cho phép bạn thực thi SQL thô và nhận được kết quả thô mà không cần phải xác định POCO và DBSet. Xem https://github.com/aspnet/EntityFramework/issues/1862#issuecomment-220787464 để biết ví dụ ban đầu.

using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Internal;
using Microsoft.EntityFrameworkCore.Storage;
using System.Threading;
using System.Threading.Tasks;

namespace Microsoft.EntityFrameworkCore
{
    public static class RDFacadeExtensions
    {
        public static RelationalDataReader ExecuteSqlQuery(this DatabaseFacade databaseFacade, string sql, params object[] parameters)
        {
            var concurrencyDetector = databaseFacade.GetService<IConcurrencyDetector>();

            using (concurrencyDetector.EnterCriticalSection())
            {
                var rawSqlCommand = databaseFacade
                    .GetService<IRawSqlCommandBuilder>()
                    .Build(sql, parameters);

                return rawSqlCommand
                    .RelationalCommand
                    .ExecuteReader(
                        databaseFacade.GetService<IRelationalConnection>(),
                        parameterValues: rawSqlCommand.ParameterValues);
            }
        }

        public static async Task<RelationalDataReader> ExecuteSqlQueryAsync(this DatabaseFacade databaseFacade, 
                                                             string sql, 
                                                             CancellationToken cancellationToken = default(CancellationToken),
                                                             params object[] parameters)
        {

            var concurrencyDetector = databaseFacade.GetService<IConcurrencyDetector>();

            using (concurrencyDetector.EnterCriticalSection())
            {
                var rawSqlCommand = databaseFacade
                    .GetService<IRawSqlCommandBuilder>()
                    .Build(sql, parameters);

                return await rawSqlCommand
                    .RelationalCommand
                    .ExecuteReaderAsync(
                        databaseFacade.GetService<IRelationalConnection>(),
                        parameterValues: rawSqlCommand.ParameterValues,
                        cancellationToken: cancellationToken);
            }
        }
    }
}

Đây là một ví dụ về cách sử dụng nó:

// Execute a query.
using(var dr = await db.Database.ExecuteSqlQueryAsync("SELECT ID, Credits, LoginDate FROM SamplePlayer WHERE " +
                                                          "Name IN ('Electro', 'Nitro')"))
{
    // Output rows.
    var reader = dr.DbDataReader;
    while (reader.Read())
    {
        Console.Write("{0}\t{1}\t{2} \n", reader[0], reader[1], reader[2]);
    }
}

Hiện tại, cho đến khi có thứ gì đó mới từ EFCore, tôi sẽ sử dụng một lệnh và ánh xạ nó theo cách thủ công

  using (var command = this.DbContext.Database.GetDbConnection().CreateCommand())
  {
      command.CommandText = "SELECT ... WHERE ...> @p1)";
      command.CommandType = CommandType.Text;
      var parameter = new SqlParameter("@p1",...);
      command.Parameters.Add(parameter);

      this.DbContext.Database.OpenConnection();

      using (var result = command.ExecuteReader())
      {
         while (result.Read())
         {
            .... // Map to your entity
         }
      }
  }

Cố gắng SqlParameter để tránh Sql Injection.

 dbData.Product.FromSql("SQL SCRIPT");

FromSql không hoạt động với truy vấn đầy đủ. Ví dụ nếu bạn muốn bao gồm mệnh đề WHERE thì nó sẽ bị bỏ qua.

Một số liên kết:

Thực thi truy vấn SQL thô bằng Entity Framework Core

Truy vấn SQL thô

Trong Core 2.1, bạn có thể làm như sau:

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
       modelBuilder.Query<Ranks>();
}

và sau đó xác định cho bạn Thủ tục SQL, như:

public async Task<List<Ranks>> GetRanks(string value1, Nullable<decimal> value2)
{
    SqlParameter value1Input = new SqlParameter("@Param1", value1?? (object)DBNull.Value);
    SqlParameter value2Input = new SqlParameter("@Param2", value2?? (object)DBNull.Value);

    List<Ranks> getRanks = await this.Query<Ranks>().FromSql("STORED_PROCEDURE @Param1, @Param2", value1Input, value2Input).ToListAsync();

    return getRanks;
}

Bằng cách này, mô hình Xếp hạng sẽ không được tạo trong DB của bạn.

Bây giờ trong bộ điều khiển / hành động của bạn, bạn có thể gọi:

List<Ranks> gettingRanks = _DbContext.GetRanks(value1,value2).Result.ToListAsync();

Bằng cách này, bạn có thể gọi Thủ tục SQL thô.

Bạn có thể sử dụng này (từ https://github.com/aspnet/EntityFrameworkCore/issues/1862#issuecomment-451671168 ):

public static class SqlQueryExtensions
{
    public static IList<T> SqlQuery<T>(this DbContext db, string sql, params object[] parameters) where T : class
    {
        using (var db2 = new ContextForQueryType<T>(db.Database.GetDbConnection()))
        {
            return db2.Query<T>().FromSql(sql, parameters).ToList();
        }
    }

    private class ContextForQueryType<T> : DbContext where T : class
    {
        private readonly DbConnection connection;

        public ContextForQueryType(DbConnection connection)
        {
            this.connection = connection;
        }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            // switch on the connection type name to enable support multiple providers
            // var name = con.GetType().Name;
            optionsBuilder.UseSqlServer(connection, options => options.EnableRetryOnFailure());

            base.OnConfiguring(optionsBuilder);
        }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.Query<T>();
            base.OnModelCreating(modelBuilder);
        }
    }
}

Và cách sử dụng:

    using (var db = new Db())
    {
        var results = db.SqlQuery<ArbitraryType>("select 1 id, 'joe' name");
        //or with an anonymous type like this
        var results2 = db.SqlQuery(() => new { id =1, name=""},"select 1 id, 'joe' name");
    }

Thêm gói Nuget - Microsoft.EntityFrameworkCore.Relational

using Microsoft.EntityFrameworkCore;
...
await YourContext.Database.ExecuteSqlCommandAsync("... @p0, @p1", param1, param2 ..)

Điều này sẽ trả về số hàng dưới dạng int

Xem - https://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.relationaldatabasefacadeextensions.executesqlcommand?view=efcore-3.0

hãy thử điều này: (tạo phương pháp mở rộng)

public static List<T> ExecuteQuery<T>(this dbContext db, string query) where T : class, new()
        {
            using (var command = db.Database.GetDbConnection().CreateCommand())
            {
                command.CommandText = query;
                command.CommandType = CommandType.Text;

                db.Database.OpenConnection();

                using (var reader = command.ExecuteReader())
                {
                    var lst = new List<T>();
                    var lstColumns = new T().GetType().GetProperties(BindingFlags.DeclaredOnly | BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic).ToList();
                    while (reader.Read())
                    {
                        var newObject = new T();
                        for (var i = 0; i < reader.FieldCount; i++)
                        {
                            var name = reader.GetName(i);
                            PropertyInfo prop = lstColumns.FirstOrDefault(a => a.Name.ToLower().Equals(name.ToLower()));
                            if (prop == null)
                            {
                                continue;
                            }
                            var val = reader.IsDBNull(i) ? null : reader[i];
                            prop.SetValue(newObject, val, null);
                        }
                        lst.Add(newObject);
                    }

                    return lst;
                }
            }
        }

Sử dụng:

var db = new dbContext();
string query = @"select ID , Name from People where ... ";
var lst = db.ExecuteQuery<PeopleView>(query);

mô hình của tôi: (không trong DbSet):

public class PeopleView
{
    public int ID { get; set; }
    public string Name { get; set; }
}

đã thử nghiệm .netCore 2.2 and 3.0.

Lưu ý: giải pháp này có hiệu suất chậm

Không nhắm trực tiếp vào kịch bản của OP, nhưng vì tôi đã phải vật lộn với điều này, tôi muốn bỏ những người yêu cũ này. các phương thức giúp thực thi SQL thô dễ dàng hơn với DbContext:

public static class DbContextCommandExtensions
{
  public static async Task<int> ExecuteNonQueryAsync(this DbContext context, string rawSql,
    params object[] parameters)
  {
    var conn = context.Database.GetDbConnection();
    using (var command = conn.CreateCommand())
    {
      command.CommandText = rawSql;
      if (parameters != null)
        foreach (var p in parameters)
          command.Parameters.Add(p);
      await conn.OpenAsync();
      return await command.ExecuteNonQueryAsync();
    }
  }

  public static async Task<T> ExecuteScalarAsync<T>(this DbContext context, string rawSql,
    params object[] parameters)
  {
    var conn = context.Database.GetDbConnection();
    using (var command = conn.CreateCommand())
    {
      command.CommandText = rawSql;
      if (parameters != null)
        foreach (var p in parameters)
          command.Parameters.Add(p);
      await conn.OpenAsync();
      return (T)await command.ExecuteScalarAsync();
    }
  }
}

Tôi đã sử dụng Dapper để bỏ qua ràng buộc này của Core framework Entity.

IDbConnection.Query

đang làm việc với truy vấn sql hoặc thủ tục được lưu trữ với nhiều tham số. Nhân tiện, nó nhanh hơn một chút (xem các bài kiểm tra điểm chuẩn )

Dapper rất dễ học. Mất 15 phút để viết và chạy thủ tục được lưu trữ với các tham số. Dù sao thì bạn cũng có thể sử dụng cả EF và Dapper. Dưới đây là một ví dụ:

 public class PodborsByParametersService
{
    string _connectionString = null;


    public PodborsByParametersService(string connStr)
    {
        this._connectionString = connStr;

    }

    public IList<TyreSearchResult> GetTyres(TyresPodborView pb,bool isPartner,string partnerId ,int pointId)
    {

        string sqltext  "spGetTyresPartnerToClient";

        var p = new DynamicParameters();
        p.Add("@PartnerID", partnerId);
        p.Add("@PartnerPointID", pointId);

        using (IDbConnection db = new SqlConnection(_connectionString))
        {
            return db.Query<TyreSearchResult>(sqltext, p,null,true,null,CommandType.StoredProcedure).ToList();
        }


        }
}

Bạn cũng có thể sử dụng QueryFirst . Giống như Dapper, điều này hoàn toàn nằm ngoài EF. Không giống như Dapper (hoặc EF), bạn không cần duy trì POCO, bạn chỉnh sửa SQL sql của mình trong môi trường thực và nó liên tục được xác nhận lại dựa trên DB. Tuyên bố từ chối trách nhiệm: Tôi là tác giả của QueryFirst.

Trường hợp của tôi đã sử dụng thủ tục được lưu trữ thay vì SQL thô

Đã tạo một lớp học

Public class School
{
    [Key]
    public Guid SchoolId { get; set; }
    public string Name { get; set; }
    public string Branch { get; set; }
    public int NumberOfStudents  { get; set; }
}

Đã thêm bên dưới vào DbContextlớp học của tôi

public DbSet<School> SP_Schools { get; set; }

Để thực hiện thủ tục đã lưu trữ:

var MySchools = _db.SP_Schools.FromSqlRaw("GetSchools @schoolId, @page, @size ",
              new SqlParameter("schoolId", schoolId),
              new SqlParameter("page", page),
              new SqlParameter("size", size)))
.IgnoreQueryFilters();

Tôi biết đó là một câu hỏi cũ, nhưng có thể nó giúp ai đó gọi các thủ tục được lưu trữ mà không cần thêm DTO dưới dạng DbSets.

https://stackoverflow.com/a/62058345/3300944

Giải pháp này chủ yếu dựa vào giải pháp từ @pius. Tôi muốn thêm tùy chọn hỗ trợ các tham số truy vấn để giúp giảm thiểu việc chèn SQL và tôi cũng muốn đặt nó thành một tiện ích mở rộng của DbContext DatabaseFacade cho Entity Framework Core để làm cho nó tích hợp hơn một chút.

Đầu tiên, hãy tạo một lớp mới với phần mở rộng:

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Metadata;
using System;
using System.Collections.Generic;
using System.Data;
using System.Data.Common;
using System.Linq;
using System.Threading.Tasks;

namespace EF.Extend
{

    public static class ExecuteSqlExt
    {
        /// <summary>
        /// Execute raw SQL query with query parameters
        /// </summary>
        /// <typeparam name="T">the return type</typeparam>
        /// <param name="db">the database context database, usually _context.Database</param>
        /// <param name="query">the query string</param>
        /// <param name="map">the map to map the result to the object of type T</param>
        /// <param name="queryParameters">the collection of query parameters, if any</param>
        /// <returns></returns>
        public static List<T> ExecuteSqlRawExt<T, P>(this DatabaseFacade db, string query, Func<DbDataReader, T> map, IEnumerable<P> queryParameters = null)
        {
            using (var command = db.GetDbConnection().CreateCommand())
            {
                if((queryParameters?.Any() ?? false))
                    command.Parameters.AddRange(queryParameters.ToArray());

                command.CommandText = query;
                command.CommandType = CommandType.Text;

                db.OpenConnection();

                using (var result = command.ExecuteReader())
                {
                    var entities = new List<T>();

                    while (result.Read())
                    {
                        entities.Add(map(result));
                    }

                    return entities;
                }
            }
                
        }
    }

}

Lưu ý ở trên rằng "T" là loại cho kết quả trả về và "P" là loại tham số truy vấn của bạn sẽ thay đổi tùy theo nếu bạn đang sử dụng MySql, Sql, v.v.

Tiếp theo chúng tôi sẽ đưa ra một ví dụ. Tôi đang sử dụng khả năng MySql EF Core, vì vậy chúng tôi sẽ xem cách chúng tôi có thể sử dụng tiện ích mở rộng chung ở trên với triển khai MySql cụ thể hơn này:

//add your using statement for the extension at the top of your Controller
//with all your other using statements
using EF.Extend;

//then your your Controller looks something like this
namespace Car.Api.Controllers
{

    //Define a quick Car class for the custom return type
    //you would want to put this in it's own class file probably
    public class Car
    {
        public string Make { get; set; }
        public string Model { get; set; }
        public string DisplayTitle { get; set; }
    }

    [ApiController]
    public class CarController : ControllerBase
    {
        private readonly ILogger<CarController> _logger;
        //this would be your Entity Framework Core context
        private readonly CarContext _context;

        public CarController(ILogger<CarController> logger, CarContext context)
        {
            _logger = logger;
            _context = context;
        }

        //... more stuff here ...

       /// <summary>
       /// Get car example
       /// </summary>
       [HttpGet]
       public IEnumerable<Car> Get()
       {
           //instantiate three query parameters to pass with the query
           //note the MySqlParameter type is because I'm using MySql
           MySqlParameter p1 = new MySqlParameter
           {
               ParameterName = "id1",
               Value = "25"
           };

           MySqlParameter p2 = new MySqlParameter
           {
               ParameterName = "id2",
               Value = "26"
           };

           MySqlParameter p3 = new MySqlParameter
           {
               ParameterName = "id3",
               Value = "27"
           };

           //add the 3 query parameters to an IEnumerable compatible list object
           List<MySqlParameter> queryParameters = new List<MySqlParameter>() { p1, p2, p3 };

           //note the extension is now easily accessed off the _context.Database object
           //also note for ExecuteSqlRawExt<Car, MySqlParameter>
           //Car is my return type "T"
           //MySqlParameter is the specific DbParameter type MySqlParameter type "P"
           List<Car> result = _context.Database.ExecuteSqlRawExt<Car, MySqlParameter>(
        "SELECT Car.Make, Car.Model, CONCAT_WS('', Car.Make, ' ', Car.Model) As DisplayTitle FROM Car WHERE Car.Id IN(@id1, @id2, @id3)",
        x => new Car { Make = (string)x[0], Model = (string)x[1], DisplayTitle = (string)x[2] }, 
        queryParameters);

           return result;
       }
    }
}

Truy vấn sẽ trả về các hàng như:
"Ford", "Explorer", "Ford Explorer"
"Tesla", "Model X", "Tesla Model X"

Tiêu đề hiển thị không được xác định là một cột cơ sở dữ liệu, vì vậy nó sẽ không phải là một phần của mô hình Xe hơi EF theo mặc định. Tôi thích cách tiếp cận này như một trong nhiều giải pháp khả thi. Các câu trả lời khác trên trang này đề cập đến các cách khác để giải quyết vấn đề này với trình trang trí [NotMapped], tùy thuộc vào trường hợp sử dụng của bạn có thể là cách tiếp cận phù hợp hơn.

Lưu ý rằng mã trong ví dụ này rõ ràng là dài dòng hơn mức cần thiết, nhưng tôi nghĩ rằng nó làm cho ví dụ rõ ràng hơn.

Với Entity Framework 6, bạn có thể thực thi một cái gì đó như dưới đây

Tạo lớp phương thức dưới dạng

Public class User
{
        public int Id { get; set; }
        public string fname { get; set; }
        public string lname { get; set; }
        public string username { get; set; }
}

Thực hiện lệnh Raw DQL SQl như sau:

var userList = datacontext.Database.SqlQuery<User>(@"SELECT u.Id ,fname , lname ,username FROM dbo.Users").ToList<User>();