giorgi/linqpad.queryplanvisualizer

SQL Server and PostgreSQL query execution plan visualizer for LINQPad

LINQPad.QueryPlanVisualizer

Visualize Entity Framework and Linq to SQL queries in LINQPad. For Visual Studio extension see EFCore.Visualizer

Entity Framework Community Standup Live Show

SQL Server and PostgreSQL query execution plan visualizer for LINQPad

Features

• View query execution plan inside LINQPad
• View missing indexes for query
• Share plan to https://www.brentozar.com/pastetheplan/ or https://explain.dalibo.com/
• Create missing indexes directly from LINQPad
• Open plan in SQL Server Management Studio or another default app
• Save plan to disk

Supported databases: Sql Server and PostgreSQL.

Supported ORMs: Entity Framework Core 5 and LINQ to SQL

Getting Started

If you use LINQPad 6 or newer, you must use version 2.X of this library. For LINQPad 5, you must use version 1.X

Version 2.1 and newer uses Microsoft Edge WebView2 to display the query plan. This requires either WebView2 Runtime to be installed or a recent version of Edge Canary. To download WebView2 Runtime visit Microsoft Edge WebView2 Download Page.

Install from NuGet

If you have a Developer or higher edition of LINQPad, you can use the LINQPadQueryPlanVisualizer package from NuGet to add the visualizer to your queries.

Install as plugin

To install the visualizer as a LINQPad plugin, download the latest release and drop the visualizer dll directly inside LINQPad's plugins folder (by default found at My Documents\LINQPad Plugins\NetCore3 for LINQPad 6 and My Documents\LINQPad Plugins\Framework 4.6 for LINQPad 5). The plugin will be automatically available in all your queries.

Viewing query plan

To view query plan or missing indexes, call static QueryPlanVisualizer.DumpPlan(query) method or call DumpPlan extension method on an IQueryable instance. You will also need to add ExecutionPlanVisualizer to the namespaces list (click F4 to open the dialog). If you want to dump query result as well, pass true as a second parameter.

Query execution plan for Sql Server:

Query execution plan for PostgreSQL:

Viewing missing indexes

For SQL Server, the query plan can also return information about missing indexes in QueryPlan/MissingIndexes/MissingIndexGroup element. If missing indexes are present in the plan the visualizer will show a second tab with the missing index details and a button to create the index.

Missing index:

What Others Are Saying

linqpad.queryplanvisualizer's Issues

DumpPlan returns void

Firstly, thank you for this awesome LINQPad plugin!

I have a small nitpick, in that the DumpPlan extension method on IQueryable doesn't return the IQueryable, so one can't use it in Expression mode for example, unlike LINQPad's built in Dump methods.

Example:

TableName.Where(row => row.SomeValue > 1234).DumpPlan()

gives an error

CS0030 Cannot convert type 'void' to 'object'

No scrollbars

I immediately tried it on a large query and the plan is too big to fit even using "Full Screen Results", and there are no scrollbars to allow me to see the rest of the plan.

Cost displays percentages over 100

I ran the statement SettingTypes.Take(20).DumpPlan(); and received the following query plan. SSMS displays the cost of the index scan as 100%, but LINQPad displays 119%.

wrong_percentage.txt

QueryPlan har invalid child element 'TraceFlags'

Cannot load WebView2 assembly

Hello,

I have an issue using the plugin.
It says it cannot load the WebView2 assembly.

System info:
Edition Windows 10 Pro
Version 21H1
Installed on ‎26/‎08/‎2021
OS build 19043.1237
Experience Windows Feature Experience Pack 120.2212.3530.0

In LINQPad the option to use Edge's Chromium engine to render results is checked.

Any idea?

Thank you.

Can the README explain a bit better how to add it via nuget?

I tried adding it to a specific query (via F4) but that seems to be the wrong thing - how do I install it properly via nuget?

xmlschemavalidationexception

Hello,
First of all, I would like to thank you for this great tool.
I have been trying to use but encountered this exception.

I do get results so the query is fine.
I get this exception for any query wrote. So i am posting just a simple one.

I searched about this exception but no success.
thanks!

v1.1 doesn't like NoLock

With the previous build this worked:
Call SomeQuery.NoLock(Function(q)q.DumpPlan)

where NoLock is a MyExtension:

    public static void NoLock<T>(this IQueryable<T> query, Action<IQueryable<T>> expr)
    {
        using (var txn = new System.Transactions.TransactionScope(TransactionScopeOption.RequiresNew,
            new TransactionOptions
            {
                IsolationLevel = System.Transactions.IsolationLevel.ReadUncommitted
            }))
        {
            expr(query);
        }
    }

Now this fails with an InvalidOperationException in the visualizer: https://onedrive.live.com/redir?resid=BED13F936EB1464C!105729&authkey=!AEQYbi5NFBcMfD0&v=3&ithint=photo%2cpng

