Skip to content

Provide Microsoft.AspNetCore.Diagnostics.EntityFramework package README #57540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions src/Middleware/Diagnostics.EntityFrameworkCore/src/PACKAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## About

`Microsoft.AspNetCore.Diagnostics.EntityFramework` provides an ASP.NET Core middleware for EF Core error pages, allowing detection and diagnosis of errors with EF Core migrations.

## Key Features

* Captures and displays detailed error information from Entity Framework Core database operations
* Helps developers diagnose and troubleshoot database-related issues in ASP.NET Core applications

## How to Use

To use `Microsoft.AspNetCore.Diagnostics.EntityFramework`, follow these steps:

### Installation

```shell
dotnet add package Microsoft.AspNetCore.Diagnostics.EntityFramework
```

### Configuration

To use the middleware, add it to the ASP.NET Core pipeline defined in your app's `Program.cs`:

```csharp
builder.Services.AddDatabaseDeveloperPageExceptionFilter();

var app = builder.build();

if (app.Environment.IsDevelopment())
{
app.UseDeveloperExceptionPage();
app.UseMigrationsEndPoint();
}
```

## Additional Documentation

For more information on using Entity Framework Core in ASP.NET Core applications, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/data/ef-rp/intro).

## Feedback & Contributing

`Microsoft.AspNetCore.Diagnostics.EntityFramework` is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).
Loading