https://github.com/Giorgi/EFCore.Visualizer

Entity Framework Core queries debugger visualizer.
https://github.com/Giorgi/EFCore.Visualizer

debugger-visualizer efcore postgersql query-plan sql-server visual-studio

Last synced: 3 months ago
JSON representation

Entity Framework Core queries debugger visualizer.

• Host: GitHub
• URL: https://github.com/Giorgi/EFCore.Visualizer
• Owner: Giorgi
• License: gpl-3.0
• Created: 2024-01-23T20:06:45.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-03-27T21:12:43.000Z (7 months ago)
• Last Synced: 2024-06-12T00:12:39.783Z (5 months ago)
• Topics: debugger-visualizer, efcore, postgersql, query-plan, sql-server, visual-studio
• Language: C#
• Homepage: https://marketplace.visualstudio.com/items?itemName=GiorgiDalakishvili.EFCoreVisualizer
• Size: 1.7 MB
• Stars: 392
• Watchers: 7
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![EFCore.Visualizer](doc/IconMedium.png "EFCore.Visualizer")

# Entity Framework Core Query Plan Visualizer

View Entity Framework Core query plan directly inside Visual Studio.

[![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/GiorgiDalakishvili.EFCoreVisualizer?style=for-the-badge&logo=visualstudio&label=Download%20Now&color=purple)](https://marketplace.visualstudio.com/items?itemName=GiorgiDalakishvili.EFCoreVisualizer)

[![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/GiorgiDalakishvili.EFCoreVisualizer?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=GiorgiDalakishvili.EFCoreVisualizer)

[![Visual Studio Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/GiorgiDalakishvili.EFCoreVisualizer?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=GiorgiDalakishvili.EFCoreVisualizer&ssr=false#review-details)

## Introduction

With Entity Framework Core query plan debugger visualizer, you can view the query plan of your queries directly inside Visual Studio. Currently, the visualizer supports SQL Server and PostgreSQL.

> [!IMPORTANT] 

> The visualizer requires **Visual Studio Version 17.9.0 ([Released on February 13th](https://devblogs.microsoft.com/visualstudio/visual-studio-2022-17-9-now-available/)) or newer** and supports **EF Core 7 or newer**.

## Usage

After installing the [extension from the marketplace](https://marketplace.visualstudio.com/items?itemName=GiorgiDalakishvili.EFCoreVisualizer), a new debugger visualizer will be added to Visual Studio. When debugging, hover over your queries and there will be an option to view the query plan:

![VariableVisualizer](doc/VariableVisualizer.png)

Click on 'Query Plan Visualizer' and the query plan will be displayed for your query.

### SQL Server:

![Sql Server Plan](doc/SqlPlan1.png)

![Sql Server Plan](doc/SqlPlan2.png)

### PostgreSQL:

![PostgreSQL Plan](doc/PostgreSQLPlan2.png)

![PostgreSQL Plan](doc/PostgreSQLPlan1.png)

## Known Issues:

 - If query plan extraction takes more than 5 seconds, you will get [Evaluation timed out error](https://github.com/Giorgi/EFCore.Visualizer/issues/25)

 - If your project uses Application Insights, you might get [Cannot evaluate expression since the function evaluation requires all threads to run.](https://github.com/Giorgi/EFCore.Visualizer/issues/28) when viewing query plan. **Workaround** - disable Application Insights when running your project with a debugger attached.

## Credits

This extension uses [pev2](https://github.com/dalibo/pev2/) and [html-query-plan](https://github.com/JustinPealing/html-query-plan) to display query plans.