Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lordmike/mbw.ef.expressionvalidator
Extensions to Microsoft.EntityFrameworkCore that can translate queries in multiple databases, to validate them
https://github.com/lordmike/mbw.ef.expressionvalidator
ef-core entity-framework-core mysql sqlite sqlserver
Last synced: about 11 hours ago
JSON representation
Extensions to Microsoft.EntityFrameworkCore that can translate queries in multiple databases, to validate them
- Host: GitHub
- URL: https://github.com/lordmike/mbw.ef.expressionvalidator
- Owner: LordMike
- Created: 2021-09-26T13:51:37.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T21:11:34.000Z (about 1 year ago)
- Last Synced: 2023-09-20T00:13:17.058Z (about 1 year ago)
- Topics: ef-core, entity-framework-core, mysql, sqlite, sqlserver
- Language: C#
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MBW.EF.ExpressionValidator [](https://github.com/LordMike/MBW.EF.ExpressionValidator/actions/workflows/dotnet.yml) [](https://www.nuget.org/packages/MBW.EF.ExpressionValidator)
This project aims to help developers avoid a pesky issue with EntityFramework: untranslateable queries. Whenever a developer uses the In-Memory database from Microsoft for local development, or any other provider for that matter, there is a risk that the query they're making can translate correctly to SQL for the current provider, but won't be able to for other providers. A good example is exactly with the in memory database, as it purely exists in memory and runs .NET code to produce results.
Using this project, it is possible to validate that all queries made can succesfully translate into queries for other databases.
Note: This project is not intended to be used in any other environment that testing or local development.
# Features
* Plugins to translate queries to Mysql, Sqlite and Sql Server
* Easy to use API to plug in validation to a database context
# Nuget packages
| Name | Nuget | Note |
|---|---|---|
| MBW.EF.ExpressionValidator | [](https://www.nuget.org/packages/MBW.EF.ExpressionValidator/) | Core functionality |
| MBW.EF.ExpressionValidator.Sqlite | [](https://www.nuget.org/packages/MBW.EF.ExpressionValidator.Sqlite/) | Addon using `Microsoft.EntityFrameworkCore.Sqlite` |
| MBW.EF.ExpressionValidator.SqlServer | [](https://www.nuget.org/packages/MBW.EF.ExpressionValidator.SqlServer/) | Addon using `Microsoft.EntityFrameworkCore.SqlServer` |
| MBW.EF.ExpressionValidator.PomeloMysql | [](https://www.nuget.org/packages/MBW.EF.ExpressionValidator.PomeloMysql/) | Addon using `Pomelo.EntityFrameworkCore.MySql` |
# Usage example
This example is for a common use case: Using EntityFramework in an Asp.Net website.
Reference a package from above, depending on your target database, and then add it to your in-memory database context builder:
```csharp
public class Startup
{
public Startup(IConfiguration configuration, IHostEnvironment environment)
{
Configuration = configuration;
Environment = environment;
}
public IConfiguration Configuration { get; }
public IHostEnvironment Environment { get; }
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews();
// ... add other services
// Add our DatabaseContext to our DI system - this switches implementation based on our hosting environment
services.AddDbContext(builder =>
{
// Only add validation when using the inmemory database. This ensures we don't have any adverse effect when running production environments
if (Environment.IsDevelopment())
{
// In development, we want to use the in memory database with query validation
// This ensures that in staging and production, we will know that any query made in development will successfully translate to SQL
builder.UseInMemoryDatabase("LocalDatabase")
.AddMysqlExpressionValidation();
}
else
{
// When in any other environment, we want to use an actual MySql database
// Here, we will _not_ add validation
builder.UseMySql("Server=localhost", new MySqlServerVersion(new Version(8, 0, 25)));
}
});
}
}
```
Now - we can use our context like normal, but we'll know that all queries can translate to SQL.
```csharp
public class HomeController : Controller
{
private readonly DatabaseContext _context;
public HomeController(DatabaseContext context)
{
_context = context;
}
public IActionResult Index()
{
// A query like this can easily translate to SQL and will always work
_context.BlogPosts.Where(s => s.Id == 4).ToList();
// A query like this could work in the in memory database, but not in actual databases
// The expression validation will catch this, and throw an exception
// This ensures that during local testing, we will not end up with a query that won't work in Mysql
_context.BlogPosts.Where(s => s.Title.ToCharArray().Length == 2).ToList();
return View();
}
}
```