(This is after adding EF, per the workaround mentioned in #10 .)

Use WebView2 to show Postgres query plan in LINQPad

Use WebView2 when LINQPad adds support: https://forum.linqpad.net/discussion/2383/experimental-support-for-chromium-engine#latest

Getting 'Object reference not set to an instance of an object.' exception

I have a compiled context doing a simple query:

Profiles.Where( p => p.Client.cName == "AnnArbor" ).DumpPlan();

And it throws the exception. Not much information in the exception. Let me know what other information I can provide to help.

Trace:

at ExecutionPlanVisualizer.QueryPlanVisualizer.DumpPlan[T](IQueryable`1 queryable, Boolean dumpData)
at UserQuery
at System.Threading.ThreadHelper.ThreadStart_Context(Object state)
at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx)
at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state, Boolean preserveSyncCtx)
at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state)
at System.Threading.ThreadHelper.ThreadStart()

SQL instances without SHOWPLAN permission granted cause exception to be passed.

In SSMS you will receive "SHOWPLAN permission denied in database 'Database_Name'"
Perhaps just display this in the Results tab and not leave a developer wondering what happened?

Currently does not display "Seek Predicates" at all

When you view this query plan in SMSS you see "Seek Predicates" actually explaining what is being found in the index scans. Currently, this information is not displayed by QPV.

The information seems to be stored in the <SeekPredicates> and <Predicate> tags.

Not showing Seek Predicates.zip

Is the visual (graphic) output only available for SQL Server, not PostgreSQL?

Hi, thanks for this great plugin!

I just installed the package and noticed that when using PostgreSQL with LinqPad, the query execution plan output shows text instead of graphic. Then I noticed on your demo screenshots the PostgreSQL example seems to show the same thing. So I assume the nice visual graphic only works with SQL Server, correct?

Also for "missing index", will the plugin simply show the "missing index" tab if it finds them, and if the tab is not shown, we can assume there is no missing index?

XmlSchemaValidationException when using a `GroupBy`

 TimeEntries.Where(te => te.UserId == "43f25e47-3198-4f04-b4cc-691a29e2f939")
		 .SelectMany(te => te._WorkItemTags.Select(t => new { TimeEntry = te, Tag = t }))
		 .GroupBy(x => x.Tag.WorkItemId)
		 .DumpPlan(true)

EF 5 is not supported

Hi Giorgi,

I am escalating this to an issue of its own, rather than a comment to #4. Not sure you can solve this, as there is no interceptor for the DB commands in EF 5. Having said that, can we do without it, utilizing ToTraceString() for ObjectQuery/ToString() for DbQuery?

Attached is a DB-first DbContext EF 5 project/solution on top of AdventureWorks

DALForLinqPadVisualizerEF5.zip

Thanks, Boris

mysql support

Make it compatible with LINQPad 6 (.NET Core version)

Right now while running in LINQPad 6 I'm getting:
FileNotFoundException: Could not load file or assembly 'LINQPad, Version=1.0.0.0, Culture=neutral, PublicKeyToken=21353812cd2a2db5'. The system cannot find the file specified.

Multiple requests for query plans should provide multiple visualizers

Connect to a Master database and run this query:

Tables.DumpPlan
'Util.ReadLine
Traces.DumpPlan

You only see the second plan, even if you uncomment the pause (because the plans are not displayed at all until the query is complete).

Whether this is a feature request or a bug depends on what was the original intention :-)

DumpPlan Hangup LINQPad when the query is the first query and C# Expression is used.

tested with 779cbda, LINQPad 5.05.02(Any CPU)

v1.1 requires EF

I allowed NuGet to update to the latest version and my query now fails with "Could not load file or assembly 'EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089' or one of its dependencies. The system cannot find the file specified."

AFAIK I haven't dealt with EF at all.

Query plan html transformation failing: "The 'MaxQueryMemory' attribute is not declared."

SQL Server 2014 SP2 added the MaxQueryMemory XML attribute (https://support.microsoft.com/en-us/kb/3170112), but the showplanxml.xsd embedded in the project does not contain a definition for it.

The generated query plan XML fails XML validation (inside ExecutionPlanVisualizer.QueryPlanProcessor.ConvertPlanToHtml), before the query plan HTML can be generated.

Query Plan Output tab does not respect windows scaling

Hey,

not sure how much can be done about this, but it'd be a great QOL improvement.

I have a 3200 x 1800 resolution screen and have windows scaling set to 175%. The query plan html output does not seem to respect that setting and is tiny. I can zoom in via ctrl + mouse wheel, but the zoom setting isn't saved, so as soon as a new query plan tab is created I have to zoom in again.

There is another problem with zooming in - it cuts off the bottom of the tooltip.

Again, not high priority by any means, but it would make it more usable.

Thank you for the great plugin.

Raw sql support

It would be nice to be able to have query plan for raw sql too
(for postgres at least ;) )

Query Execution Plan Not Showing in v5.22.02

I put the DLL in the folder but I am not seeing the pane. Do I need to have the premium version?