Add a PMC command that will list all DbContext types

[Ponant]

I have 2 dbcontext and Get-DbContext complains that I need to provide one whereas the docs says that it will list the Lists available DbContext types.
it is a bit astonishing that this error occurs whereas one could use the CLI tooling which works with
dotnet ef dbcontext list

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: 22803277-a2a7-0adf-acfc-35ed8e4238c8
• Version Independent ID: 19869482-5737-adff-3f7f-60b4217b977d
• Content: EF Core tools reference (Package Manager Console) - EF Core
• Content Source: entity-framework/core/miscellaneous/cli/powershell.md
• Product: entity-framework
• GitHub Login: @bricelam
• Microsoft Alias: bricelam

[ajcvickers]

Moved to product repo since this seems to be a bug.

[bricelam]

Get-DbContext is the equivalent of dotnet ef dbcontext info, not dbcontext list.

[bricelam]

Huh, the docs are wrong...

[ajcvickers]

Submitted docs PR: dotnet/EntityFramework.Docs#1387

@Ponant What was your reason for wanting to list the DbContexts from the package manager console? (Asking to determine whether or not it's worth leaving this open to track doing it.)

[Ponant]

Hi @ajcvickers , I was using it as I use VS so that saves me having a console window opened.
In any case, I would highly recommend to put a sentence or two saying that the cli tools are more complete, as it seems to be the case. Until now I thought PMC would be equivalent to the cli tool.

[ajcvickers]

@Ponant Yes, but why did you want to list the contexts in the first place?

[bricelam]

Note, tab-expansion works for the -Context parameters in PMC.

[Ponant]

@ajcvickers because I wanted to list the contexts instead of looking up the file names. Yes tab-expansion works too but there is a time lag and it does not list all dbcontexts and it does not always auto-complete...

[ajcvickers]

@Ponant Thanks! Putting this on the backlog.

[ErikEJ]

@bricelam Considering this - what would the command name be? Get-DbContexts ??

[bricelam]

In hindsight, Get-DbContext should have been named Get-DbContextInfo, and this one should be named Get-DbContext...

List-DbContext seems OK for now. As usual, we'll discuss the actual name ad nauseam in a design meeting.

[ErikEJ]

I will give it a shot

[ErikEJ]

How about a breaking change?

function Get-DbContext
{
    [CmdletBinding(PositionalBinding = $false)]
    param([string] $Context, [string] $Project, [string] $StartupProject)

    $dteProject = GetProject $Project
    $dteStartupProject = GetStartupProject $StartupProject $dteProject

    if ($Context)
    {
       $params = 'dbcontext', 'info', '--json'
       $params += GetParams $Context
    }
    else
    {
       $params = 'dbcontext', 'list', '--json'
    }

    # NB: -join is here to support ConvertFrom-Json on PowerShell 3.0
    return (EF $dteProject $dteStartupProject $params) -join "`n" | ConvertFrom-Json
}

[bricelam]

👍 Definitely worth discussing

[ErikEJ]

I will await the discussion outcome

[bricelam]

You don't have to; we can merge it however you send the PR. After discussing, we're happy to do the rename/combine/split ourselves.

[ErikEJ]

OK, I will investigate how I can get it tested (manually)

[ErikEJ]

@bricelam Any hints on how to get this tested?

[ErikEJ]

Managed to get it tested - does this make sense or should the output be modified?

PM> Get-DbContext

fullName                                                      safeName          name              assemblyQualifiedName                                                                    
--------                                                      --------          ----              ---------------------                                                                    
Sws.ConfigurationProvider.Persistence.Azure.AzureDbContext    AzureDbContext    AzureDbContext    Sws.ConfigurationProvider.Persistence.Azure.AzureDbContext, Sws.ConfigurationProvider....
Sws.ConfigurationProvider.Persistence.Azure.AzureOtherContext AzureOtherContext AzureOtherContext Sws.ConfigurationProvider.Persistence.Azure.AzureOtherContext, Sws.ConfigurationProvid...


PM> Get-DbContext  -Context AzureDbContext
Microsoft.EntityFrameworkCore.Infrastructure[10403]
      Entity Framework Core 2.2.4-servicing-10062 initialized 'AzureDbContext' using provider 'Microsoft.EntityFrameworkCore.SqlServer' with options: None

providerName                            databaseName dataSource             options
------------                            ------------ ----------             -------
Microsoft.EntityFrameworkCore.SqlServer AzureData    (localdb)\MSSQLLocalDB None   

[bricelam]

I think we can use a formatting file to make it display prettier... But I've never done it.

[bricelam]

By default, I think we should just display safeName (but still let let scripts access the other properties)

[ajcvickers]

Merged, but we may want to discuss in a design meeting.