Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Giorgi/EntityFramework.Exceptions
Handle database errors easily when working with Entity Framework Core. Supports SQLServer, PostgreSQL, SQLite, Oracle and MySql.
https://github.com/Giorgi/EntityFramework.Exceptions
database-exceptions dotnet-core entity-framework entity-framework-core entityframework mysql netcore2 netcore3 odp-net oracle orm postgresql sql-server sqlite sqlite3
Last synced: about 2 months ago
JSON representation
Handle database errors easily when working with Entity Framework Core. Supports SQLServer, PostgreSQL, SQLite, Oracle and MySql.
- Host: GitHub
- URL: https://github.com/Giorgi/EntityFramework.Exceptions
- Owner: Giorgi
- License: other
- Created: 2018-11-27T17:39:35.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-22T20:30:43.000Z (6 months ago)
- Last Synced: 2024-05-01T21:19:24.319Z (5 months ago)
- Topics: database-exceptions, dotnet-core, entity-framework, entity-framework-core, entityframework, mysql, netcore2, netcore3, odp-net, oracle, orm, postgresql, sql-server, sqlite, sqlite3
- Language: C#
- Homepage: https://giorgi.dev/entity-framework/introducing-entityframework-exceptions/
- Size: 221 KB
- Stars: 1,139
- Watchers: 16
- Forks: 63
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: License.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-dotnet-core - EntityFramework.Exceptions - 当您的SQL查询违反SqlServer，MySql或PostgreSQL中的数据库约束时，请对EntityFrameworkCore使用类型化的异常处理。 (框架, 库和工具 / 对象关系映射ORM)
- fucking-awesome-dotnet-core - EntityFramework.Exceptions - Use typed Exceptions for EntityFrameworkCore when your SQL query violates database constraints in SqlServer, MySql, or PostgreSQL. (Frameworks, Libraries and Tools / ORM)
- awesome-dotnet-core - EntityFramework.Exceptions - Use typed Exceptions for EntityFrameworkCore when your SQL query violates database constraints in SqlServer, MySql, or PostgreSQL. (Frameworks, Libraries and Tools / ORM)
README
# EntityFramework.Exceptions
Handle database errors easily when working with Entity Framework Core. Supports SQLServer, PostgreSQL, SQLite, Oracle and MySql
[](License.md)
[](https://dotnet.microsoft.com/en-us/)
[](https://ci.appveyor.com/project/Giorgi/entityframework-exceptions)
[](https://ci.appveyor.com/project/Giorgi/entityframework-exceptions/build/tests)
[](https://coveralls.io/github/Giorgi/EntityFramework.Exceptions)
[](https://ko-fi.com/U6U81LHU8)
[](https://sonarcloud.io/dashboard?id=EntityFramework.Exceptions)
[](https://sonarcloud.io/dashboard?id=EntityFramework.Exceptions)
[](https://sonarcloud.io/dashboard?id=EntityFramework.Exceptions)
[](https://sonarcloud.io/dashboard?id=EntityFramework.Exceptions)
[](https://sonarcloud.io/dashboard?id=EntityFramework.Exceptions)
[](https://sonarcloud.io/dashboard?id=EntityFramework.Exceptions)
[](https://buildstats.info/AppVeyor/chart/Giorgi/EntityFramework-Exceptions?branch=main)
[](https://www.nuget.org/packages/EntityFrameworkCore.Exceptions.SqlServer/)
[](https://www.nuget.org/packages/EntityFrameworkCore.Exceptions.PostgreSQL/)
[](https://www.nuget.org/packages/EntityFrameworkCore.Exceptions.MySQL/)
[](https://www.nuget.org/packages/EntityFrameworkCore.Exceptions.MySQL.Pomelo/)
[](https://www.nuget.org/packages/EntityFrameworkCore.Exceptions.Sqlite/)
[](https://www.nuget.org/packages/EntityFrameworkCore.Exceptions.Oracle/)
### Entity Framework Community Standup Live Show
[](https://www.youtube.com/watch?v=aUl5QfswNU4)
### What does EntityFramework.Exceptions do?
When using Entity Framework Core for data access all database exceptions are wrapped in `DbUpdateException`. If you need to find
whether the exception was caused by a unique constraint, value being too long or value missing for a required column you need to dig into
the concrete `DbException` subclass instance and check the error code to determine the exact cause.
EntityFramework.Exceptions simplifies this by handling all the database specific details and throwing different exceptions. All you have
to do is to configure `DbContext` by calling `UseExceptionProcessor` and handle the exception(s) you need, such as `UniqueConstraintException`,
`CannotInsertNullException`, `MaxLengthExceededException`, `NumericOverflowException`, or `ReferenceConstraintException`.
In case of `UniqueConstraintException` and `ReferenceConstraintException` you can get the name of the associated constraint with **`ConstraintName`** property. The **`ConstraintProperties`** will contain the properties that are part of the constraint.
> [!WARNING]
> `ConstraintName` and `ConstraintProperties` will be populated only if the index is defined in the Entity Framework Model. These properties will not be populated if the index exists in the database but isn't part of the model or if the index is added with [MigrationBuilder.Sql](https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.migrations.migrationbuilder.sql?view=efcore-8.0) method.
> [!WARNING]
> `ConstraintName` and `ConstraintProperties` will not be populated when using SQLite.
All these exceptions inherit from `DbUpdateException` for backwards compatibility.
### How do I get started?
First, install the package corresponding to your database:
```
dotnet add package EntityFrameworkCore.Exceptions.SqlServer
```
```
dotnet add package EntityFrameworkCore.Exceptions.MySql
```
```
dotnet add package EntityFrameworkCore.Exceptions.MySql.Pomelo
```
```
dotnet add package EntityFrameworkCore.Exceptions.PostgreSQL
```
```
dotnet add package EntityFrameworkCore.Exceptions.Sqlite
```
```
dotnet add package EntityFrameworkCore.Exceptions.Oracle
```
Next, in your DbContext `OnConfiguring` method call `UseExceptionProcessor` extension method:
```csharp
class DemoContext : DbContext
{
public DbSet Products { get; set; }
public DbSet ProductSale { get; set; }
protected override void OnModelCreating(ModelBuilder builder)
{
builder.Entity().HasIndex(u => u.Name).IsUnique();
}
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
{
optionsBuilder.UseExceptionProcessor();
}
}
```
You will now start getting different exception for different database error. For example, when a unique constraints fails you will get `UniqueConstraintException` exception:
```csharp
using (var demoContext = new DemoContext())
{
demoContext.Products.Add(new Product
{
Name = "demo",
Price = 10
});
demoContext.Products.Add(new Product
{
Name = "demo",
Price = 100
});
try
{
demoContext.SaveChanges();
}
catch (UniqueConstraintException e)
{
//Handle exception here
Console.WriteLine($"Unique constraint {e.ConstraintName} violated. Duplicate value for {e.ConstraintProperties[0]}");
}
}
```
### Usage with DbContext pooling
Instead of calling `UseExceptionProcessor` in the `OnConfiguring` method, add it where you add your `DbContextPool`:
```csharp
// Replace UseNpgsql with the sql flavor you're using
builder.Services.AddDbContextPool(options => options
.UseNpgsql(config.GetConnectionString("DemoConnection"))
.UseExceptionProcessor());
```